Package liquibase.command.core

Class InternalSnapshotCommandStep

java.lang.Object

liquibase.command.AbstractCommandStep

liquibase.command.core.InternalSnapshotCommandStep

All Implemented Interfaces:

CommandStep

public class InternalSnapshotCommandStep
extends AbstractCommandStep

Field Summary

Fields

Modifier and Type	Field	Description
static final String[]	COMMAND_NAME
static final CommandArgumentDefinition<Database>	DATABASE_ARG
static final CommandArgumentDefinition<CatalogAndSchema[]>	SCHEMAS_ARG
static final CommandArgumentDefinition<String>	SERIALIZER_FORMAT_ARG
static final CommandArgumentDefinition<SnapshotControl>	SNAPSHOT_CONTROL_ARG
static final CommandArgumentDefinition<SnapshotListener>	SNAPSHOT_LISTENER_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
InternalSnapshotCommandStep()

Method Summary

Modifier and Type	Method	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()
boolean	isInternal()	Informational method to determine if this step is internal to Liquibase and should not be disclosed to end users
static void	logUnsupportedDatabase(Database database, Class callingClass)
static CatalogAndSchema[]	parseSchemas(Database database, String... schemas)
static String	printSnapshot(CommandScope commandScope, CommandResults snapshotResults)
void	run(CommandResultsBuilder resultsBuilder)	Performs the business logic.
void	setSnapshotMetadata(Map<String,Object> snapshotMetadata)

Methods inherited from class liquibase.command.AbstractCommandStep

getOrder, handleOutput, providedDependencies, requiredDependencies, validate

Methods inherited from class java.lang.Object

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

Field Details

COMMAND_NAME

public static final String[] COMMAND_NAME

DATABASE_ARG

public static final CommandArgumentDefinition<Database> DATABASE_ARG

SCHEMAS_ARG

public static final CommandArgumentDefinition<CatalogAndSchema[]> SCHEMAS_ARG

SERIALIZER_FORMAT_ARG

public static final CommandArgumentDefinition<String> SERIALIZER_FORMAT_ARG

SNAPSHOT_LISTENER_ARG

public static final CommandArgumentDefinition<SnapshotListener> SNAPSHOT_LISTENER_ARG

SNAPSHOT_CONTROL_ARG

public static final CommandArgumentDefinition<SnapshotControl> SNAPSHOT_CONTROL_ARG

Constructor Details

InternalSnapshotCommandStep

public InternalSnapshotCommandStep()

Method Details

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

parseSchemas

public static CatalogAndSchema[] parseSchemas(Database database,
 String... schemas)

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

printSnapshot

public static String printSnapshot(CommandScope commandScope,
 CommandResults snapshotResults)
                            throws LiquibaseException

Throws:

LiquibaseException

logUnsupportedDatabase

public static void logUnsupportedDatabase(Database database,
 Class callingClass)

isInternal

public boolean isInternal()

Description copied from interface: CommandStep

Informational method to determine if this step is internal to Liquibase and should not be disclosed to end users

Returns:

true if this step is internal to Liquibase and should not be shown in the help output