liquibase.command.core.helpers

Class DbUrlConnectionCommandStep

java.lang.Object

liquibase.command.AbstractCommandStep

liquibase.command.AbstractDatabaseConnectionCommandStep

liquibase.command.core.helpers.DbUrlConnectionCommandStep

All Implemented Interfaces:

CleanUpCommandStep, CommandStep

public class DbUrlConnectionCommandStep
extends AbstractDatabaseConnectionCommandStep
implements CleanUpCommandStep

Internal command step to be used on CommandStep pipeline to manage the database connection.

Field Summary

Fields

Modifier and Type	Field and Description
protected static String[]	COMMAND_NAME
static CommandArgumentDefinition<Database>	DATABASE_ARG
static CommandArgumentDefinition<String>	DEFAULT_CATALOG_NAME_ARG
static CommandArgumentDefinition<String>	DEFAULT_SCHEMA_NAME_ARG
static CommandArgumentDefinition<String>	DRIVER_ARG
static CommandArgumentDefinition<String>	DRIVER_PROPERTIES_FILE_ARG
static CommandArgumentDefinition<String>	PASSWORD_ARG
static CommandArgumentDefinition<Boolean>	SKIP_DATABASE_STEP_ARG Deprecated.
static CommandArgumentDefinition<String>	URL_ARG
static CommandArgumentDefinition<String>	USERNAME_ARG

Fields inherited from interface liquibase.command.CommandStep

ORDER_DEFAULT, ORDER_NOT_APPLICABLE

Constructor Summary

Constructors

Constructor and Description
DbUrlConnectionCommandStep()

Method Summary

Modifier and Type	Method and Description
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<?>>	providedDependencies() Returns a list of all the dependency Classes that this step provides
void	run(CommandResultsBuilder resultsBuilder) Performs the business logic.

Methods inherited from class liquibase.command.AbstractDatabaseConnectionCommandStep

adjustCommandDefinition, cleanUp, createDatabaseObject

Methods inherited from class liquibase.command.AbstractCommandStep

getOrder, requiredDependencies, validate

Methods inherited from class java.lang.Object

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

Methods inherited from interface liquibase.command.CleanUpCommandStep

cleanUp

Field Detail

COMMAND_NAME

protected static final String[] COMMAND_NAME

DATABASE_ARG

public static final CommandArgumentDefinition<Database> DATABASE_ARG

URL_ARG

public static final CommandArgumentDefinition<String> URL_ARG

DEFAULT_SCHEMA_NAME_ARG

public static final CommandArgumentDefinition<String> DEFAULT_SCHEMA_NAME_ARG

DEFAULT_CATALOG_NAME_ARG

public static final CommandArgumentDefinition<String> DEFAULT_CATALOG_NAME_ARG

USERNAME_ARG

public static final CommandArgumentDefinition<String> USERNAME_ARG

PASSWORD_ARG

public static final CommandArgumentDefinition<String> PASSWORD_ARG

DRIVER_ARG

public static final CommandArgumentDefinition<String> DRIVER_ARG

DRIVER_PROPERTIES_FILE_ARG

public static final CommandArgumentDefinition<String> DRIVER_PROPERTIES_FILE_ARG

SKIP_DATABASE_STEP_ARG

@Beta
 @Deprecated
public static final CommandArgumentDefinition<Boolean> SKIP_DATABASE_STEP_ARG

Deprecated.

This Argument skips this step. It may not be a definitive solution, as improvements to pipeline may change the way that we remove/skip steps.

Constructor Detail

DbUrlConnectionCommandStep

public DbUrlConnectionCommandStep()

Method Detail

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

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

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