Package liquibase.command.core

Class UpdateCommandStep

java.lang.Object

liquibase.command.AbstractCommandStep

liquibase.command.core.AbstractUpdateCommandStep

liquibase.command.core.UpdateCommandStep

All Implemented Interfaces:

CleanUpCommandStep, CommandStep

public class UpdateCommandStep
extends AbstractUpdateCommandStep
implements CleanUpCommandStep

Field Summary

Fields

Modifier and Type	Field	Description
static final CommandArgumentDefinition<DatabaseChangeLog>	CHANGELOG_ARG
static final CommandArgumentDefinition<String>	CHANGELOG_FILE_ARG
static String[]	COMMAND_NAME
static final CommandArgumentDefinition<String>	CONTEXTS_ARG
static final CommandArgumentDefinition<String>	LABEL_FILTER_ARG
static final String[]	LEGACY_COMMAND_NAME

Fields inherited from class liquibase.command.core.AbstractUpdateCommandStep

DEFAULT_CHANGE_EXEC_LISTENER_RESULT_KEY

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
UpdateCommandStep()

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"}}.
String	getChangelogFileArg(CommandScope commandScope)
String[]	getCommandName()
String	getContextsArg(CommandScope commandScope)
String	getLabelFilterArg(CommandScope commandScope)
UpdateSummaryEnum	getShowSummary(CommandScope commandScope)
void	postUpdateLog(int rowsAffected, List<ChangeSet> exceptionChangeSets)	Generate post update log messages
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	validate(CommandScope commandScope)	Default implementation does no additional validation.

Methods inherited from class liquibase.command.core.AbstractUpdateCommandStep

cleanUp, customMdcLogging, getShowSummaryOutput, getStandardChangelogIterator, getStandardChangelogIteratorFilters, getStatusChangelogIterator, isUpToDate, postUpdateLog, postUpdateLogForActualUpdate, preRun, setDBLock, setFastCheckEnabled

Methods inherited from class liquibase.command.AbstractCommandStep

getOrder, providedDependencies

Methods inherited from class java.lang.Object

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

Methods inherited from interface liquibase.command.CleanUpCommandStep

cleanUp

Field Details

LEGACY_COMMAND_NAME

public static final String[] LEGACY_COMMAND_NAME

COMMAND_NAME

public static String[] COMMAND_NAME

CHANGELOG_FILE_ARG

public static final CommandArgumentDefinition<String> CHANGELOG_FILE_ARG

CHANGELOG_ARG

public static final CommandArgumentDefinition<DatabaseChangeLog> CHANGELOG_ARG

LABEL_FILTER_ARG

public static final CommandArgumentDefinition<String> LABEL_FILTER_ARG

CONTEXTS_ARG

public static final CommandArgumentDefinition<String> CONTEXTS_ARG

Constructor Details

UpdateCommandStep

public UpdateCommandStep()

Method Details

getChangelogFileArg

public String getChangelogFileArg(CommandScope commandScope)

Specified by:

getChangelogFileArg in class AbstractUpdateCommandStep

getContextsArg

public String getContextsArg(CommandScope commandScope)

Specified by:

getContextsArg in class AbstractUpdateCommandStep

getLabelFilterArg

public String getLabelFilterArg(CommandScope commandScope)

Specified by:

getLabelFilterArg in class AbstractUpdateCommandStep

getCommandName

public String[] getCommandName()

Specified by:

getCommandName in class AbstractUpdateCommandStep

getShowSummary

public UpdateSummaryEnum getShowSummary(CommandScope commandScope)

Specified by:

getShowSummary in class AbstractUpdateCommandStep

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

Specified by:

defineCommandNames in interface CommandStep

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

validate

public void validate(CommandScope commandScope)
              throws CommandValidationException

Description copied from class: AbstractCommandStep

Default implementation does no additional validation.

Specified by:

validate in interface CommandStep

Overrides:

validate in class AbstractCommandStep

Throws:

CommandValidationException

postUpdateLog

public void postUpdateLog(int rowsAffected,
 List<ChangeSet> exceptionChangeSets)

Description copied from class: AbstractUpdateCommandStep

Generate post update log messages

Overrides:

postUpdateLog in class AbstractUpdateCommandStep

Parameters:

rowsAffected - # of rows affected

exceptionChangeSets - list of changesets that failed

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 AbstractUpdateCommandStep

Returns:

list with the required classes types

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.

Specified by:

run in interface CommandStep

Overrides:

run in class AbstractUpdateCommandStep

Throws:

Exception