Package liquibase.command.core.helpers
Class ShowSummaryArgument
- java.lang.Object
-
- liquibase.command.AbstractCommandStep
-
- liquibase.command.core.helpers.ShowSummaryArgument
-
- All Implemented Interfaces:
CommandStep
public class ShowSummaryArgument extends AbstractCommandStep
This class encapsulates the argument "show-summary", which applies to the update family of commands. The show-summary feature will display a formatted summary table when performing an update command. SeeShowSummaryUtil
for implementation.
-
-
Field Summary
Fields Modifier and Type Field Description protected static String[]
COMMAND_NAME
static CommandArgumentDefinition<UpdateSummaryEnum>
SHOW_SUMMARY
static CommandArgumentDefinition<UpdateSummaryOutputEnum>
SHOW_SUMMARY_OUTPUT
-
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 ShowSummaryArgument()
-
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"}}.List<Class<?>>
providedDependencies()
Returns a list of all the dependency Classes that this step providesvoid
run(CommandResultsBuilder resultsBuilder)
Performs the business logic.-
Methods inherited from class liquibase.command.AbstractCommandStep
getOrder, requiredDependencies, validate
-
-
-
-
Field Detail
-
COMMAND_NAME
protected static final String[] COMMAND_NAME
-
SHOW_SUMMARY
public static final CommandArgumentDefinition<UpdateSummaryEnum> SHOW_SUMMARY
-
SHOW_SUMMARY_OUTPUT
public static final CommandArgumentDefinition<UpdateSummaryOutputEnum> SHOW_SUMMARY_OUTPUT
-
-
Method Detail
-
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
-
providedDependencies
public List<Class<?>> providedDependencies()
Description copied from interface:CommandStep
Returns a list of all the dependency Classes that this step provides- Specified by:
providedDependencies
in interfaceCommandStep
- Overrides:
providedDependencies
in classAbstractCommandStep
- Returns:
- list with the provided 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.- Throws:
Exception
-
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
-
-