Top Fields Constructors Methods
liquibase.command.core

public Class DiffChangelogCommandStep

extends AbstractChangelogCommandStep
Class Inheritance
Imports
liquibase.Scope, liquibase.command.*, liquibase.command.core.helpers.AbstractChangelogCommandStep, .DiffOutputControlCommandStep, liquibase.command.providers.ReferenceDatabase, liquibase.database.Database, .ObjectQuotingStrategy, liquibase.diff.DiffResult, liquibase.diff.output.DiffOutputControl, liquibase.diff.output.changelog.DiffToChangeLog, liquibase.exception.CommandValidationException, liquibase.logging.mdc.MdcKey, .MdcObject, .MdcValue, liquibase.util.StringUtil, .ValueHandlerUtil, java.io.PrintStream, java.util.*

Field Summary

Modifier and TypeField and Description
public static final CommandArgumentDefinition<String>
public static final CommandArgumentDefinition<String>
public static final String[]
public static final CommandArgumentDefinition<String>
public static final CommandArgumentDefinition<String>
public static final CommandArgumentDefinition<Boolean>
Inherited from liquibase.command.core.helpers.AbstractChangelogCommandStep:
REPLACE_IF_EXISTS_TYPES_ARGRUN_ON_CHANGE_TYPES_ARG

Constructor Summary

AccessConstructor and Description
public

Method Summary

Modifier and TypeMethod and Description
public void
protected DiffToChangeLog
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 List<Class<?>>
providedDependencies()

Overrides liquibase.command.AbstractCommandStep.providedDependencies.

Implements liquibase.command.CommandStep.providedDependencies.

Returns a list of all the dependency Classes that this step provides

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.

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.helpers.AbstractChangelogCommandStep:
supportedReplaceIfExistsTypessupportedRunOnChangeTypesvalidateReplaceIfExistsTypesvalidateRunOnChangeTypes

Field Detail

AUTHOR_ARGback to summary
public static final CommandArgumentDefinition<String> AUTHOR_ARG
CHANGELOG_FILE_ARGback to summary
public static final CommandArgumentDefinition<String> CHANGELOG_FILE_ARG
COMMAND_NAMEback to summary
public static final String[] COMMAND_NAME

Hides liquibase.command.core.helpers.AbstractChangelogCommandStep.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
USE_OR_REPLACE_OPTIONback to summary
public static final CommandArgumentDefinition<Boolean> USE_OR_REPLACE_OPTION

Constructor Detail

DiffChangelogCommandStepback to summary
public DiffChangelogCommandStep()

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
createDiffToChangeLogObjectback to summary
protected DiffToChangeLog createDiffToChangeLogObject(DiffResult diffResult, DiffOutputControl diffOutputControl)
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
providedDependenciesback to summary
public List<Class<?>> providedDependencies()

Overrides liquibase.command.AbstractCommandStep.providedDependencies.

Implements liquibase.command.CommandStep.providedDependencies.

Doc from liquibase.command.CommandStep.providedDependencies.

Returns a list of all the dependency Classes that this step provides

Returns:List<Class<?>>

list with the provided classes types

Annotations
@Override
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
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