Top Fields Constructors Methods
liquibase.command.core

public Class UpdateCommandStep

extends AbstractUpdateCommandStep
implements CleanUpCommandStep
Class Inheritance
All Implemented Interfaces
liquibase.command.CleanUpCommandStep
Imports
liquibase.Scope, .UpdateSummaryEnum, liquibase.changelog.ChangeLogParameters, .DatabaseChangeLog, liquibase.changelog.visitor.ChangeExecListener, liquibase.command.*, liquibase.command.core.helpers.DatabaseChangelogCommandStep, liquibase.database.Database, liquibase.exception.CommandValidationException, java.util.Arrays, .List

Field Summary

Modifier and TypeField and Description
public static final CommandArgumentDefinition<DatabaseChangeLog>
CHANGELOG_ARG

public static final CommandArgumentDefinition<String>
CHANGELOG_FILE_ARG

public static String[]
COMMAND_NAME

public static final CommandArgumentDefinition<String>
CONTEXTS_ARG

public static final CommandArgumentDefinition<String>
LABEL_FILTER_ARG

public static final String[]
LEGACY_COMMAND_NAME

Inherited from liquibase.command.core.AbstractUpdateCommandStep:
DEFAULT_CHANGE_EXEC_LISTENER_RESULT_KEY

Constructor Summary

AccessConstructor and Description
public
UpdateCommandStep()

Method Summary

Modifier and TypeMethod and Description
public void
adjustCommandDefinition(CommandDefinition commandDefinition)

Overrides liquibase.command.AbstractCommandStep.adjustCommandDefinition.

Implements liquibase.command.CommandStep.adjustCommandDefinition.

Default implementation makes no changes

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 String
getChangelogFileArg(CommandScope commandScope)

Implements abstract liquibase.command.core.AbstractUpdateCommandStep.getChangelogFileArg.

public String[]
getCommandName()

Implements abstract liquibase.command.core.AbstractUpdateCommandStep.getCommandName.

public String
getContextsArg(CommandScope commandScope)

Implements abstract liquibase.command.core.AbstractUpdateCommandStep.getContextsArg.

public String
getLabelFilterArg(CommandScope commandScope)

Implements abstract liquibase.command.core.AbstractUpdateCommandStep.getLabelFilterArg.

public UpdateSummaryEnum
getShowSummary(CommandScope commandScope)

Implements abstract liquibase.command.core.AbstractUpdateCommandStep.getShowSummary.

public void
postUpdateLog(int rowsAffected)

Overrides liquibase.command.core.AbstractUpdateCommandStep.postUpdateLog.

Log

public List<Class<?>>
requiredDependencies()

Overrides liquibase.command.core.AbstractUpdateCommandStep.requiredDependencies.

Implements liquibase.command.CommandStep.requiredDependencies.

Return a list of configured Classes that this command requires to be passed as a dependency.

public void
run(CommandResultsBuilder resultsBuilder)

Overrides liquibase.command.core.AbstractUpdateCommandStep.run.

Implements liquibase.command.CommandStep.run.

Performs the business logic.

public void
validate(CommandScope commandScope)

Overrides liquibase.command.AbstractCommandStep.validate.

Implements liquibase.command.CommandStep.validate.

Default implementation does no additional validation.

Inherited from liquibase.command.core.AbstractUpdateCommandStep:
cleanUpcustomMdcLogginggetShowSummaryOutputgetStandardChangelogIteratorgetStandardChangelogIteratorFiltersgetStatusChangelogIteratorisUpToDateisUpToDateFastCheckpreRunsetDBLocksetFastCheckEnabled

Field Detail

CHANGELOG_ARGback to summary
public static final CommandArgumentDefinition<DatabaseChangeLog> CHANGELOG_ARG
CHANGELOG_FILE_ARGback to summary
public static final CommandArgumentDefinition<String> CHANGELOG_FILE_ARG
COMMAND_NAMEback to summary
public static String[] COMMAND_NAME
CONTEXTS_ARGback to summary
public static final CommandArgumentDefinition<String> CONTEXTS_ARG
LABEL_FILTER_ARGback to summary
public static final CommandArgumentDefinition<String> LABEL_FILTER_ARG
LEGACY_COMMAND_NAMEback to summary
public static final String[] LEGACY_COMMAND_NAME

Constructor Detail

UpdateCommandStepback to summary
public UpdateCommandStep()

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
getChangelogFileArgback to summary
public String getChangelogFileArg(CommandScope commandScope)

Implements abstract liquibase.command.core.AbstractUpdateCommandStep.getChangelogFileArg.

Annotations
@Override
getCommandNameback to summary
public String[] getCommandName()

Implements abstract liquibase.command.core.AbstractUpdateCommandStep.getCommandName.

Annotations
@Override
getContextsArgback to summary
public String getContextsArg(CommandScope commandScope)

Implements abstract liquibase.command.core.AbstractUpdateCommandStep.getContextsArg.

Annotations
@Override
getLabelFilterArgback to summary
public String getLabelFilterArg(CommandScope commandScope)

Implements abstract liquibase.command.core.AbstractUpdateCommandStep.getLabelFilterArg.

Annotations
@Override
getShowSummaryback to summary
public UpdateSummaryEnum getShowSummary(CommandScope commandScope)

Implements abstract liquibase.command.core.AbstractUpdateCommandStep.getShowSummary.

Annotations
@Override
postUpdateLogback to summary
public void postUpdateLog(int rowsAffected)

Overrides liquibase.command.core.AbstractUpdateCommandStep.postUpdateLog.

Doc from liquibase.command.core.AbstractUpdateCommandStep.postUpdateLog.

Log

Annotations
@Override
requiredDependenciesback to summary
public List<Class<?>> requiredDependencies()

Overrides liquibase.command.core.AbstractUpdateCommandStep.requiredDependencies.

Implements liquibase.command.CommandStep.requiredDependencies.

Doc from liquibase.command.CommandStep.requiredDependencies.

Return a list of configured Classes that this command requires to be passed as a dependency.

Returns:List<Class<?>>

list with the required classes types

Annotations
@Override
runback to summary
public void run(CommandResultsBuilder resultsBuilder) throws Exception

Overrides liquibase.command.core.AbstractUpdateCommandStep.run.

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
validateback to summary
public void validate(CommandScope commandScope) throws CommandValidationException

Overrides liquibase.command.AbstractCommandStep.validate.

Implements liquibase.command.CommandStep.validate.

Doc from liquibase.command.AbstractCommandStep.validate.

Default implementation does no additional validation.

Annotations
@Override