Top Deprecated By Reference
Liquibase 4.26.0

Deprecated API


No API in this release is deprecated for removal.

Deprecated Item Summary

SinceDeprecated Item and Description
liquibase.Liquibase.changeLogSync(Contexts contexts)

use version with LabelExpression

liquibase.Liquibase.diff(Database referenceDatabase, Database targetDatabase, CompareControl compareControl)

Use \CommandScope(String) to generate diff instead of this method.

liquibase.Liquibase.futureRollbackSQL(String contexts, Writer output, boolean checkLiquibaseTables)

liquibase.Liquibase.futureRollbackSQL(Integer count, String contexts, Writer output, boolean checkLiquibaseTables)

liquibase.Liquibase.futureRollbackSQL(Integer count, Contexts contexts, LabelExpression labelExpression, Writer output, boolean checkLiquibaseTables)

liquibase.Liquibase.futureRollbackSQL(Integer count, String tag, Contexts contexts, LabelExpression labelExpression, Writer output)

liquibase.Liquibase.futureRollbackSQL(Integer count, String tag, Contexts contexts, LabelExpression labelExpression, Writer output, boolean checkLiquibaseTables)

liquibase.Liquibase.generateChangeLog(CatalogAndSchema catalogAndSchema, DiffToChangeLog changeLogWriter, PrintStream outputStream, Class<? extends DatabaseObject>... snapshotTypes)

Use \CommandScope(String) to generateChangelog instead of this method.

liquibase.Liquibase.generateChangeLog(CatalogAndSchema catalogAndSchema, DiffToChangeLog changeLogWriter, PrintStream outputStream, ChangeLogSerializer changeLogSerializer, Class<? extends DatabaseObject>... snapshotTypes)

Use \CommandScope(String) to generateChangelog instead of this method.

liquibase.Liquibase.generateDocumentation(String outputDirectory, String contexts, CatalogAndSchema... schemaList)

liquibase.Liquibase.generateDocumentation(String outputDirectory, Contexts contexts, LabelExpression labelExpression, CatalogAndSchema... schemaList)

Use CommandScope to generate dbDoc instead of this method.

liquibase.Liquibase.getChangeSetStatuses(Contexts contexts)

use version with LabelExpression

liquibase.Liquibase.isUpToDateFastCheck(Contexts contexts, LabelExpression labelExpression)

this method has been moved to AbstractUpdateCommandStep, use that one instead.

liquibase.Liquibase.listUnrunChangeSets(Contexts contexts)

use version with LabelExpression

liquibase.Liquibase.listUnrunChangeSets(Contexts contexts, LabelExpression labels, boolean checkLiquibaseTables)

liquibase.Liquibase.reportStatus(boolean verbose, String contexts, Writer out)

liquibase.Liquibase.reportStatus(boolean verbose, Contexts contexts, Writer out)

liquibase.Liquibase.reportStatus(boolean verbose, Contexts contexts, LabelExpression labels, Writer out)

liquibase.Liquibase.reportUnexpectedChangeSets(boolean verbose, Contexts contexts, LabelExpression labelExpression, Writer out)

liquibase.Liquibase.rollback(String tagToRollBackTo, String contexts, Writer output)

liquibase.Liquibase.rollback(String tagToRollBackTo, Contexts contexts, Writer output)

liquibase.Liquibase.rollback(String tagToRollBackTo, Contexts contexts, LabelExpression labelExpression, Writer output)

liquibase.Liquibase.rollback(String tagToRollBackTo, String rollbackScript, String contexts, Writer output)

liquibase.Liquibase.rollback(String tagToRollBackTo, String rollbackScript, Contexts contexts, Writer output)

liquibase.Liquibase.rollback(String tagToRollBackTo, String rollbackScript, Contexts contexts, LabelExpression labelExpression, Writer output)

liquibase.Liquibase.rollback(String tagToRollBackTo, String contexts)

liquibase.Liquibase.rollback(String tagToRollBackTo, Contexts contexts)

