public class DiffCommandStep extends AbstractCommandStep
Modifier and Type | Field and 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 |
coreBundle
ORDER_DEFAULT, ORDER_NOT_APPLICABLE
Constructor and Description |
---|
DiffCommandStep() |
Modifier and Type | Method and Description |
---|---|
void |
adjustCommandDefinition(CommandDefinition commandDefinition)
Default implementation makes no changes
|
DiffResult |
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 provides
|
List<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.
|
getOrder, validate
public static final String[] COMMAND_NAME
public static final CommandArgumentDefinition<SnapshotListener> SNAPSHOT_LISTENER_ARG
public static final CommandArgumentDefinition<SnapshotControl> REFERENCE_SNAPSHOT_CONTROL_ARG
public static final CommandArgumentDefinition<SnapshotControl> TARGET_SNAPSHOT_CONTROL_ARG
public static final CommandArgumentDefinition<String> FORMAT_ARG
public static final CommandResultDefinition<DiffResult> DIFF_RESULT
public List<Class<?>> requiredDependencies()
CommandStep
requiredDependencies
in interface CommandStep
requiredDependencies
in class AbstractCommandStep
public List<Class<?>> providedDependencies()
CommandStep
providedDependencies
in interface CommandStep
providedDependencies
in class AbstractCommandStep
public String[][] defineCommandNames()
CommandStep
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
public void adjustCommandDefinition(CommandDefinition commandDefinition)
AbstractCommandStep
adjustCommandDefinition
in interface CommandStep
adjustCommandDefinition
in class AbstractCommandStep
public static Class<? extends DatabaseObject>[] parseSnapshotTypes(String... snapshotTypes)
public void run(CommandResultsBuilder resultsBuilder) throws Exception
CommandStep
CommandScope.execute()
order.Exception
public DiffResult createDiffResult(CommandResultsBuilder resultsBuilder) throws DatabaseException, InvalidExampleException
protected DatabaseSnapshot getTargetSnapshot(CommandResultsBuilder resultsBuilder) throws DatabaseException, InvalidExampleException
protected DatabaseSnapshot createReferenceSnapshot(CommandResultsBuilder resultsBuilder) throws DatabaseException, InvalidExampleException
Copyright © 2023 Liquibase.org. All rights reserved.