Package liquibase.command.core
Class DiffCommandStep
- java.lang.Object
-
- liquibase.command.AbstractCommandStep
-
- liquibase.command.core.DiffCommandStep
-
- All Implemented Interfaces:
CommandStep
public class DiffCommandStep extends AbstractCommandStep
-
-
Field Summary
Fields Modifier and Type Field Description static String[]
COMMAND_NAME
static CommandResultDefinition<DiffResult>
DIFF_RESULT
static CommandArgumentDefinition<String>
FORMAT_ARG
static CommandArgumentDefinition<SnapshotControl>
REFERENCE_SNAPSHOT_CONTROL_ARG
static CommandArgumentDefinition<SnapshotListener>
SNAPSHOT_LISTENER_ARG
static CommandArgumentDefinition<SnapshotControl>
TARGET_SNAPSHOT_CONTROL_ARG
-
Fields inherited from class liquibase.command.AbstractCommandStep
coreBundle
-
Fields inherited from interface liquibase.command.CommandStep
ORDER_DEFAULT, ORDER_NOT_APPLICABLE
-
-
Constructor Summary
Constructors Constructor Description DiffCommandStep()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description void
adjustCommandDefinition(CommandDefinition commandDefinition)
Default implementation makes no changesDiffResult
createDiffResult(CommandResultsBuilder resultsBuilder)
protected DatabaseSnapshot
createReferenceSnapshot(CommandResultsBuilder resultsBuilder)
String[][]
defineCommandNames()
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)
List<Class<?>>
providedDependencies()
Returns a list of all the dependency Classes that this step providesList<Class<?>>
requiredDependencies()
Return 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, validate
-
-
-
-
Field Detail
-
COMMAND_NAME
public static final String[] COMMAND_NAME
-
SNAPSHOT_LISTENER_ARG
public static final CommandArgumentDefinition<SnapshotListener> SNAPSHOT_LISTENER_ARG
-
REFERENCE_SNAPSHOT_CONTROL_ARG
public static final CommandArgumentDefinition<SnapshotControl> REFERENCE_SNAPSHOT_CONTROL_ARG
-
TARGET_SNAPSHOT_CONTROL_ARG
public static final CommandArgumentDefinition<SnapshotControl> TARGET_SNAPSHOT_CONTROL_ARG
-
FORMAT_ARG
public static final CommandArgumentDefinition<String> FORMAT_ARG
-
DIFF_RESULT
public static final CommandResultDefinition<DiffResult> DIFF_RESULT
-
-
Method Detail
-
requiredDependencies
public List<Class<?>> 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
public List<Class<?>> 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
public String[][] 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
public void adjustCommandDefinition(CommandDefinition commandDefinition)
Description copied from class:AbstractCommandStep
Default implementation makes no changes- Specified by:
adjustCommandDefinition
in interfaceCommandStep
- Overrides:
adjustCommandDefinition
in classAbstractCommandStep
-
parseSnapshotTypes
public static Class<? extends DatabaseObject>[] parseSnapshotTypes(String... snapshotTypes)
-
run
public void run(CommandResultsBuilder resultsBuilder) throws Exception
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
-
-