Top Fields Constructors Methods
liquibase.command.core

public Class InternalSnapshotCommandStep

extends AbstractCommandStep
Class Inheritance
Imports
liquibase.CatalogAndSchema, .Scope, liquibase.command.*, liquibase.database.Database, .ObjectQuotingStrategy, liquibase.database.core.*, liquibase.exception.LiquibaseException, liquibase.license.LicenseServiceUtils, liquibase.serializer.SnapshotSerializerFactory, liquibase.snapshot.DatabaseSnapshot, .SnapshotControl, .SnapshotGeneratorFactory, .SnapshotListener, liquibase.util.StringUtil, java.util.ArrayList, .List, .Locale, .Map

Field Summary

Modifier and TypeField and Description
public static final String[]
public static final CommandArgumentDefinition<Database>
public static final CommandArgumentDefinition<CatalogAndSchema[]>
public static final CommandArgumentDefinition<String>
public static final CommandArgumentDefinition<SnapshotListener>
private Map<String, Object>
Inherited from liquibase.command.AbstractCommandStep:
coreBundle

Constructor Summary

AccessConstructor and Description
public

Method Summary

Modifier and TypeMethod and Description
public void
public String[][]
defineCommandNames()

Implements liquibase.command.CommandStep.defineCommandNames.

Defines new command names For example, if it is part of `liquibase update`, this should return new String[][]{ new String[] {"update"}}.

public Map<String, Object>
public static void
logUnsupportedDatabase(Database database, Class<T> callingClass)

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

public static String
printSnapshot(CommandScope commandScope, CommandResults snapshotResults)

public void
run(CommandResultsBuilder resultsBuilder)

Implements liquibase.command.CommandStep.run.

Performs the business logic.

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

Inherited from liquibase.command.AbstractCommandStep:
getOrderprovidedDependenciesrequiredDependenciesvalidate

Field Detail

COMMAND_NAMEback to summary
public static final String[] COMMAND_NAME
DATABASE_ARGback to summary
public static final CommandArgumentDefinition<Database> DATABASE_ARG
SCHEMAS_ARGback to summary
public static final CommandArgumentDefinition<CatalogAndSchema[]> SCHEMAS_ARG
SERIALIZER_FORMAT_ARGback to summary
public static final CommandArgumentDefinition<String> SERIALIZER_FORMAT_ARG
SNAPSHOT_LISTENER_ARGback to summary
public static final CommandArgumentDefinition<SnapshotListener> SNAPSHOT_LISTENER_ARG
snapshotMetadataback to summary
private Map<String, Object> snapshotMetadata

Constructor Detail

InternalSnapshotCommandStepback to summary
public InternalSnapshotCommandStep()

Method Detail

adjustCommandDefinitionback to summary
public void adjustCommandDefinition(CommandDefinition commandDefinition)

Overrides liquibase.command.AbstractCommandStep.adjustCommandDefinition.

Implements liquibase.command.CommandStep.adjustCommandDefinition.

Doc from liquibase.command.AbstractCommandStep.adjustCommandDefinition.

Default implementation makes no changes

Annotations
@Override
defineCommandNamesback to summary
public String[][] defineCommandNames()

Implements liquibase.command.CommandStep.defineCommandNames.

Doc from liquibase.command.CommandStep.defineCommandNames.

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

Annotations
@Override
getSnapshotMetadataback to summary
public Map<String, Object> getSnapshotMetadata()
logUnsupportedDatabaseback to summary
public static void logUnsupportedDatabase(Database database, Class<T> callingClass)
parseSchemasback to summary
public static CatalogAndSchema[] parseSchemas(Database database, String... schemas)
printSnapshotback to summary
public static String printSnapshot(CommandScope commandScope, CommandResults snapshotResults) throws LiquibaseException
runback to summary
public void run(CommandResultsBuilder resultsBuilder) throws Exception

Implements liquibase.command.CommandStep.run.

Doc from liquibase.command.CommandStep.run.

Performs the business logic. This method should not be called directly. It is called by the overall pipeline logic in the CommandScope#execute() order.

Annotations
@Override
setSnapshotMetadataback to summary
public void setSnapshotMetadata(Map<String, Object> snapshotMetadata)