Top Fields Constructors Methods
liquibase.command.core

public Class StatusCommandStep

extends AbstractCommandStep
Class Inheritance
Imports
liquibase.Contexts, .LabelExpression, .RuntimeEnvironment, .Scope, liquibase.changelog.ChangeLogIterator, .ChangeLogParameters, .ChangeSet, .DatabaseChangeLog, liquibase.changelog.filter.*, liquibase.changelog.visitor.ListVisitor, liquibase.command.*, liquibase.database.Database, liquibase.exception.DatabaseException, liquibase.logging.mdc.MdcKey, .MdcObject, liquibase.logging.mdc.customobjects.SimpleStatus, .Status, liquibase.util.StreamUtil, java.io.OutputStream, .OutputStreamWriter, java.util.Arrays, .Collections, .List

Field Summary

Modifier and TypeField and Description
public static final String[]
COMMAND_NAME

public static final CommandArgumentDefinition<Boolean>
VERBOSE_ARG

Inherited from liquibase.command.AbstractCommandStep:
coreBundle

Constructor Summary

AccessConstructor and Description
public
StatusCommandStep()

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"}}.

protected ChangeLogIterator
getStandardChangelogIterator(Contexts contexts, LabelExpression labelExpression, DatabaseChangeLog changeLog, Database database)

public List<ChangeSet>
listUnrunChangeSets(Contexts contexts, LabelExpression labels, DatabaseChangeLog changeLog, Database database)

public List<Class<?>>
requiredDependencies()

Overrides liquibase.command.AbstractCommandStep.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)

Implements liquibase.command.CommandStep.run.

Performs the business logic.

Inherited from liquibase.command.AbstractCommandStep:
getOrderprovidedDependenciesvalidate

Field Detail

COMMAND_NAMEback to summary
public static final String[] COMMAND_NAME
VERBOSE_ARGback to summary
public static final CommandArgumentDefinition<Boolean> VERBOSE_ARG

Constructor Detail

StatusCommandStepback to summary
public StatusCommandStep()

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
getStandardChangelogIteratorback to summary
protected ChangeLogIterator getStandardChangelogIterator(Contexts contexts, LabelExpression labelExpression, DatabaseChangeLog changeLog, Database database) throws DatabaseException
listUnrunChangeSetsback to summary
public List<ChangeSet> listUnrunChangeSets(Contexts contexts, LabelExpression labels, DatabaseChangeLog changeLog, Database database) throws Exception
requiredDependenciesback to summary
public List<Class<?>> requiredDependencies()

Overrides liquibase.command.AbstractCommandStep.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

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