Package liquibase.command.core
Class DiffCommandStep
java.lang.Object
liquibase.command.AbstractCommandStep
liquibase.command.core.DiffCommandStep
- All Implemented Interfaces:
CommandStep
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final String[]
static final CommandResultDefinition<DiffResult>
static final CommandArgumentDefinition<String>
static final CommandArgumentDefinition<SnapshotControl>
static final CommandArgumentDefinition<SnapshotListener>
static final CommandArgumentDefinition<SnapshotControl>
Fields inherited from class liquibase.command.AbstractCommandStep
coreBundle
Fields inherited from interface liquibase.command.CommandStep
ORDER_DEFAULT, ORDER_NOT_APPLICABLE
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
adjustCommandDefinition
(CommandDefinition commandDefinition) Default implementation makes no changescreateDiffResult
(CommandResultsBuilder resultsBuilder) protected DatabaseSnapshot
createReferenceSnapshot
(CommandResultsBuilder resultsBuilder) String[][]
Defines new command names For example, if it is part of `liquibase update`, this should return new String[][]{ new String[] {"update"}}.protected DatabaseSnapshot
getTargetSnapshot
(CommandResultsBuilder resultsBuilder) static Class<? extends DatabaseObject>[]
parseSnapshotTypes
(String... snapshotTypes) Returns a list of all the dependency Classes that this step providesReturn a list of configured Classes that this command requires to be passed as a dependency.void
run
(CommandResultsBuilder resultsBuilder) Performs the business logic.Methods inherited from class liquibase.command.AbstractCommandStep
getOrder, handleOutput, validate
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface liquibase.command.CommandStep
isInternal
-
Field Details
-
COMMAND_NAME
-
SNAPSHOT_LISTENER_ARG
-
REFERENCE_SNAPSHOT_CONTROL_ARG
-
TARGET_SNAPSHOT_CONTROL_ARG
-
FORMAT_ARG
-
DIFF_RESULT
-
-
Constructor Details
-
DiffCommandStep
public DiffCommandStep()
-
-
Method Details
-
requiredDependencies
Description copied from interface:CommandStep
Return a list of configured Classes that this command requires to be passed as a dependency.- Specified by:
requiredDependencies
in interfaceCommandStep
- Overrides:
requiredDependencies
in classAbstractCommandStep
- Returns:
- list with the required classes types
-
providedDependencies
Description copied from interface:CommandStep
Returns a list of all the dependency Classes that this step provides- Specified by:
providedDependencies
in interfaceCommandStep
- Overrides:
providedDependencies
in classAbstractCommandStep
- Returns:
- list with the provided classes types
-
defineCommandNames
Description copied from interface:CommandStep
Defines new command names For example, if it is part of `liquibase update`, this should return new String[][]{ new String[] {"update"}}. If it is a part of `liquibase example init`, this should return {"example", "init"}.This is used to determine the available command names.
This can return null if this step is not defining a new command but "cross-cutting" existing commands
-
adjustCommandDefinition
Description copied from class:AbstractCommandStep
Default implementation makes no changes- Specified by:
adjustCommandDefinition
in interfaceCommandStep
- Overrides:
adjustCommandDefinition
in classAbstractCommandStep
-
parseSnapshotTypes
-
run
Description copied from interface:CommandStep
Performs the business logic. This method should not be called directly. It is called by the overall pipeline logic in theCommandScope.execute()
order.- Throws:
Exception
-
createDiffResult
public DiffResult createDiffResult(CommandResultsBuilder resultsBuilder) throws DatabaseException, InvalidExampleException -
getTargetSnapshot
protected DatabaseSnapshot getTargetSnapshot(CommandResultsBuilder resultsBuilder) throws DatabaseException, InvalidExampleException -
createReferenceSnapshot
protected DatabaseSnapshot createReferenceSnapshot(CommandResultsBuilder resultsBuilder) throws DatabaseException, InvalidExampleException
-