liquibase.command.core

Class SnapshotCommandStep

java.lang.Object

liquibase.command.AbstractCommandStep

liquibase.command.core.SnapshotCommandStep

All Implemented Interfaces:

CommandStep

public class SnapshotCommandStep
extends AbstractCommandStep

Field Summary

Fields

Modifier and Type	Field and Description
static String[]	COMMAND_NAME
static CommandArgumentDefinition<String>	SCHEMAS_ARG
static CommandArgumentDefinition<SnapshotControl>	SNAPSHOT_CONTROL_ARG
static CommandArgumentDefinition<String>	SNAPSHOT_FORMAT_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 and Description
SnapshotCommandStep()

Method Summary

Modifier and Type	Method and Description
void	adjustCommandDefinition(CommandDefinition commandDefinition) Default implementation makes no changes
String[][]	defineCommandNames() Defines new command names For example, if it is part of `liquibase update`, this should return new String[][]{ new String[] {"update"}}.
Map<String,Object>	getSnapshotMetadata()
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.
void	setSnapshotMetadata(Map<String,Object> snapshotMetadata)

Methods inherited from class liquibase.command.AbstractCommandStep

getOrder, providedDependencies, 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

SCHEMAS_ARG

public static final CommandArgumentDefinition<String> SCHEMAS_ARG

SNAPSHOT_FORMAT_ARG

public static final CommandArgumentDefinition<String> SNAPSHOT_FORMAT_ARG

SNAPSHOT_CONTROL_ARG

public static final CommandArgumentDefinition<SnapshotControl> SNAPSHOT_CONTROL_ARG

Constructor Detail

SnapshotCommandStep

public SnapshotCommandStep()

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

Overrides:

requiredDependencies in class AbstractCommandStep

Returns:

list with the required 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

getSnapshotMetadata

public Map<String,Object> getSnapshotMetadata()

setSnapshotMetadata

public void setSnapshotMetadata(Map<String,Object> snapshotMetadata)

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