liquibase.Liquibase.rollback(String tagToRollBackTo, Contexts contexts, LabelExpression labelExpression)

liquibase.Liquibase.rollback(String tagToRollBackTo, String rollbackScript, String contexts)

liquibase.Liquibase.rollback(String tagToRollBackTo, String rollbackScript, Contexts contexts)

liquibase.Liquibase.tag(String tagString)

Use CommandScope(String) to tag instead of this method.

liquibase.Liquibase.tagExists(String tagString)

Use \CommandScope(String) to verify tag exist instead of this method.

liquibase.Liquibase.update(Contexts contexts, LabelExpression labelExpression, boolean checkLiquibaseTables)

use CommandScope

liquibase.Liquibase.update(Contexts contexts, LabelExpression labelExpression, Writer output)

liquibase.Liquibase.update(Contexts contexts, LabelExpression labelExpression, Writer output, boolean checkLiquibaseTables)

liquibase.Liquibase.update(int changesToApply, String contexts)

liquibase.Liquibase.update(int
the number of changesets to apply.
changesToApply
,
Contexts
the contexts in which the changesets should be applied.
contexts
,
LabelExpression
the label expression used to filter the changesets.
labelExpression
)

liquibase.Liquibase.update(String
The tag to update the database to.
tag
,
Contexts
The contexts to execute in.
contexts
,
LabelExpression
The label expression to execute with.
labelExpression
)

liquibase.Liquibase.update(int changesToApply, String contexts, Writer output)

liquibase.Liquibase.update(int changesToApply, Contexts contexts, LabelExpression labelExpression, Writer output)

liquibase.Liquibase.update(String tag, Contexts contexts, LabelExpression labelExpression, Writer output)

liquibase.change.AbstractSQLChange.NormalizingStream(String endDelimiter, Boolean splitStatements, Boolean stripComments, InputStream stream)

liquibase.change.AbstractSQLChange.isSplitStatementsSet()

To be removed when splitStatements is changed to be Boolean type

liquibase.change.AbstractSQLChange.splitStatementsSet

To be removed when splitStatements is changed to be type Boolean

liquibase.change.NormalizingStreamV8(String endDelimiter, Boolean splitStatements, Boolean stripComments, InputStream stream)

liquibase.change.core.AddForeignKeyConstraintChange.getDeleteCascade()

Use getOnDelete(). This always returns null so it doesn't impact checksums when settings onDelete vs. deleteCascade

liquibase.change.core.CreateProcedureChange.setProcedureBody(String procedureText)

Use setProcedureText() instead

liquibase.changelog.ChangeLogHistoryServiceFactory.getInstance()

Instead use Scope.getCurrentScope().getSingleton(ChangeLogHistoryServiceFactory.class)

liquibase.changelog.DatabaseChangeLog.findResources(String pathName, boolean isRelativeToChangelogFile, IncludeAllFilter resourceFilter, boolean errorIfMissingOrEmpty, Comparator<String> resourceComparator, ResourceAccessor resourceAccessor, int minDepth, int maxDepth)

liquibase.changelog.DatabaseChangeLog.include(String fileName, boolean isRelativePath, boolean errorIfMissing, ResourceAccessor resourceAccessor, ContextExpression includeContextFilter, LabelExpression labelExpression, Boolean ignore, boolean logEveryUnknownFileFormat)

use DatabaseChangeLog#include(String, boolean, boolean, ResourceAccessor, ContextExpression, Labels, Boolean, OnUnknownFileFormat)

liquibase.changelog.DatabaseChangeLog.include(String fileName, boolean isRelativePath, boolean errorIfMissing, ResourceAccessor resourceAccessor, ContextExpression includeContextFilter, Labels labels, Boolean ignore, boolean logEveryUnknownFileFormat)

use DatabaseChangeLog#include(String, boolean, boolean, ResourceAccessor, ContextExpression, Labels, Boolean, OnUnknownFileFormat)

