Top Description Inners Fields Constructors Methods
liquibase.command.core

public abstract Class AbstractRollbackCommandStep

extends AbstractCommandStep
Class Inheritance
Known Direct Subclasses
liquibase.command.core.RollbackCommandStep, liquibase.command.core.RollbackCountCommandStep, liquibase.command.core.RollbackToDateCommandStep
Imports
liquibase.RuntimeEnvironment, .Scope, liquibase.change.core.RawSQLChange, liquibase.changelog.*, liquibase.changelog.filter.*, liquibase.changelog.visitor.ChangeExecListener, .ChangeSetVisitor, .DefaultChangeExecListener, .RollbackVisitor, liquibase.command.*, liquibase.command.core.helpers.DatabaseChangelogCommandStep, liquibase.database.Database, liquibase.exception.DatabaseException, .LiquibaseException, liquibase.executor.Executor, .ExecutorService, liquibase.lockservice.LockService, liquibase.logging.mdc.MdcKey, .MdcObject, .MdcValue, liquibase.logging.mdc.customobjects.ChangesetsRolledback, liquibase.report.RollbackReportParameters, liquibase.resource.Resource, liquibase.util.StreamUtil, .StringUtil, java.io.IOException, .InputStream, java.util.ArrayList, .Arrays, .List, .Set
AbstractRollbackCommandStep provides the common operations to all the rollback* commands.

Nested and Inner Type Summary

Modifier and TypeClass and Description
private static enum
AbstractRollbackCommandStep.RollbackMessageType

Field Summary

Modifier and TypeField and Description
public static final CommandArgumentDefinition<String>
ROLLBACK_SCRIPT_ARG

Inherited from liquibase.command.AbstractCommandStep:
coreBundle

Constructor Summary

AccessConstructor and Description
public
AbstractRollbackCommandStep()

Method Summary

Modifier and TypeMethod and Description
private static void
addChangelogFileToMdc(String changelogFile, DatabaseChangeLog databaseChangeLog)

public void
adjustCommandDefinition(CommandDefinition commandDefinition)

Overrides liquibase.command.AbstractCommandStep.adjustCommandDefinition.

Implements liquibase.command.CommandStep.adjustCommandDefinition.

Default implementation makes no changes

protected static RawSQLChange
buildRawSQLChange(String rollbackScriptContents)

private static List<ChangeSet>
determineRollbacks(Database database, ChangeLogIterator logIterator, ChangeLogParameters changeLogParameters)

protected void
doRollback(CommandResultsBuilder resultsBuilder, List<RanChangeSet> ranChangeSetList, ChangeSetFilter changeSetFilter)

protected void
doRollback(CommandResultsBuilder resultsBuilder, List<RanChangeSet> ranChangeSetList, ChangeSetFilter changeSetFilter, RollbackReportParameters rollbackReportParameters)

public static void
doRollback(Database database, String changelogFile, String rollbackScript, ChangeLogIterator logIterator, ChangeLogParameters changeLogParameters, DatabaseChangeLog databaseChangeLog, ChangeExecListener changeExecListener)

Actually perform the rollback operation.

public static void
doRollback(Database database, String changelogFile, String rollbackScript, ChangeLogIterator logIterator, ChangeLogParameters changeLogParameters, DatabaseChangeLog databaseChangeLog, ChangeExecListener changeExecListener, RollbackReportParameters rollbackReportParameters)

Actually perform the rollback operation.

private static void
executeRollbackScript(Database database, String rollbackScript, List<ChangeSet> changeSets, DatabaseChangeLog changelog, ChangeLogParameters changeLogParameters, ChangeExecListener changeExecListener)

private static void
handleRollbackException(String operationName, RollbackReportParameters rollbackReportParameters)

private static void
removeRunStatus(List<ChangeSet> changeSets, Database database)

public List<Class<?>>
requiredDependencies()

Overrides liquibase.command.AbstractCommandStep.requiredDependencies.

Implements liquibase.command.CommandStep.requiredDependencies.

Return a list of configured Classes that this command requires to be passed as a dependency.

private static void
sendRollbackMessages(List<ChangeSet> changeSets, DatabaseChangeLog databaseChangeLog, AbstractRollbackCommandStep.RollbackMessageType messageType, Database database, ChangeExecListener changeExecListener, Exception exception)

Inherited from liquibase.command.AbstractCommandStep:
getOrderprovidedDependenciesvalidate

Field Detail

ROLLBACK_SCRIPT_ARGback to summary
public static final CommandArgumentDefinition<String> ROLLBACK_SCRIPT_ARG

Constructor Detail

AbstractRollbackCommandStepback to summary
public AbstractRollbackCommandStep()

Method Detail

addChangelogFileToMdcback to summary
private static void addChangelogFileToMdc(String changelogFile, DatabaseChangeLog databaseChangeLog)
adjustCommandDefinitionback to summary
public void adjustCommandDefinition(CommandDefinition commandDefinition)

