Package liquibase.command.core.helpers
Class DbUrlConnectionCommandStep
- java.lang.Object
-
- liquibase.command.AbstractCommandStep
-
- liquibase.command.core.helpers.AbstractHelperCommandStep
-
- liquibase.command.core.helpers.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 Description protected static String[]
COMMAND_NAME
static CommandArgumentDefinition<Database>
DATABASE_ARG
Deprecated.This field is retained for backwards compatibility.static CommandArgumentDefinition<String>
DEFAULT_CATALOG_NAME_ARG
Deprecated.This field is retained for backwards compatibility.static CommandArgumentDefinition<String>
DEFAULT_SCHEMA_NAME_ARG
Deprecated.This field is retained for backwards compatibility.static CommandArgumentDefinition<String>
DRIVER_ARG
Deprecated.This field is retained for backwards compatibility.static CommandArgumentDefinition<String>
DRIVER_PROPERTIES_FILE_ARG
Deprecated.This field is retained for backwards compatibility.static CommandArgumentDefinition<String>
PASSWORD_ARG
Deprecated.This field is retained for backwards compatibility.static CommandArgumentDefinition<Boolean>
SKIP_DATABASE_STEP_ARG
Deprecated.This field is retained for backwards compatibility.static CommandArgumentDefinition<String>
URL_ARG
Deprecated.This field is retained for backwards compatibility.static CommandArgumentDefinition<String>
USERNAME_ARG
Deprecated.This field is retained for backwards compatibility.-
Fields inherited from interface liquibase.command.CommandStep
ORDER_DEFAULT, ORDER_NOT_APPLICABLE
-
-
Constructor Summary
Constructors Constructor Description DbUrlConnectionCommandStep()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description String[][]
defineCommandNames()
Defines new command names For example, if it is part of `liquibase update`, this should return new String[][]{ new String[] {"update"}}.static void
logMdc(String url, Database database)
Database
obtainDatabase(CommandScope commandScope)
Try to retrieve and set the database object from the command scope, otherwise creates a new one .List<Class<?>>
providedDependencies()
Returns a list of all the dependency Classes that this step providesList<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.AbstractDatabaseConnectionCommandStep
cleanUp, createDatabaseObject
-
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
-
Methods inherited from interface liquibase.command.CleanUpCommandStep
cleanUp
-
-
-
-
Field Detail
-
COMMAND_NAME
protected static final String[] COMMAND_NAME
-
DATABASE_ARG
@Deprecated public static final CommandArgumentDefinition<Database> DATABASE_ARG
Deprecated.This field is retained for backwards compatibility. Use the fields inDbUrlConnectionArgumentsCommandStep
instead.
-
URL_ARG
@Deprecated public static final CommandArgumentDefinition<String> URL_ARG
Deprecated.This field is retained for backwards compatibility. Use the fields inDbUrlConnectionArgumentsCommandStep
instead.
-
DEFAULT_SCHEMA_NAME_ARG
@Deprecated public static final CommandArgumentDefinition<String> DEFAULT_SCHEMA_NAME_ARG
Deprecated.This field is retained for backwards compatibility. Use the fields inDbUrlConnectionArgumentsCommandStep
instead.
-
DEFAULT_CATALOG_NAME_ARG
@Deprecated public static final CommandArgumentDefinition<String> DEFAULT_CATALOG_NAME_ARG
Deprecated.This field is retained for backwards compatibility. Use the fields inDbUrlConnectionArgumentsCommandStep
instead.
-
USERNAME_ARG
@Deprecated public static final CommandArgumentDefinition<String> USERNAME_ARG
Deprecated.This field is retained for backwards compatibility. Use the fields inDbUrlConnectionArgumentsCommandStep
instead.
-
PASSWORD_ARG
@Deprecated public static final CommandArgumentDefinition<String> PASSWORD_ARG
Deprecated.This field is retained for backwards compatibility. Use the fields inDbUrlConnectionArgumentsCommandStep
instead.
-
DRIVER_ARG
@Deprecated public static final CommandArgumentDefinition<String> DRIVER_ARG
Deprecated.This field is retained for backwards compatibility. Use the fields inDbUrlConnectionArgumentsCommandStep
instead.
-
DRIVER_PROPERTIES_FILE_ARG
@Deprecated public static final CommandArgumentDefinition<String> DRIVER_PROPERTIES_FILE_ARG
Deprecated.This field is retained for backwards compatibility. Use the fields inDbUrlConnectionArgumentsCommandStep
instead.
-
SKIP_DATABASE_STEP_ARG
@Beta @Deprecated public static final CommandArgumentDefinition<Boolean> SKIP_DATABASE_STEP_ARG
Deprecated.This field is retained for backwards compatibility. Use the fields inDbUrlConnectionArgumentsCommandStep
instead.
-
-
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 theCommandScope.execute()
order.- Specified by:
run
in interfaceCommandStep
- Throws:
Exception
-
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 interfaceCommandStep
- Overrides:
requiredDependencies
in classAbstractCommandStep
- Returns:
- list with the required classes types
-
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 interfaceCommandStep
- Overrides:
providedDependencies
in classAbstractCommandStep
- Returns:
- list with the provided classes types
-
obtainDatabase
public Database obtainDatabase(CommandScope commandScope) throws DatabaseException
Try to retrieve and set the database object from the command scope, otherwise creates a new one .- Parameters:
commandScope
- current command scope- Throws:
DatabaseException
- Thrown when there is a connection error
-
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 interfaceCommandStep
-
-