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 CommandArgumentDefinition<DatabaseChangeLog>
CHANGELOG_ARG
static CommandArgumentDefinition<String>
CHANGELOG_FILE_ARG
static String[]
COMMAND_NAME
static CommandArgumentDefinition<String>
CONTEXTS_ARG
static CommandArgumentDefinition<String>
LABEL_FILTER_ARG
static 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
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
adjustCommandDefinition(CommandDefinition commandDefinition)
Default implementation makes no changesString[][]
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)
LogList<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, isUpToDateFastCheck, 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 Detail
-
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
-
-
Method Detail
-
getChangelogFileArg
public String getChangelogFileArg(CommandScope commandScope)
- Specified by:
getChangelogFileArg
in classAbstractUpdateCommandStep
-
getContextsArg
public String getContextsArg(CommandScope commandScope)
- Specified by:
getContextsArg
in classAbstractUpdateCommandStep
-
getLabelFilterArg
public String getLabelFilterArg(CommandScope commandScope)
- Specified by:
getLabelFilterArg
in classAbstractUpdateCommandStep
-
getCommandName
public String[] getCommandName()
- Specified by:
getCommandName
in classAbstractUpdateCommandStep
-
getShowSummary
public UpdateSummaryEnum getShowSummary(CommandScope commandScope)
- Specified by:
getShowSummary
in classAbstractUpdateCommandStep
-
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 interfaceCommandStep
-
adjustCommandDefinition
public void adjustCommandDefinition(CommandDefinition commandDefinition)
Description copied from class:AbstractCommandStep
Default implementation makes no changes- Specified by:
adjustCommandDefinition
in interfaceCommandStep
- Overrides:
adjustCommandDefinition
in classAbstractCommandStep
-
validate
public void validate(CommandScope commandScope) throws CommandValidationException
Description copied from class:AbstractCommandStep
Default implementation does no additional validation.- Specified by:
validate
in interfaceCommandStep
- Overrides:
validate
in classAbstractCommandStep
- Throws:
CommandValidationException
-
postUpdateLog
public void postUpdateLog(int rowsAffected)
Description copied from class:AbstractUpdateCommandStep
Log- Overrides:
postUpdateLog
in classAbstractUpdateCommandStep
-
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 interfaceCommandStep
- Overrides:
requiredDependencies
in classAbstractUpdateCommandStep
- 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 theCommandScope.execute()
order.- Specified by:
run
in interfaceCommandStep
- Overrides:
run
in classAbstractUpdateCommandStep
- Throws:
Exception
-
-