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 final String[]	COMMAND_NAME
static final CommandResultDefinition<DiffResult>	DIFF_RESULT
static final CommandArgumentDefinition<String>	FORMAT_ARG
static final CommandArgumentDefinition<SnapshotControl>	REFERENCE_SNAPSHOT_CONTROL_ARG
static final CommandArgumentDefinition<SnapshotListener>	SNAPSHOT_LISTENER_ARG
static final 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

Modifier and Type	Method	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.

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

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

Constructor Details

DiffCommandStep

public DiffCommandStep()

Method Details

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

Overrides:

requiredDependencies in class AbstractCommandStep

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

Overrides:

providedDependencies in class AbstractCommandStep

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 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 CommandScope.execute() order.

Throws:

Exception

createDiffResult

public DiffResult createDiffResult(CommandResultsBuilder resultsBuilder)
                            throws DatabaseException,
InvalidExampleException

Throws:

DatabaseException

InvalidExampleException

getTargetSnapshot

protected DatabaseSnapshot getTargetSnapshot(CommandResultsBuilder resultsBuilder)
                                      throws DatabaseException,
InvalidExampleException

Throws:

DatabaseException

InvalidExampleException

createReferenceSnapshot

protected DatabaseSnapshot createReferenceSnapshot(CommandResultsBuilder resultsBuilder)
                                            throws DatabaseException,
InvalidExampleException

Throws:

DatabaseException

InvalidExampleException