Package liquibase.command.core.helpers

Class DatabaseChangelogCommandStep

java.lang.Object

liquibase.command.AbstractCommandStep

liquibase.command.core.helpers.AbstractHelperCommandStep

liquibase.command.core.helpers.DatabaseChangelogCommandStep

All Implemented Interfaces:

CleanUpCommandStep, CommandStep

public class DatabaseChangelogCommandStep
extends AbstractHelperCommandStep
implements CleanUpCommandStep

This helper class provides two objects: a valid and verified DatabaseChangeLog and the ChangeLogParameters object used to instantiate it.

Field Summary

Fields

Modifier and Type	Field	Description
static CommandArgumentDefinition<DatabaseChangeLog>	CHANGELOG_ARG
static CommandArgumentDefinition<String>	CHANGELOG_FILE_ARG
static CommandArgumentDefinition<ChangeLogParameters>	CHANGELOG_PARAMETERS
protected static String[]	COMMAND_NAME
static CommandArgumentDefinition<String>	CONTEXTS_ARG
static CommandArgumentDefinition<String>	LABEL_FILTER_ARG
static CommandArgumentDefinition<Boolean>	UPDATE_NULL_CHECKSUMS

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
DatabaseChangelogCommandStep()

Method Summary

Modifier and Type	Method	Description
static void	addCommandFiltersMdc(LabelExpression labelExpression, Contexts contexts)
void	addJavaProperties(ChangeLogParameters changeLogParameters)	Add java property arguments to changelog parameters
void	cleanUp(CommandResultsBuilder resultsBuilder)	Method invoked to execute the cleanup action.
String[][]	defineCommandNames()	Defines new command names For example, if it is part of `liquibase update`, this should return new String[][]{ new String[] {"update"}}.
static DatabaseChangeLog	getDatabaseChangeLog(String changeLogFile, ChangeLogParameters changeLogParameters, Database database)
List<Class<?>>	providedDependencies()	Returns a list of all the dependency Classes that this step provides
List<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.

Methods inherited from class liquibase.command.core.helpers.AbstractHelperCommandStep

adjustCommandDefinition

Methods inherited from class liquibase.command.AbstractCommandStep

getOrder, validate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

COMMAND_NAME

protected static final 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

CHANGELOG_PARAMETERS

public static final CommandArgumentDefinition<ChangeLogParameters> CHANGELOG_PARAMETERS

UPDATE_NULL_CHECKSUMS

@Beta
public static final CommandArgumentDefinition<Boolean> UPDATE_NULL_CHECKSUMS

Constructor Detail

DatabaseChangelogCommandStep

public DatabaseChangelogCommandStep()

Method Detail

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 interface CommandStep

Overrides:

providedDependencies in class AbstractCommandStep

Returns:

list with the provided classes types

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 interface CommandStep

Overrides:

requiredDependencies in class AbstractCommandStep

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 the CommandScope.execute() order.

Specified by:

run in interface CommandStep

Throws:

Exception

addCommandFiltersMdc

public static void addCommandFiltersMdc(LabelExpression labelExpression,
                                        Contexts contexts)

getDatabaseChangeLog

public static DatabaseChangeLog getDatabaseChangeLog(String changeLogFile,
                                                     ChangeLogParameters changeLogParameters,
                                                     Database database)
                                              throws Exception

Throws:

Exception

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 interface CommandStep

cleanUp

public void cleanUp(CommandResultsBuilder resultsBuilder)

Description copied from interface: CleanUpCommandStep

Method invoked to execute the cleanup action.

Specified by:

cleanUp in interface CleanUpCommandStep

Parameters:

resultsBuilder - builder used in this pipeline

addJavaProperties

public void addJavaProperties(ChangeLogParameters changeLogParameters)

Add java property arguments to changelog parameters

Parameters:

changeLogParameters - the changelog parameters to update