Liquibase 4.26.0 · liquibase.database.AbstractJdbcDatabase

Modifier and Type	Field and Description
private final Map<String, Object>	attributes
private boolean	canCacheLiquibaseTableInfo
protected Boolean	caseSensitive
private DatabaseConnection	connection
private static final Pattern	CREATE_VIEW_AS_PATTERN
private static final String	CREATE_VIEW_AS_REGEX
protected String	currentDateTimeFunction
private String	databaseChangeLogLockTableName Hides liquibase.database.Database.databaseChangeLogLockTableName.
private String	databaseChangeLogTableName Hides liquibase.database.Database.databaseChangeLogTableName.
private static final Pattern	DATE_ONLY_PATTERN
private static final String	DATE_ONLY_REGEX
private static final Pattern	DATE_TIME_PATTERN
private static final String	DATE_TIME_REGEX
protected List<DatabaseFunction>	dateFunctions
private static final int	DEFAULT_MAX_TIMESTAMP_FRACTIONAL_DIGITS
protected BigInteger	defaultAutoIncrementBy
protected BigInteger	defaultAutoIncrementStartWith
protected String	defaultCatalogName
private boolean	defaultCatalogSet
protected String	defaultSchemaName
private static final int	FETCH_SIZE
private String	liquibaseCatalogName
private String	liquibaseSchemaName
private String	liquibaseTablespaceName
private static final Pattern	NAME_WITH_ASC_PATTERN
private static final String	NAME_WITH_ASC_REGEX
private static final Pattern	NAME_WITH_DESC_PATTERN
private static final String	NAME_WITH_DESC_REGEX
private static final Pattern	NON_WORD_PATTERN
private static final String	NON_WORD_REGEX
private boolean	outputDefaultCatalog
private boolean	outputDefaultSchema
private Boolean	previousAutoCommit
protected ObjectQuotingStrategy	quotingStrategy
private final Set<String>	reservedWords
protected String	sequenceCurrentValueFunction
protected String	sequenceNextValueFunction The sequence name will be substituted into the string e.g. NEXTVAL('%s')
private static final Pattern	STARTS_WITH_NUMBER_PATTERN
private static final String	STARTS_WITH_NUMBER_REGEX
private static final Pattern	TIME_PATTERN
private static final String	TIME_REGEX
private static final Pattern	TIMESTAMP_PATTERN
private static final String	TIMESTAMP_REGEX
protected List<String>	unmodifiableDataTypes
protected Boolean	unquotedObjectsAreUppercased

Access	Constructor and Description
public	AbstractJdbcDatabase()

Method Summary

