Top Description Fields Constructors Methods
liquibase.command.core.helpers

public Class DbUrlConnectionArgumentsCommandStep

extends AbstractHelperCommandStep
Class Inheritance
Imports
liquibase.Beta, liquibase.command.CommandArgumentDefinition, .CommandBuilder, .CommandResultsBuilder, .CommonArgumentNames, liquibase.configuration.ConfigurationValueObfuscator, liquibase.database.Database, java.util.Collections, .List

This class contains only the arguments used by DbUrlConnectionCommandStep.

Field Summary

Modifier and TypeField and Description
public static final String[]
public static final CommandArgumentDefinition<Database>
public static final CommandArgumentDefinition<String>
public static final CommandArgumentDefinition<String>
public static final CommandArgumentDefinition<String>
public static final CommandArgumentDefinition<String>
public static final CommandArgumentDefinition<String>
public static final CommandArgumentDefinition<Boolean>
SKIP_DATABASE_STEP_ARG

Deprecated
This Argument skips this step.
public static final CommandArgumentDefinition<String>
public static final CommandArgumentDefinition<String>

Constructor Summary

AccessConstructor and Description
public

Method Summary

Modifier and TypeMethod and Description
public String[][]
defineCommandNames()

Implements liquibase.command.CommandStep.defineCommandNames.

Defines new command names For example, if it is part of `liquibase update`, this should return new String[][]{ new String[] {"update"}}.

public List<Class<?>>
providedDependencies()

Overrides liquibase.command.AbstractCommandStep.providedDependencies.

Implements liquibase.command.CommandStep.providedDependencies.

Returns a list of all the dependency Classes that this step provides

public void
run(CommandResultsBuilder resultsBuilder)

Implements liquibase.command.CommandStep.run.

Performs the business logic.

Inherited from liquibase.command.core.helpers.AbstractHelperCommandStep:
adjustCommandDefinition

Field Detail

COMMAND_NAMEback to summary
public static final String[] COMMAND_NAME
DATABASE_ARGback to summary
public static final CommandArgumentDefinition<Database> DATABASE_ARG
DEFAULT_CATALOG_NAME_ARGback to summary
public static final CommandArgumentDefinition<String> DEFAULT_CATALOG_NAME_ARG
DEFAULT_SCHEMA_NAME_ARGback to summary
public static final CommandArgumentDefinition<String> DEFAULT_SCHEMA_NAME_ARG
DRIVER_ARGback to summary
public static final CommandArgumentDefinition<String> DRIVER_ARG
DRIVER_PROPERTIES_FILE_ARGback to summary
public static final CommandArgumentDefinition<String> DRIVER_PROPERTIES_FILE_ARG
PASSWORD_ARGback to summary
public static final CommandArgumentDefinition<String> PASSWORD_ARG
SKIP_DATABASE_STEP_ARGback to summary
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.

Annotations
@Beta
@Deprecated
URL_ARGback to summary
public static final CommandArgumentDefinition<String> URL_ARG
USERNAME_ARGback to summary
public static final CommandArgumentDefinition<String> USERNAME_ARG

Constructor Detail

DbUrlConnectionArgumentsCommandStepback to summary
public DbUrlConnectionArgumentsCommandStep()

Method Detail

defineCommandNamesback to summary
public String[][] defineCommandNames()

Implements liquibase.command.CommandStep.defineCommandNames.

Doc from liquibase.command.CommandStep.defineCommandNames.

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

Annotations
@Override
providedDependenciesback to summary
public List<Class<?>> providedDependencies()

Overrides liquibase.command.AbstractCommandStep.providedDependencies.

Implements liquibase.command.CommandStep.providedDependencies.

Doc from liquibase.command.CommandStep.providedDependencies.

Returns a list of all the dependency Classes that this step provides

Returns:List<Class<?>>

list with the provided classes types

Annotations
@Override
runback to summary
public void run(CommandResultsBuilder resultsBuilder) throws Exception

Implements liquibase.command.CommandStep.run.

Doc from liquibase.command.CommandStep.run.

Performs the business logic. This method should not be called directly. It is called by the overall pipeline logic in the CommandScope#execute() order.

Annotations
@Override