Package liquibase.command.core

Class GenerateChangelogCommandStep

java.lang.Object

liquibase.command.AbstractCommandStep

liquibase.command.core.helpers.AbstractChangelogCommandStep

liquibase.command.core.GenerateChangelogCommandStep

All Implemented Interfaces:

CommandStep

public class GenerateChangelogCommandStep
extends AbstractChangelogCommandStep

Field Summary

Fields

Modifier and Type	Field	Description
static final CommandArgumentDefinition<String>	AUTHOR_ARG
static final CommandArgumentDefinition<String>	CHANGELOG_FILE_ARG
static final String[]	COMMAND_NAME
static final CommandArgumentDefinition<String>	CONTEXT_ARG
static final CommandArgumentDefinition<String>	CONTEXTS_ARG
static final CommandArgumentDefinition<String>	DATA_OUTPUT_DIR_ARG
static final CommandArgumentDefinition<String>	LABEL_FILTER_ARG
static final CommandArgumentDefinition<Boolean>	OVERWRITE_OUTPUT_FILE_ARG
static final CommandArgumentDefinition<String>	REFERENCE_DEFAULT_CATALOG_NAME_ARG
static final CommandArgumentDefinition<String>	REFERENCE_DEFAULT_SCHEMA_NAME_ARG
static final CommandArgumentDefinition<String>	REFERENCE_DRIVER_ARG
static final CommandArgumentDefinition<String>	REFERENCE_DRIVER_PROPERTIES_FILE_ARG
static final CommandArgumentDefinition<String>	REFERENCE_LIQUIBASE_CATALOG_NAME_ARG
static final CommandArgumentDefinition<String>	REFERENCE_LIQUIBASE_SCHEMA_NAME_ARG
static final CommandArgumentDefinition<String>	REFERENCE_PASSWORD_ARG
static final CommandArgumentDefinition<String>	REFERENCE_SCHEMAS_ARG
static final CommandArgumentDefinition<String>	REFERENCE_URL_ARG
static final CommandArgumentDefinition<String>	REFERENCE_USERNAME_ARG
static final CommandArgumentDefinition<Boolean>	USE_OR_REPLACE_OPTION

Fields inherited from class liquibase.command.core.helpers.AbstractChangelogCommandStep

REPLACE_IF_EXISTS_TYPES_ARG, RUN_ON_CHANGE_TYPES_ARG, SKIP_OBJECT_SORTING

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

Method Summary

Modifier and Type	Method	Description
void	adjustCommandDefinition(CommandDefinition commandDefinition)	Default implementation makes no changes
String[][]	defineCommandNames()	Defines new command names For example, if it is part of `liquibase update`, this should return new String[][]{ new String[] {"update"}}.
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.
void	validate(CommandScope commandScope)	Default implementation does no additional validation.

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

supportedRunOnChangeTypes, validateReplaceIfExistsTypes, validateRunOnChangeTypes

Methods inherited from class liquibase.command.AbstractCommandStep

getOrder, providedDependencies

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

AUTHOR_ARG

public static final CommandArgumentDefinition<String> AUTHOR_ARG

CONTEXT_ARG

public static final CommandArgumentDefinition<String> CONTEXT_ARG

CONTEXTS_ARG

public static final CommandArgumentDefinition<String> CONTEXTS_ARG

LABEL_FILTER_ARG

public static final CommandArgumentDefinition<String> LABEL_FILTER_ARG

DATA_OUTPUT_DIR_ARG

public static final CommandArgumentDefinition<String> DATA_OUTPUT_DIR_ARG

OVERWRITE_OUTPUT_FILE_ARG

public static final CommandArgumentDefinition<Boolean> OVERWRITE_OUTPUT_FILE_ARG

CHANGELOG_FILE_ARG

public static final CommandArgumentDefinition<String> CHANGELOG_FILE_ARG

REFERENCE_URL_ARG

public static final CommandArgumentDefinition<String> REFERENCE_URL_ARG

REFERENCE_USERNAME_ARG

public static final CommandArgumentDefinition<String> REFERENCE_USERNAME_ARG

REFERENCE_PASSWORD_ARG

public static final CommandArgumentDefinition<String> REFERENCE_PASSWORD_ARG

REFERENCE_DEFAULT_SCHEMA_NAME_ARG

public static final CommandArgumentDefinition<String> REFERENCE_DEFAULT_SCHEMA_NAME_ARG

REFERENCE_DEFAULT_CATALOG_NAME_ARG

public static final CommandArgumentDefinition<String> REFERENCE_DEFAULT_CATALOG_NAME_ARG

REFERENCE_DRIVER_ARG

public static final CommandArgumentDefinition<String> REFERENCE_DRIVER_ARG

REFERENCE_DRIVER_PROPERTIES_FILE_ARG

public static final CommandArgumentDefinition<String> REFERENCE_DRIVER_PROPERTIES_FILE_ARG

REFERENCE_SCHEMAS_ARG

public static final CommandArgumentDefinition<String> REFERENCE_SCHEMAS_ARG

REFERENCE_LIQUIBASE_SCHEMA_NAME_ARG

public static final CommandArgumentDefinition<String> REFERENCE_LIQUIBASE_SCHEMA_NAME_ARG

REFERENCE_LIQUIBASE_CATALOG_NAME_ARG

public static final CommandArgumentDefinition<String> REFERENCE_LIQUIBASE_CATALOG_NAME_ARG

USE_OR_REPLACE_OPTION

public static final CommandArgumentDefinition<Boolean> USE_OR_REPLACE_OPTION

Constructor Details

GenerateChangelogCommandStep

public GenerateChangelogCommandStep()

Method Details

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

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

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.

Throws:

Exception

validate

public void validate(CommandScope commandScope)
              throws CommandValidationException

Description copied from class: AbstractCommandStep

Default implementation does no additional validation.

Specified by:

validate in interface CommandStep

Overrides:

validate in class AbstractCommandStep

Throws:

CommandValidationException

adjustCommandDefinition

public void adjustCommandDefinition(CommandDefinition commandDefinition)

Description copied from class: AbstractCommandStep

Default implementation makes no changes

Specified by:

adjustCommandDefinition in interface CommandStep

Overrides:

adjustCommandDefinition in class AbstractCommandStep