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 final CommandArgumentDefinition<DatabaseChangeLog>	CHANGELOG_ARG
static final CommandArgumentDefinition<String>	CHANGELOG_FILE_ARG
static final CommandArgumentDefinition<ChangeLogParameters>	CHANGELOG_PARAMETERS
static final String[]	COMMAND_NAME
static final CommandArgumentDefinition<String>	CONTEXTS_ARG
static final CommandArgumentDefinition<String>	LABEL_FILTER_ARG
static final 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)	Adds label and context filter values to the MDC for logging purposes.
void	addJavaProperties(ChangeLogParameters changeLogParameters)	Deprecated. use ChangeLogParameters.addJavaProperties() instead.
void	cleanUp(CommandResultsBuilder resultsBuilder)	Cleans up resources held by this command step.
String[][]	defineCommandNames()	Returns the command names defined by this step.
static DatabaseChangeLog	getDatabaseChangeLog(String changeLogFile, ChangeLogParameters changeLogParameters, Database database)	Parses and returns the database change log from the specified file.
List<Class<?>>	providedDependencies()	Returns the classes provided by this command step.
List<Class<?>>	requiredDependencies()	Returns the classes required by this command step.
void	run(CommandResultsBuilder resultsBuilder)	Executes the changelog command step.

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

adjustCommandDefinition, isInternal

Methods inherited from class liquibase.command.AbstractCommandStep

getOrder, handleOutput, validate

Methods inherited from class java.lang.Object

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

Field Details

COMMAND_NAME

public 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 Details

DatabaseChangelogCommandStep

public DatabaseChangelogCommandStep()

Method Details

providedDependencies

public List<Class<?>> providedDependencies()

Returns the classes provided by this command step.

Specified by:

providedDependencies in interface CommandStep

Overrides:

providedDependencies in class AbstractCommandStep

Returns:

list of dependency classes

requiredDependencies

public List<Class<?>> requiredDependencies()

Returns the classes required by this command step.

Specified by:

requiredDependencies in interface CommandStep

Overrides:

requiredDependencies in class AbstractCommandStep

Returns:

list of required dependency classes

run

public void run(CommandResultsBuilder resultsBuilder)
         throws Exception

Executes the changelog command step.

Specified by:

run in interface CommandStep

Parameters:

resultsBuilder - the command results builder

Throws:

Exception - if an error occurs during execution

addCommandFiltersMdc

public static void addCommandFiltersMdc(LabelExpression labelExpression,
 Contexts contexts)

Adds label and context filter values to the MDC for logging purposes.

Parameters:

labelExpression - the label expression to log

contexts - the contexts to log

getDatabaseChangeLog

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

Parses and returns the database change log from the specified file.

Parameters:

changeLogFile - the path to the changelog file

changeLogParameters - the parameters for parsing

database - the database context

Returns:

the parsed DatabaseChangeLog

Throws:

Exception - if parsing fails

defineCommandNames

public String[][] defineCommandNames()

Returns the command names defined by this step.

Specified by:

defineCommandNames in interface CommandStep

Returns:

array of command name arrays

cleanUp

public void cleanUp(CommandResultsBuilder resultsBuilder)

Cleans up resources held by this command step.

Specified by:

cleanUp in interface CleanUpCommandStep

Parameters:

resultsBuilder - the command results builder

addJavaProperties

@Deprecated
public void addJavaProperties(ChangeLogParameters changeLogParameters)

Deprecated.

use ChangeLogParameters.addJavaProperties() instead.

Add java property arguments to changelog parameters

Parameters:

changeLogParameters - the changelog parameters to update