Top Fields Constructors Methods
liquibase.command.core

public Class DbDocCommandStep

extends AbstractCommandStep
Class Inheritance
Imports
liquibase.*, liquibase.changelog.*, liquibase.changelog.filter.DbmsChangeSetFilter, liquibase.changelog.visitor.ChangeExecListener, .DBDocVisitor, liquibase.command.*, liquibase.command.core.helpers.DatabaseChangelogCommandStep, liquibase.configuration.ConfigurationValueObfuscator, liquibase.database.Database, liquibase.exception.CommandExecutionException, .LiquibaseException, .LockException, liquibase.lockservice.LockService, .LockServiceFactory, liquibase.resource.PathHandlerFactory, .Resource, .ResourceAccessor, java.io.IOException, java.util.ArrayList, .Arrays, .List, .Optional

Field Summary

Modifier and TypeField and Description
public static final CommandArgumentDefinition<CatalogAndSchema[]>
public static final String[]
public static final CommandArgumentDefinition<String>
public static final CommandArgumentDefinition<String>
Inherited from liquibase.command.AbstractCommandStep:
coreBundle

Constructor Summary

AccessConstructor and Description
public

Method Summary

Modifier and TypeMethod and Description
public void
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"}}.

private CatalogAndSchema[]

Returns:

the catalog and schema array to use
getCatalogAndSchema
(String
the comma list of schemas input to the command via the command framework or cli
schemas
,
CatalogAndSchema[]
the list of catalog and schema from Main or Liquibase classes. This will be used if present.
catalogAndSchemaArg
,
Database
the database to find the catalog and schema against
database
)

Finds the appropriate catalog and schema for the query

public List<Class<?>>
requiredDependencies()

Overrides liquibase.command.AbstractCommandStep.requiredDependencies.

Implements liquibase.command.CommandStep.requiredDependencies.

Return a list of configured Classes that this command requires to be passed as a dependency.

public void
run(CommandResultsBuilder resultsBuilder)

Implements liquibase.command.CommandStep.run.

Performs the business logic.

Inherited from liquibase.command.AbstractCommandStep:
getOrderprovidedDependenciesvalidate

Field Detail

CATALOG_AND_SCHEMAS_ARGback to summary
public static final CommandArgumentDefinition<CatalogAndSchema[]> CATALOG_AND_SCHEMAS_ARG
COMMAND_NAMEback to summary
public static final String[] COMMAND_NAME
OUTPUT_DIRECTORY_ARGback to summary
public static final CommandArgumentDefinition<String> OUTPUT_DIRECTORY_ARG
SCHEMAS_ARGback to summary
public static final CommandArgumentDefinition<String> SCHEMAS_ARG

Constructor Detail

DbDocCommandStepback to summary
public DbDocCommandStep()

Method Detail

adjustCommandDefinitionback to summary
public void adjustCommandDefinition(CommandDefinition commandDefinition)

Overrides liquibase.command.AbstractCommandStep.adjustCommandDefinition.

Implements liquibase.command.CommandStep.adjustCommandDefinition.

Doc from liquibase.command.AbstractCommandStep.adjustCommandDefinition.

Default implementation makes no changes

Annotations
@Override
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
getCatalogAndSchemaback to summary
private CatalogAndSchema[] getCatalogAndSchema(String schemas, CatalogAndSchema[] catalogAndSchemaArg, Database database)

Finds the appropriate catalog and schema for the query

Parameters
schemas:String

the comma list of schemas input to the command via the command framework or cli

catalogAndSchemaArg:CatalogAndSchema[]

the list of catalog and schema from Main or Liquibase classes. This will be used if present.

database:Database

the database to find the catalog and schema against

Returns:CatalogAndSchema[]

the catalog and schema array to use

requiredDependenciesback to summary
public List<Class<?>> requiredDependencies()

Overrides liquibase.command.AbstractCommandStep.requiredDependencies.

Implements liquibase.command.CommandStep.requiredDependencies.

Doc from liquibase.command.CommandStep.requiredDependencies.

Return a list of configured Classes that this command requires to be passed as a dependency.

Returns:List<Class<?>>

list with the required 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