liquibase.changelog.DatabaseChangeLog.includeAll(String pathName, boolean isRelativeToChangelogFile, IncludeAllFilter resourceFilter, boolean errorIfMissingOrEmpty, Comparator<String> resourceComparator, ResourceAccessor resourceAccessor, ContextExpression includeContextFilter, LabelExpression labelExpression, boolean ignore)

use DatabaseChangeLog#includeAll(String, boolean, IncludeAllFilter, boolean, Comparator, ResourceAccessor, ContextExpression, Labels, boolean, int, int)

liquibase.changelog.DatabaseChangeLog.includeAll(String pathName, boolean isRelativeToChangelogFile, IncludeAllFilter resourceFilter, boolean errorIfMissingOrEmpty, Comparator<String> resourceComparator, ResourceAccessor resourceAccessor, ContextExpression includeContextFilter, Labels labels, boolean ignore, int minDepth, int maxDepth, ModifyChangeSets modifyChangeSets)

liquibase.changelog.DatabaseChangeLog.setIncludeLabels(LabelExpression labels)

Correct version is setIncludeLabels(Labels). Kept for backwards compatibility.

liquibase.changelog.visitor.RollbackVisitor(Database database)

- please use the constructor with ChangeExecListener, which can be null.

liquibase.changelog.visitor.UpdateVisitor(Database database)

- please use the constructor with ChangeExecListener, which can be null.

liquibase.command.CommandArgument

Used by the old LiquibaseCommand style of command setup.

liquibase.command.CommandExecutionException

Used by the old LiquibaseCommand style of command setup.

liquibase.command.CommandResult

Used by the old LiquibaseCommand style of command setup.

Returns:

-1 if this step does not apply to the given command
liquibase.command.CommandStep.getOrder
(CommandDefinition commandDefinition)

liquibase.command.CommandValidationErrors

Used by the old LiquibaseCommand style of command setup.

liquibase.command.LiquibaseCommand<T extends CommandResult>

Define command with the new CommandStep interface

liquibase.command.LiquibaseCommandFactory

Used for supporting old-style LiquibaseCommand implementations

liquibase.command.core.helpers.DbUrlConnectionCommandStep.DATABASE_ARG

This field is retained for backwards compatibility. Use the fields in DbUrlConnectionArgumentsCommandStep instead.

liquibase.command.core.helpers.DbUrlConnectionCommandStep.DEFAULT_CATALOG_NAME_ARG

This field is retained for backwards compatibility. Use the fields in DbUrlConnectionArgumentsCommandStep instead.

liquibase.command.core.helpers.DbUrlConnectionCommandStep.DEFAULT_SCHEMA_NAME_ARG

This field is retained for backwards compatibility. Use the fields in DbUrlConnectionArgumentsCommandStep instead.

liquibase.command.core.helpers.DbUrlConnectionCommandStep.DRIVER_ARG

This field is retained for backwards compatibility. Use the fields in DbUrlConnectionArgumentsCommandStep instead.

liquibase.command.core.helpers.DbUrlConnectionCommandStep.DRIVER_PROPERTIES_FILE_ARG

This field is retained for backwards compatibility. Use the fields in DbUrlConnectionArgumentsCommandStep instead.

liquibase.command.core.helpers.DbUrlConnectionCommandStep.PASSWORD_ARG

This field is retained for backwards compatibility. Use the fields in DbUrlConnectionArgumentsCommandStep instead.

liquibase.command.core.helpers.DbUrlConnectionCommandStep.SKIP_DATABASE_STEP_ARG

This field is retained for backwards compatibility. Use the fields in DbUrlConnectionArgumentsCommandStep instead.

liquibase.command.core.helpers.DbUrlConnectionCommandStep.URL_ARG

This field is retained for backwards compatibility. Use the fields in DbUrlConnectionArgumentsCommandStep instead.

liquibase.command.core.helpers.DbUrlConnectionCommandStep.USERNAME_ARG

This field is retained for backwards compatibility. Use the fields in DbUrlConnectionArgumentsCommandStep instead.

liquibase.database.Database.escapeColumnName(String catalogName, String schemaName, String tableName, String columnName, boolean quoteNamesThatMayBeFunctions)

