Package liquibase.command.core.helpers
Class ReferenceDbUrlConnectionCommandStep
- java.lang.Object
-
- liquibase.command.AbstractCommandStep
-
- liquibase.command.core.helpers.AbstractHelperCommandStep
-
- liquibase.command.core.helpers.AbstractDatabaseConnectionCommandStep
-
- liquibase.command.core.helpers.ReferenceDbUrlConnectionCommandStep
-
- All Implemented Interfaces:
CleanUpCommandStep
,CommandStep
public class ReferenceDbUrlConnectionCommandStep extends AbstractDatabaseConnectionCommandStep implements CleanUpCommandStep
Internal command step to be used on pipeline to manage the database connection to the reference database.
-
-
Field Summary
Fields Modifier and Type Field Description protected static String[]
COMMAND_NAME
static CommandArgumentDefinition<Database>
REFERENCE_DATABASE_ARG
static CommandArgumentDefinition<String>
REFERENCE_DEFAULT_CATALOG_NAME_ARG
static CommandArgumentDefinition<String>
REFERENCE_DEFAULT_SCHEMA_NAME_ARG
static CommandArgumentDefinition<String>
REFERENCE_DRIVER_ARG
static CommandArgumentDefinition<String>
REFERENCE_DRIVER_PROPERTIES_FILE_ARG
static CommandArgumentDefinition<String>
REFERENCE_LIQUIBASE_CATALOG_NAME_ARG
static CommandArgumentDefinition<String>
REFERENCE_LIQUIBASE_SCHEMA_NAME_ARG
static CommandArgumentDefinition<String>
REFERENCE_PASSWORD_ARG
static CommandArgumentDefinition<String>
REFERENCE_URL_ARG
static CommandArgumentDefinition<String>
REFERENCE_USERNAME_ARG
-
Fields inherited from interface liquibase.command.CommandStep
ORDER_DEFAULT, ORDER_NOT_APPLICABLE
-
-
Constructor Summary
Constructors Constructor Description ReferenceDbUrlConnectionCommandStep()
-
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, String username, String defaultSchemaName, String defaultCatalogName)
List<Class<?>>
providedDependencies()
Returns a list of all the dependency Classes that this step providesvoid
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, 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
-
REFERENCE_DATABASE_ARG
public static final CommandArgumentDefinition<Database> REFERENCE_DATABASE_ARG
-
REFERENCE_USERNAME_ARG
public static final CommandArgumentDefinition<String> REFERENCE_USERNAME_ARG
-
REFERENCE_PASSWORD_ARG
public static final CommandArgumentDefinition<String> REFERENCE_PASSWORD_ARG
-
REFERENCE_URL_ARG
public static final CommandArgumentDefinition<String> REFERENCE_URL_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_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
-
-
Method Detail
-
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
-
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
-
logMdc
public static void logMdc(String url, String username, String defaultSchemaName, String defaultCatalogName)
-
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
-
-