liquibase.command.core

Class InternalDiffCommandStep

java.lang.Object

liquibase.command.AbstractCommandStep

liquibase.command.core.InternalDiffCommandStep

All Implemented Interfaces:

CommandStep

Direct Known Subclasses:

InternalDiffChangelogCommandStep

public class InternalDiffCommandStep
extends AbstractCommandStep

Field Summary

Fields

Modifier and Type	Field and Description
static String[]	COMMAND_NAME
static CommandArgumentDefinition<CompareControl>	COMPARE_CONTROL_ARG
static CommandArgumentDefinition<ObjectChangeFilter>	OBJECT_CHANGE_FILTER_ARG
static CommandArgumentDefinition<Boolean>	PRINT_RESULT
static CommandArgumentDefinition<Database>	REFERENCE_DATABASE_ARG
static CommandArgumentDefinition<SnapshotControl>	REFERENCE_SNAPSHOT_CONTROL_ARG
static CommandArgumentDefinition<SnapshotListener>	SNAPSHOT_LISTENER_ARG
static CommandArgumentDefinition<Class[]>	SNAPSHOT_TYPES_ARG
static CommandArgumentDefinition<Database>	TARGET_DATABASE_ARG
static CommandArgumentDefinition<SnapshotControl>	TARGET_SNAPSHOT_CONTROL_ARG

Fields inherited from interface liquibase.command.CommandStep

ORDER_DEFAULT, ORDER_NOT_APPLICABLE

Constructor Summary

Constructors

Constructor and Description
InternalDiffCommandStep()

Method Summary

Modifier and Type	Method and Description
void	adjustCommandDefinition(CommandDefinition commandDefinition) Default implementation makes no changes
DiffResult	createDiffResult(CommandScope commandScope)
protected DatabaseSnapshot	createReferenceSnapshot(CommandScope commandScope)
protected DatabaseSnapshot	createTargetSnapshot(CommandScope commandScope)
String[][]	defineCommandNames() Defines new command names For example, if it is part of `liquibase update`, this should return new String[][]{ new String[] {"update"}}.
static Class<? extends DatabaseObject>[]	parseSnapshotTypes(String... snapshotTypes)
void	run(CommandResultsBuilder resultsBuilder) Performs the business logic.

Methods inherited from class liquibase.command.AbstractCommandStep

getOrder, validate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

COMMAND_NAME

public static final String[] COMMAND_NAME

REFERENCE_DATABASE_ARG

public static final CommandArgumentDefinition<Database> REFERENCE_DATABASE_ARG

TARGET_DATABASE_ARG

public static final CommandArgumentDefinition<Database> TARGET_DATABASE_ARG

SNAPSHOT_TYPES_ARG

public static final CommandArgumentDefinition<Class[]> SNAPSHOT_TYPES_ARG

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

OBJECT_CHANGE_FILTER_ARG

public static final CommandArgumentDefinition<ObjectChangeFilter> OBJECT_CHANGE_FILTER_ARG

COMPARE_CONTROL_ARG

public static final CommandArgumentDefinition<CompareControl> COMPARE_CONTROL_ARG

PRINT_RESULT

public static final CommandArgumentDefinition<Boolean> PRINT_RESULT

Constructor Detail

InternalDiffCommandStep

public InternalDiffCommandStep()

Method Detail

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 interface CommandStep

Overrides:

adjustCommandDefinition in class AbstractCommandStep

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 the CommandStep.getOrder(CommandDefinition) order.

Throws:

Exception

createDiffResult

public DiffResult createDiffResult(CommandScope commandScope)
                            throws DatabaseException,
                                   InvalidExampleException

Throws:

DatabaseException

InvalidExampleException

createTargetSnapshot

protected DatabaseSnapshot createTargetSnapshot(CommandScope commandScope)
                                         throws DatabaseException,
                                                InvalidExampleException

Throws:

DatabaseException

InvalidExampleException

createReferenceSnapshot

protected DatabaseSnapshot createReferenceSnapshot(CommandScope commandScope)
                                            throws DatabaseException,
                                                   InvalidExampleException

Throws:

DatabaseException

InvalidExampleException