Know if you should quote the name or not, and use escapeColumnName(String, String, String, String) which will quote things that look like functions, or leave it along as you see fit. Don't rely on this function guessing.

liquibase.executor.ExecutorService.clearExecutor(Database database)

Please use clearExecutor(name, database)

Returns:

Executor for the specified database and name
liquibase.executor.ExecutorService.getExecutor
(Database
the Database to execute the statements on
database
)

Please use getExecutor(String, Database) instead.

liquibase.integration.ant.BaseLiquibaseTask.setPromptOnNonLocalDatabase(boolean promptOnNonLocalDatabase)

no longer prompts

liquibase.integration.commandline.CommandLineUtils.createDatabaseObject(ClassLoader classLoader, String url, String username, String password, String driver, String defaultCatalogName, String defaultSchemaName, boolean outputDefaultCatalog, boolean outputDefaultSchema, String databaseClass, String driverPropertiesFile, String propertyProviderClass, String liquibaseCatalogName, String liquibaseSchemaName, String databaseChangeLogTableName, String databaseChangeLogLockTableName)

Use ResourceAccessor version

liquibase.integration.commandline.CommandLineUtils.createDatabaseObject(ResourceAccessor resourceAccessor, String url, String username, String password, String driver, String defaultCatalogName, String defaultSchemaName, boolean outputDefaultCatalog, boolean outputDefaultSchema, String databaseClass, String driverPropertiesFile, String propertyProviderClass, String liquibaseCatalogName, String liquibaseSchemaName, String databaseChangeLogTableName, String databaseChangeLogLockTableName)

liquibase.integration.commandline.CommandLineUtils.doDiffToChangeLog(String changeLogFile, Database referenceDatabase, Database targetDatabase, String author, DiffOutputControl diffOutputControl, ObjectChangeFilter objectChangeFilter, String snapshotTypes)

Use version with String runOnChangeTypes, String replaceIfExistsTypes instead - doDiffToChangeLog(String, Database, Database, String, DiffOutputControl, ObjectChangeFilter, String, String, String)

liquibase.integration.commandline.CommandLineUtils.doDiffToChangeLog(String changeLogFile, Database referenceDatabase, Database targetDatabase, String author, DiffOutputControl diffOutputControl, ObjectChangeFilter objectChangeFilter, String snapshotTypes, CompareControl.SchemaComparison[] schemaComparisons)

Use version with String runOnChangeTypes, String replaceIfExistsTypes instead - doDiffToChangeLog(String, Database, Database, String, DiffOutputControl, ObjectChangeFilter, String, CompareControl.SchemaComparison[], String, String)

liquibase.integration.commandline.CommandLineUtils.doGenerateChangeLog(String changeLogFile, Database originalDatabase, String catalogName, String schemaName, String snapshotTypes, String author, String context, String dataDir, DiffOutputControl diffOutputControl)

Use version with String runOnChangeTypes, String replaceIfExistsTypes instead - doGenerateChangeLog(String, Database, String, String, String, String, String, String, DiffOutputControl, String, String)

liquibase.integration.commandline.CommandLineUtils.doGenerateChangeLog(String changeLogFile, Database originalDatabase, CatalogAndSchema[] schemas, String snapshotTypes, String author, String context, String dataDir, DiffOutputControl diffOutputControl)

Use version with String runOnChangeTypes, String replaceIfExistsTypes instead - doGenerateChangeLog(String, Database, String, String, String, String, String, String, DiffOutputControl, String, String)

liquibase.integration.commandline.CommandLineUtils.doGenerateChangeLog(String changeLogFile, Database originalDatabase, CatalogAndSchema[] schemas, String snapshotTypes, String author, String context, String dataDir, DiffOutputControl diffOutputControl, boolean overwriteOutputFile)

Use version with String runOnChangeTypes, String replaceIfExistsTypes instead - doGenerateChangeLog(String, Database, CatalogAndSchema[], String, String, String, String, DiffOutputControl, String, String)

liquibase.integration.commandline.Main

