Package liquibase.command.core.helpers
Class PreCompareCommandStep
- java.lang.Object
-
- liquibase.command.AbstractCommandStep
-
- liquibase.command.core.helpers.AbstractHelperCommandStep
-
- liquibase.command.core.helpers.PreCompareCommandStep
-
- All Implemented Interfaces:
CommandStep
public class PreCompareCommandStep extends AbstractHelperCommandStep
Prepares objects used by database comparison Commands like diff, diffChangelog, etc
-
-
Field Summary
Fields Modifier and Type Field Description protected static String[]
COMMAND_NAME
static CommandArgumentDefinition<CompareControl>
COMPARE_CONTROL_ARG
static CommandResultDefinition<CompareControl>
COMPARE_CONTROL_RESULT
static CommandArgumentDefinition<String>
DIFF_TYPES_ARG
static CommandArgumentDefinition<String>
EXCLUDE_OBJECTS_ARG
static CommandArgumentDefinition<String>
INCLUDE_OBJECTS_ARG
static CommandArgumentDefinition<ObjectChangeFilter>
OBJECT_CHANGE_FILTER_ARG
static CommandResultDefinition<ObjectChangeFilter>
OBJECT_CHANGE_FILTER_RESULT
static CommandArgumentDefinition<String>
OUTPUT_SCHEMAS_ARG
static CommandArgumentDefinition<String>
REFERENCE_SCHEMAS_ARG
static CommandArgumentDefinition<String>
SCHEMAS_ARG
static CommandArgumentDefinition<Class[]>
SNAPSHOT_TYPES_ARG
static CommandResultDefinition<Class[]>
SNAPSHOT_TYPES_RESULT
-
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 PreCompareCommandStep()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description String[][]
defineCommandNames()
Defines new command names For example, if it is part of `liquibase update`, this should return new String[][]{ new String[] {"update"}}.static void
logMdcProperties(String schemas, String outputSchemas, String referenceSchemas)
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.core.helpers.AbstractHelperCommandStep
adjustCommandDefinition
-
Methods inherited from class liquibase.command.AbstractCommandStep
getOrder, validate
-
-
-
-
Field Detail
-
COMMAND_NAME
protected static final String[] COMMAND_NAME
-
EXCLUDE_OBJECTS_ARG
public static final CommandArgumentDefinition<String> EXCLUDE_OBJECTS_ARG
-
INCLUDE_OBJECTS_ARG
public static final CommandArgumentDefinition<String> INCLUDE_OBJECTS_ARG
-
SCHEMAS_ARG
public static final CommandArgumentDefinition<String> SCHEMAS_ARG
-
DIFF_TYPES_ARG
public static final CommandArgumentDefinition<String> DIFF_TYPES_ARG
-
REFERENCE_SCHEMAS_ARG
public static final CommandArgumentDefinition<String> REFERENCE_SCHEMAS_ARG
-
OUTPUT_SCHEMAS_ARG
public static final CommandArgumentDefinition<String> OUTPUT_SCHEMAS_ARG
-
COMPARE_CONTROL_ARG
public static final CommandArgumentDefinition<CompareControl> COMPARE_CONTROL_ARG
-
SNAPSHOT_TYPES_ARG
public static final CommandArgumentDefinition<Class[]> SNAPSHOT_TYPES_ARG
-
OBJECT_CHANGE_FILTER_ARG
public static final CommandArgumentDefinition<ObjectChangeFilter> OBJECT_CHANGE_FILTER_ARG
-
COMPARE_CONTROL_RESULT
public static final CommandResultDefinition<CompareControl> COMPARE_CONTROL_RESULT
-
SNAPSHOT_TYPES_RESULT
public static final CommandResultDefinition<Class[]> SNAPSHOT_TYPES_RESULT
-
OBJECT_CHANGE_FILTER_RESULT
public static final CommandResultDefinition<ObjectChangeFilter> OBJECT_CHANGE_FILTER_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
-
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
-
-