Top Description Fields Constructors Methods
liquibase.command.core.helpers

public Class DiffOutputControlCommandStep

extends AbstractHelperCommandStep
Class Inheritance
Imports
liquibase.Scope, liquibase.command.*, liquibase.diff.compare.CompareControl, liquibase.diff.output.DiffOutputControl, .ObjectChangeFilter, liquibase.logging.mdc.MdcKey, java.util.Collections, .List

Internal command step to be used on pipeline to instantiate a DiffOutputControl object that is mainly used by diffChangeLog/generateChangeLog .

Field Summary

Modifier and TypeField and Description
public static final String[]
public static final CommandResultDefinition<DiffOutputControl>
public static final CommandArgumentDefinition<Boolean>
public static final CommandArgumentDefinition<Boolean>
public static final CommandArgumentDefinition<Boolean>

Constructor Summary

AccessConstructor and Description
public

Method Summary

Modifier and TypeMethod and Description
private void
addMdcProperties(Boolean includeCatalog, Boolean includeSchema, Boolean includeTablespace)

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

private DiffOutputControl
getDiffOutputControl(CommandResultsBuilder resultsBuilder)

Creates a new DiffOutputControl object based on the parameters received by the command

protected void
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.

Inherited from liquibase.command.core.helpers.AbstractHelperCommandStep:
adjustCommandDefinition

Field Detail

COMMAND_NAMEback to summary
public static final String[] COMMAND_NAME
DIFF_OUTPUT_CONTROLback to summary
public static final CommandResultDefinition<DiffOutputControl> DIFF_OUTPUT_CONTROL
INCLUDE_CATALOG_ARGback to summary
public static final CommandArgumentDefinition<Boolean> INCLUDE_CATALOG_ARG
INCLUDE_SCHEMA_ARGback to summary
public static final CommandArgumentDefinition<Boolean> INCLUDE_SCHEMA_ARG
INCLUDE_TABLESPACE_ARGback to summary
public static final CommandArgumentDefinition<Boolean> INCLUDE_TABLESPACE_ARG

Constructor Detail

DiffOutputControlCommandStepback to summary
public DiffOutputControlCommandStep()

Method Detail

addMdcPropertiesback to summary
private void addMdcProperties(Boolean includeCatalog, Boolean includeSchema, Boolean includeTablespace)
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
getDiffOutputControlback to summary
private DiffOutputControl getDiffOutputControl(CommandResultsBuilder resultsBuilder)

Creates a new DiffOutputControl object based on the parameters received by the command

outputBestPracticeMessageback to summary
protected void outputBestPracticeMessage()
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