use liquibase.integration.commandline.LiquibaseCommandLine.

liquibase.integration.spring.SpringLiquibase.setIgnoreClasspathPrefix(boolean ignoreClasspathPrefix)

Always ignoring classpath prefix

liquibase.lockservice.LockServiceImpl

use StandardLockService instead

liquibase.logging.LogMessageFilter

No longer used for filtering log messages. Log messages should be filtered for sensitive information before sending them to the log.

liquibase.logging.core.AbstractLogger(LogMessageFilter ignored)

use {@link AbstractLogger(). Passed filter is not used.

liquibase.logging.core.AbstractLogger.filterMessage(String message)

now just returns the message

liquibase.logging.core.DefaultLoggerConfiguration

not in use anywhere in Liquibase code and has been superseded by log-level and its associated command line parameters

liquibase.parser.ChangeLogParserCofiguration

Use correctly spelled version

Returns:

null if resourcePath does not exist and createIfNotExists is false
liquibase.resource.PathHandlerFactory.openResourceOutputStream
(String resourcePath, boolean createIfNotExists)

use openResourceOutputStream(String, OpenOptions)

Returns:

empty set if nothing was found
liquibase.resource.ResourceAccessor.list
(String
Location that streamPath should be found relative to. If null, path is an absolute path
relativeTo
,
String
The path to lookup resources in.
path
,
boolean
Set to true and will return paths to contents in sub directories as well.
recursive
,
boolean
Set to true and will return paths to files.
includeFiles
,
boolean
Set to true and will return paths to directories.
includeDirectories
)

use search(String, boolean)

Returns:

null if the resource does not exist
liquibase.resource.ResourceAccessor.openStream
(String
Location that streamPath should be found relative to. If null, streamPath is an absolute path
relativeTo
,
String streamPath)

Use search(String, boolean) or getAll(String)

Returns:

Empty list if the resource does not exist.
liquibase.resource.ResourceAccessor.openStreams
(String
Location that streamPath should be found relative to. If null, streamPath is an absolute path
relativeTo
,
String streamPath)

Use search(String, boolean) or getAll(String)

liquibase.statement.core.AddPrimaryKeyStatement(String catalogName, String schemaName, String tableName, String columnNames, String constraintName)

liquibase.util.ShowSummaryUtil.showUpdateSummary(DatabaseChangeLog
The changelog used in this update
changeLog
,
UpdateSummaryEnum
Flag to control whether or not we show the summary
showSummary
,
UpdateSummaryOutputEnum
Flag to control where we show the summary
showSummaryOutput
,
StatusVisitor
The StatusVisitor used to determine statuses
statusVisitor
,
OutputStream
The OutputStream to use for the summary
outputStream
)

liquibase.util.SqlParser.parse(String sqlBlock, boolean preserveWhitespace, boolean preserveComments)

load the LiquibaseSqlParser using the SqlParserFactory directly.

liquibase.util.StringUtil.processMutliLineSQL(String
A String containing all the SQL statements
multiLineSQL
,
boolean
If true then comments will be stripped, if false then they will be left in the code
stripComments
,
boolean splitStatements, String endDelimiter)

The new method is processMultiLineSQL(String, boolean, boolean, String, ChangeSet) (String)}

liquibase.util.StringUtil.processMutliLineSQL(String
A String containing all the SQL statements
multiLineSQL
,
boolean
If true then comments will be stripped, if false then they will be left in the code
stripComments
,
boolean splitStatements, String endDelimiter, ChangeSet
the changeset associated with the sql being parsed
changeSet
)

The new method is processMultiLineSQL(String, boolean, boolean, String, ChangeSet) (String)}

Returns:

String Output string with new lines
liquibase.util.StringUtil.wrap
(final String
The string to split and wrap
inputStr
,
int
The point at which to split the lines
wrapPoint
,
int
Any additional spaces to add
extraLinePadding
)

Liquibase does not wrap any console output, and instead lets the terminal handle its own wrapping. If you wish to use this method, consider whether its usage is truly necessary.