liquibase.command.core

Class InternalGenerateChangelogCommandStep

java.lang.Object

liquibase.command.AbstractCommandStep

liquibase.command.core.InternalDiffCommandStep

liquibase.command.core.InternalDiffChangelogCommandStep

liquibase.command.core.InternalGenerateChangelogCommandStep

All Implemented Interfaces:

CommandStep

public class InternalGenerateChangelogCommandStep
extends InternalDiffChangelogCommandStep

Field Summary

Fields

Modifier and Type	Field and Description
static CommandArgumentDefinition<String>	AUTHOR_ARG
static String[]	COMMAND_NAME
static CommandArgumentDefinition<String>	CONTEXT_ARG

Fields inherited from class liquibase.command.core.InternalDiffChangelogCommandStep

CHANGELOG_FILE_ARG, DIFF_OUTPUT_CONTROL_ARG

Fields inherited from class liquibase.command.core.InternalDiffCommandStep

COMPARE_CONTROL_ARG, OBJECT_CHANGE_FILTER_ARG, PRINT_RESULT, REFERENCE_DATABASE_ARG, REFERENCE_SNAPSHOT_CONTROL_ARG, SNAPSHOT_LISTENER_ARG, SNAPSHOT_TYPES_ARG, TARGET_DATABASE_ARG, TARGET_SNAPSHOT_CONTROL_ARG

Fields inherited from interface liquibase.command.CommandStep

ORDER_DEFAULT, ORDER_NOT_APPLICABLE

Constructor Summary

Constructors

Constructor and Description
InternalGenerateChangelogCommandStep()

Method Summary

Modifier and Type	Method and Description
void	adjustCommandDefinition(CommandDefinition commandDefinition) Default implementation makes no changes
protected DatabaseSnapshot	createTargetSnapshot(CommandScope commandScope)
String[][]	defineCommandNames() Defines new command names For example, if it is part of `liquibase update`, this should return new String[][]{ new String[] {"update"}}.
void	run(CommandResultsBuilder resultsBuilder) Performs the business logic.

Methods inherited from class liquibase.command.core.InternalDiffChangelogCommandStep

createDiffToChangeLogObject, outputBestPracticeMessage

Methods inherited from class liquibase.command.core.InternalDiffCommandStep

createDiffResult, createReferenceSnapshot, parseSnapshotTypes

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

public static final String[] COMMAND_NAME

AUTHOR_ARG

public static final CommandArgumentDefinition<String> AUTHOR_ARG

CONTEXT_ARG

public static final CommandArgumentDefinition<String> CONTEXT_ARG

Constructor Detail

InternalGenerateChangelogCommandStep

public InternalGenerateChangelogCommandStep()

Method Detail

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

Overrides:

defineCommandNames in class InternalDiffChangelogCommandStep

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 InternalDiffChangelogCommandStep

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 CommandStep.getOrder(CommandDefinition) order.

Specified by:

run in interface CommandStep

Overrides:

run in class InternalDiffChangelogCommandStep

Throws:

Exception

createTargetSnapshot

protected DatabaseSnapshot createTargetSnapshot(CommandScope commandScope)
                                         throws DatabaseException,
                                                InvalidExampleException

Overrides:

createTargetSnapshot in class InternalDiffCommandStep

Throws:

DatabaseException

InvalidExampleException