Modifier and Type	Method and Description
public final void	addReservedWords(Collection<String> words) Implements liquibase.database.Database.addReservedWords.
protected boolean	canCreateChangeLogTable()
public void	close() Implements liquibase.database.Database.close. Closes this resource, relinquishing any underlying resources.
public void	commit() Implements liquibase.database.Database.commit.
public String	correctObjectName(final String objectName, final Class<? extends DatabaseObject> objectType) Implements liquibase.database.Database.correctObjectName. Fix the object name to the format the database expects, handling changes in case, etc.
public CatalogAndSchema	correctSchema(final String catalog, final String schema) Deprecated
public CatalogAndSchema	correctSchema(final CatalogAndSchema schema) Implements liquibase.database.Database.correctSchema. Deprecated Returns a new CatalogAndSchema adjusted for this database.
public boolean	createsIndexesForForeignKeys() Implements liquibase.database.Database.createsIndexesForForeignKeys.
public boolean	dataTypeIsNotModifiable(final String type name typeName) Implements liquibase.database.Database.dataTypeIsNotModifiable. Types like int4 in postgres cannot have a modifier.
public boolean	disableForeignKeyChecks() Implements liquibase.database.Database.disableForeignKeyChecks.
public boolean	doesTagExist(final String tag) Implements liquibase.database.Database.doesTagExist.
public void	dropDatabaseObjects(final CatalogAndSchema schema (catalog+)schema to drop schemaToDrop) Implements liquibase.database.Database.dropDatabaseObjects. Drops all objects in a specified schema.
public void	enableForeignKeyChecks() Implements liquibase.database.Database.enableForeignKeyChecks.
public boolean	equals(final Object the reference object with which to compare. o) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
public String	escapeColumnName(final String catalogName, final String schemaName, final String tableName, final String column name columnName) Implements liquibase.database.Database.escapeColumnName. Escapes a single column name in a database-dependent manner so reserved words can be used as a column name (i.e. "return").
public String	escapeColumnName(String catalogName, String schemaName, String tableName, String columnName, boolean quoteNamesThatMayBeFunctions) Implements liquibase.database.Database.escapeColumnName. Similar to `escapeColumnName(String, String, String, String)` but allows control over whether function-like names should be left unquoted.
public String	escapeColumnNameList(final String list of column names columnNames) Implements liquibase.database.Database.escapeColumnNameList. Escapes a list of column names in a database-dependent manner so reserved words can be used as a column name (i.e. "return").
public String	escapeConstraintName(final String constraintName) Implements liquibase.database.Database.escapeConstraintName.
public String	escapeDataTypeName(String dataTypeName) Implements liquibase.database.Database.escapeDataTypeName.
public String	escapeIndexName(final String catalogName, final String schemaName, final String indexName) Implements liquibase.database.Database.escapeIndexName.
public String	escapeObjectName(String catalogName, String schemaName, final String objectName, final Class<? extends DatabaseObject> objectType) Implements liquibase.database.Database.escapeObjectName.
public String	escapeObjectName(String objectName, final Class<? extends DatabaseObject> objectType) Implements liquibase.database.Database.escapeObjectName.
public String	escapeSequenceName(final String catalogName, final String schemaName, final String sequenceName) Implements liquibase.database.Database.escapeSequenceName.
public String	escapeStringForDatabase(final String string) Implements liquibase.database.Database.escapeStringForDatabase.
public String	escapeTableName(final String catalogName, final String schemaName, final String tableName) Implements liquibase.database.Database.escapeTableName.
public String	escapeViewName(final String catalogName, final String schemaName, final String viewName) Implements liquibase.database.Database.escapeViewName.
public void	execute(final SqlStatement[] statements, final List<SqlVisitor> sqlVisitors) Implements liquibase.database.Database.execute.
public void	executeRollbackStatements(final SqlStatement[] statements, final List<SqlVisitor> sqlVisitors) Implements liquibase.database.Database.executeRollbackStatements.
public void	executeRollbackStatements(final Change change, final List<SqlVisitor> sqlVisitors) Implements liquibase.database.Database.executeRollbackStatements.
public void	executeStatements(final Change change, final DatabaseChangeLog changeLog, final List<SqlVisitor> sqlVisitors) Implements liquibase.database.Database.executeStatements.
protected List<SqlVisitor>	filterRollbackVisitors(final List<SqlVisitor> visitors) Takes a list of SqlVisitors and returns a new list with only the SqlVisitors set to apply to rollbacks
protected boolean	generateAutoIncrementBy(final BigInteger incrementBy)
protected boolean	generateAutoIncrementStartWith(final BigInteger startWith)
public String	generateDatabaseFunctionValue(final DatabaseFunction database function to check. databaseFunction) Implements liquibase.database.Database.generateDatabaseFunctionValue. Some function names are placeholders that need to be replaced with the specific database value.
public String	generatePrimaryKeyName(final String tableName) Implements liquibase.database.Database.generatePrimaryKeyName.
public Object	get(String key)
public boolean	getAutoCommitMode() Implements liquibase.database.Database.getAutoCommitMode. Auto-commit mode to run in
protected String	getAutoIncrementByClause()
public String	getAutoIncrementClause(final BigInteger startWith, final BigInteger incrementBy, final String generationType, final Boolean defaultOnNull) Implements liquibase.database.Database.getAutoIncrementClause. Returns database-specific auto-increment DDL clause.
protected String	getAutoIncrementClause()
protected String	getAutoIncrementClause(final String generationType, final Boolean defaultOnNull) Default implementation.
protected String	getAutoIncrementClosing()
protected String	getAutoIncrementOpening()
protected String	getAutoIncrementStartWithClause()
public String	getConcatSql(final String... values) Implements liquibase.database.Database.getConcatSql. Returns SQL to concat the passed values.
public DatabaseConnection	getConnection() Implements liquibase.database.Database.getConnection.
protected String	getConnectionCatalogName()
protected String	getConnectionSchemaName() Overwrite this method to get the default schema name for the connection.
protected SqlStatement	getConnectionSchemaNameCallStatement() Used to obtain the connection schema name through a statement Override this method to change the statement.
public DatabaseObject[]	getContainingObjects()
public String	getCurrentDateTimeFunction() Implements liquibase.database.Database.getCurrentDateTimeFunction. Returns database-specific function for generating the current date/time.
public String	getDatabaseChangeLogLockTableName() Implements liquibase.database.Database.getDatabaseChangeLogLockTableName.
public String	getDatabaseChangeLogTableName() Implements liquibase.database.Database.getDatabaseChangeLogTableName.
public int	getDatabaseMajorVersion() Implements liquibase.database.Database.getDatabaseMajorVersion.
public int	getDatabaseMinorVersion() Implements liquibase.database.Database.getDatabaseMinorVersion.
public String	getDatabaseProductName() Implements liquibase.database.Database.getDatabaseProductName. Returns the name of the database product according to the underlying database.
public String	getDatabaseProductVersion() Implements liquibase.database.Database.getDatabaseProductVersion.
public int	getDataTypeMaxParameters(final String dataTypeName) Implements liquibase.database.Database.getDataTypeMaxParameters.
public List<DatabaseFunction>	getDateFunctions() Implements liquibase.database.Database.getDateFunctions. Returns list of database native date functions
public String	getDateLiteral(final String isoDate) Implements liquibase.database.Database.getDateLiteral. Return a date literal with the same value as a string formatted using ISO 8601.
public String	getDateLiteral(final Date date) Implements liquibase.database.Database.getDateLiteral.
public String	getDateLiteral(final Date date) Implements liquibase.database.Database.getDateLiteral.
public String	getDateTimeLiteral(final Timestamp date) Implements liquibase.database.Database.getDateTimeLiteral.
public String	getDefaultCatalogName() Implements liquibase.database.Database.getDefaultCatalogName.
protected abstract String	getDefaultDatabaseProductName()
public int	Returns: the default precision / number of maximum digits in a timestamp if nothing else is specified. getDefaultFractionalDigitsForTimestamp() Implements liquibase.database.Database.getDefaultFractionalDigitsForTimestamp. SQL Standard (Foundation) says: "...if <timestamp precision> is not specified, then 6 is implicit."
public Integer	getDefaultScaleForNativeDataType(String the name of the native data type (case-insensitive). nativeDataType) Implements liquibase.database.Database.getDefaultScaleForNativeDataType. Returns the default precision for a given native data type, e.g. "datetime2" for Microsoft SQL Server.
public CatalogAndSchema	getDefaultSchema() Implements liquibase.database.Database.getDefaultSchema.
public String	getDefaultSchemaName() Implements liquibase.database.Database.getDefaultSchemaName.
public Integer	getFetchSize() Implements liquibase.database.Database.getFetchSize.
public String	getJdbcCatalogName(final CatalogAndSchema schema)
public final String	getJdbcCatalogName(final Schema schema)
public String	getJdbcSchemaName(final CatalogAndSchema schema)
public final String	getJdbcSchemaName(final Schema schema)
public String	getLineComment() Implements liquibase.database.Database.getLineComment. Returns database-specific line comment string.
public String	getLiquibaseCatalogName() Implements liquibase.database.Database.getLiquibaseCatalogName.
public String	getLiquibaseSchemaName() Implements liquibase.database.Database.getLiquibaseSchemaName.
public String	getLiquibaseTablespaceName() Implements liquibase.database.Database.getLiquibaseTablespaceName.
public int	Returns: the maximum number of supported fractional digits in TIMESTAMP columns getMaxFractionalDigitsForTimestamp() Implements liquibase.database.Database.getMaxFractionalDigitsForTimestamp. Most relational databases support 9 fractional digits, and subclasses must overwrite this method if they support less than that.
public String	getName()
public ObjectQuotingStrategy	getObjectQuotingStrategy() Implements liquibase.database.Database.getObjectQuotingStrategy.
public boolean	getOutputDefaultCatalog() Implements liquibase.database.Database.getOutputDefaultCatalog.
public boolean	getOutputDefaultSchema() Implements liquibase.database.Database.getOutputDefaultSchema. Should the schema be included in identifiers even if it is the default schema?
protected String	getQuotingEndCharacter()
protected String	getQuotingEndReplacement()
protected String	getQuotingStartCharacter()
public RanChangeSet	getRanChangeSet(final ChangeSet changeSet) Implements liquibase.database.Database.getRanChangeSet.
public List<RanChangeSet>	getRanChangeSetList() Implements liquibase.database.Database.getRanChangeSetList. Returns the ChangeSets that have been run against the current database.
public Date	getRanDate(final ChangeSet changeSet) Implements liquibase.database.Database.getRanDate.
protected String	getRawDatabaseChangeLogLockTableName() Method used by extensions to get raw dbcll table name
protected String	getRawDatabaseChangeLogTableName() Method used by extensions to get raw dbcl table name
public ChangeSet.RunStatus	getRunStatus(final ChangeSet changeSet) Implements liquibase.database.Database.getRunStatus. Returns the run status for the given ChangeSet
public CatalogAndSchema.CatalogAndSchemaCase	Returns: UPPER_CASE by default getSchemaAndCatalogCase() Implements liquibase.database.Database.getSchemaAndCatalogCase. This logic is used when db support catalogs
public CatalogAndSchema	getSchemaFromJdbcInfo(final String rawCatalogName, final String rawSchemaName)
public String	getSystemSchema() Implements liquibase.database.Database.getSystemSchema.
protected Set<String>	getSystemTables() Returns system (undroppable) views.
protected Set<String>	getSystemViews() Returns system (undroppable) views.
public String	getTimeLiteral(final Time date) Implements liquibase.database.Database.getTimeLiteral.
public String	getViewDefinition(CatalogAndSchema schema, final String viewName) Implements liquibase.database.Database.getViewDefinition.
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.
public boolean	isAutoCommit() Implements liquibase.database.Database.isAutoCommit.
public boolean	isCaseSensitive() Implements liquibase.database.Database.isCaseSensitive.
protected boolean	isCatalogOrSchemaType(Class<? extends DatabaseObject> objectType)
protected boolean	isCurrentTimeFunction(final String functionValue)
protected boolean	isDateOnly(final String value to check. isoDate) Returns true if the String conforms to an ISO 8601 date, e.g. 2016-12-31.
protected boolean	isDateTime(final String value to check. isoDate) Returns true if the String conforms to an ISO 8601 date plus a time (hours, minutes, whole seconds and optionally fraction of a second) in UTC, e.g. 2016-12-31T18:43:59.
public boolean	isDefaultCatalog(final String catalog name to be tested catalog) Implements liquibase.database.Database.isDefaultCatalog. If the database supports catalogs, test if a given catalog name equals to the default catalog of the current logged in user.
public boolean	isDefaultSchema(final String catalog name to be tested catalog, final String schema name to be tested schema) Implements liquibase.database.Database.isDefaultSchema. If the database supports schemas, test if a given combination of catalog and schema name equals to the default catalog and schema of the current logged in user.
public boolean	isFunction(final String string) Implements liquibase.database.Database.isFunction.
public boolean	isLiquibaseObject(final DatabaseObject object) Implements liquibase.database.Database.isLiquibaseObject.
public boolean	isReservedWord(final String string) Implements liquibase.database.Database.isReservedWord.
public boolean	Returns: `true` if the database connection URL contains "localhost" or "127.0.0.1", otherwise `false`. isSafeToRunUpdate() Implements liquibase.database.Database.isSafeToRunUpdate. Default implementation of the `isSafeToRunUpdate()` method.
public boolean	isSystemObject(final DatabaseObject example) Implements liquibase.database.Database.isSystemObject.
public boolean	isSystemView(CatalogAndSchema schema, final String viewName)
protected boolean	isTimeOnly(final String value to check isoDate) Returns true if the String conforms to an ISO 8601 time (hours, minutes and whole seconds) in UTC, e.g. 18:43:59.
protected boolean	isTimestamp(final String value to check isoDate) Returns true if the String conforms to an ISO 8601 date plus a timestamp (hours, minutes, seconds and at least one decimal fraction) in UTC, e.g. 2016-12-31T18:43:59.3 or 2016-12-31T18:43:59.345.
public boolean	jdbcCallsCatalogsSchemas()
public void	markChangeSetExecStatus(final ChangeSet changeSet, final ChangeSet.ExecType execType) Implements liquibase.database.Database.markChangeSetExecStatus. After the changeset has been ran against the database this method will update the change log table with the information.
protected boolean	mustQuoteObjectName(String objectName, Class<? extends DatabaseObject> objectType)
public Date	parseDate(final String dateAsString) Implements liquibase.database.Database.parseDate.
private CatalogAndSchema.CatalogAndSchemaCase	preserveCaseIfRequested()
public String	quoteObject(final String objectName, final Class<? extends DatabaseObject> objectType)
public void	removeRanStatus(final ChangeSet changeSet) Implements liquibase.database.Database.removeRanStatus.
public boolean	requiresExplicitNullForColumns() Implements liquibase.database.Database.requiresExplicitNullForColumns. Does the database require explicit NULL for nullable columns?
public boolean	requiresPassword() Implements liquibase.database.Database.requiresPassword.
public boolean	requiresUsername() Implements liquibase.database.Database.requiresUsername.
public void	resetInternalState() Implements liquibase.database.Database.resetInternalState.
public void	rollback() Implements liquibase.database.Database.rollback.
public void	saveRollbackStatement(final Change change, final List<SqlVisitor> sqlVisitors, final Writer writer) Implements liquibase.database.Database.saveRollbackStatement.
public void	saveStatements(final Change change, final List<SqlVisitor> sqlVisitors, final Writer writer) Implements liquibase.database.Database.saveStatements.
public AbstractJdbcDatabase	set(String key, Object value)
public void	setAutoCommit(final boolean b) Implements liquibase.database.Database.setAutoCommit.
public void	setCanCacheLiquibaseTableInfo(final boolean canCacheLiquibaseTableInfo) Implements liquibase.database.Database.setCanCacheLiquibaseTableInfo.
public void	setCaseSensitive(Boolean caseSensitive)
public void	setConnection(final DatabaseConnection conn) Implements liquibase.database.Database.setConnection.
public void	setCurrentDateTimeFunction(final String function) Implements liquibase.database.Database.setCurrentDateTimeFunction.
public void	setDatabaseChangeLogLockTableName(final String tableName) Implements liquibase.database.Database.setDatabaseChangeLogLockTableName. Set the table name of the change log lock to the given table name
public void	setDatabaseChangeLogTableName(final String the name of the change log table to set tableName) Implements liquibase.database.Database.setDatabaseChangeLogTableName. Sets the table name of the change log to the given table name.
public void	setDefaultCatalogName(final String defaultCatalogName) Implements liquibase.database.Database.setDefaultCatalogName.
public void	setDefaultSchemaName(final String schemaName) Implements liquibase.database.Database.setDefaultSchemaName.
public void	setLiquibaseCatalogName(final String catalogName) Implements liquibase.database.Database.setLiquibaseCatalogName.
public void	setLiquibaseSchemaName(final String schemaName) Implements liquibase.database.Database.setLiquibaseSchemaName.
public void	setLiquibaseTablespaceName(final String tablespace) Implements liquibase.database.Database.setLiquibaseTablespaceName.
public void	setObjectQuotingStrategy(final ObjectQuotingStrategy quotingStrategy) Implements liquibase.database.Database.setObjectQuotingStrategy.
public void	setOutputDefaultCatalog(final boolean outputDefaultCatalog) Implements liquibase.database.Database.setOutputDefaultCatalog.
public void	setOutputDefaultSchema(final boolean outputDefaultSchema) Implements liquibase.database.Database.setOutputDefaultSchema. Whether the default schema should be included in generated SQL
protected boolean	startsWithNumeric(final String objectName)
public boolean	supportsAutoIncrement() Implements liquibase.database.Database.supportsAutoIncrement.
public boolean	supportsBatchUpdates() Implements liquibase.database.Database.supportsBatchUpdates. Does the database support batched DML (INSERT/UPDATE/DELETE/MERGE/...) statements sent in a single call to the database?
public boolean	supportsCatalogInObjectName(final Class<? extends DatabaseObject> type) Implements liquibase.database.Database.supportsCatalogInObjectName.
public boolean	supportsCatalogs() Implements liquibase.database.Database.supportsCatalogs.
public boolean	Returns: True if the database supports DDL within a transaction, otherwise false. supportsDDLInTransaction() Implements liquibase.database.Database.supportsDDLInTransaction. Determines if the database supports DDL within a transaction or not.
public boolean	supportsDropTableCascadeConstraints() Implements liquibase.database.Database.supportsDropTableCascadeConstraints.
public boolean	supportsForeignKeyDisable() Implements liquibase.database.Database.supportsForeignKeyDisable.
public boolean	supportsNotNullConstraintNames() Implements liquibase.database.Database.supportsNotNullConstraintNames. Does this database treat NOT NULL as an own kind of CONSTRAINT (in addition of simply being a column property)?
public boolean	supportsPrimaryKeyNames() Implements liquibase.database.Database.supportsPrimaryKeyNames.
public boolean	supportsRestrictForeignKeys() Implements liquibase.database.Database.supportsRestrictForeignKeys.
public boolean	supportsSchemas() Implements liquibase.database.Database.supportsSchemas.
public boolean	supportsSequences() Implements liquibase.database.Database.supportsSequences. Does the database type support sequence.
public void	tag(final String tagString) Implements liquibase.database.Database.tag. Tags the database changelog with the given string.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.
public String	unescapeDataTypeName(String dataTypeName) Implements liquibase.database.Database.unescapeDataTypeName.
public String	unescapeDataTypeString(String dataTypeString) Implements liquibase.database.Database.unescapeDataTypeString.
public ValidationErrors	validate() Implements liquibase.database.Database.validate.

Inherited from java.lang.Object:: clone finalize getClass notify notifyAll wait wait wait

public abstract Class AbstractJdbcDatabase

Field Summary

Constructor Summary

Method Summary