Overrides liquibase.command.AbstractCommandStep.adjustCommandDefinition.

Implements liquibase.command.CommandStep.adjustCommandDefinition.

Doc from liquibase.command.AbstractCommandStep.adjustCommandDefinition.

Default implementation makes no changes

Annotations
@Override
buildRawSQLChangeback to summary
protected static RawSQLChange buildRawSQLChange(String rollbackScriptContents)
determineRollbacksback to summary
private static List<ChangeSet> determineRollbacks(Database database, ChangeLogIterator logIterator, ChangeLogParameters changeLogParameters) throws LiquibaseException
doRollbackback to summary
protected void doRollback(CommandResultsBuilder resultsBuilder, List<RanChangeSet> ranChangeSetList, ChangeSetFilter changeSetFilter) throws Exception
doRollbackback to summary
protected void doRollback(CommandResultsBuilder resultsBuilder, List<RanChangeSet> ranChangeSetList, ChangeSetFilter changeSetFilter, RollbackReportParameters rollbackReportParameters) throws Exception
doRollbackback to summary
public static void doRollback(Database database, String changelogFile, String rollbackScript, ChangeLogIterator logIterator, ChangeLogParameters changeLogParameters, DatabaseChangeLog databaseChangeLog, ChangeExecListener changeExecListener) throws Exception

Actually perform the rollback operation. Determining which changesets to roll back is the responsibility of the logIterator.

doRollbackback to summary
public static void doRollback(Database database, String changelogFile, String rollbackScript, ChangeLogIterator logIterator, ChangeLogParameters changeLogParameters, DatabaseChangeLog databaseChangeLog, ChangeExecListener changeExecListener, RollbackReportParameters rollbackReportParameters) throws Exception

Actually perform the rollback operation. Determining which changesets to roll back is the responsibility of the logIterator.

executeRollbackScriptback to summary
private static void executeRollbackScript(Database database, String rollbackScript, List<ChangeSet> changeSets, DatabaseChangeLog changelog, ChangeLogParameters changeLogParameters, ChangeExecListener changeExecListener) throws LiquibaseException
handleRollbackExceptionback to summary
private static void handleRollbackException(String operationName, RollbackReportParameters rollbackReportParameters)
removeRunStatusback to summary
private static void removeRunStatus(List<ChangeSet> changeSets, Database database) throws LiquibaseException
requiredDependenciesback to summary
public List<Class<?>> requiredDependencies()

Overrides liquibase.command.AbstractCommandStep.requiredDependencies.

Implements liquibase.command.CommandStep.requiredDependencies.

Doc from liquibase.command.CommandStep.requiredDependencies.

Return a list of configured Classes that this command requires to be passed as a dependency.

Returns:List<Class<?>>

list with the required classes types

Annotations
@Override
sendRollbackMessagesback to summary
private static void sendRollbackMessages(List<ChangeSet> changeSets, DatabaseChangeLog databaseChangeLog, AbstractRollbackCommandStep.RollbackMessageType messageType, Database database, ChangeExecListener changeExecListener, Exception exception)
liquibase.command.core back to summary

private final Enum AbstractRollbackCommandStep.RollbackMessageType

extends Enum<AbstractRollbackCommandStep.RollbackMessageType>
Class Inheritance

Field Summary

Modifier and TypeField and Description
public static final AbstractRollbackCommandStep.RollbackMessageType
ROLLBACK_FAILED

public static final AbstractRollbackCommandStep.RollbackMessageType
ROLLED_BACK

public static final AbstractRollbackCommandStep.RollbackMessageType
WILL_ROLLBACK

Constructor Summary

AccessConstructor and Description
private
RollbackMessageType()

Method Summary

Modifier and TypeMethod and Description
public static AbstractRollbackCommandStep.RollbackMessageType
valueOf(String name)

public static AbstractRollbackCommandStep.RollbackMessageType[]
values()

Inherited from java.lang.Enum:
clonecompareTodescribeConstableequalsfinalizegetDeclaringClasshashCodenameordinaltoStringvalueOf

Field Detail

ROLLBACK_FAILEDback to summary
public static final AbstractRollbackCommandStep.RollbackMessageType ROLLBACK_FAILED
ROLLED_BACKback to summary
public static final AbstractRollbackCommandStep.RollbackMessageType ROLLED_BACK
WILL_ROLLBACKback to summary
public static final AbstractRollbackCommandStep.RollbackMessageType WILL_ROLLBACK

Constructor Detail

RollbackMessageTypeback to summary
private RollbackMessageType()

Method Detail

valueOfback to summary
public static AbstractRollbackCommandStep.RollbackMessageType valueOf(String name)
valuesback to summary
public static AbstractRollbackCommandStep.RollbackMessageType[] values()