Package liquibase.database.core

Class CockroachDatabase

java.lang.Object

liquibase.database.AbstractJdbcDatabase

liquibase.database.core.AbstractPostgresDatabase

liquibase.database.core.PostgresDatabase

liquibase.database.core.CockroachDatabase

All Implemented Interfaces:

AutoCloseable, Database, PrioritizedService

public class CockroachDatabase
extends PostgresDatabase

Field Summary

Fields inherited from class liquibase.database.core.PostgresDatabase

MINIMUM_DBMS_MAJOR_VERSION, MINIMUM_DBMS_MINOR_VERSION, PRODUCT_NAME, VALID_AUTO_INCREMENT_COLUMN_TYPE_NAMES

Fields inherited from class liquibase.database.AbstractJdbcDatabase

caseSensitive, currentDateTimeFunction, dateFunctions, defaultAutoIncrementBy, defaultAutoIncrementStartWith, defaultCatalogName, defaultSchemaName, quotingStrategy, sequenceCurrentValueFunction, sequenceNextValueFunction, unmodifiableDataTypes, unquotedObjectsAreUppercased

Fields inherited from interface liquibase.database.Database

COMPLETE_SQL_SCOPE_KEY, IGNORE_MISSING_REFERENCES_KEY

Fields inherited from interface liquibase.servicelocator.PrioritizedService

COMPARATOR, PRIORITY_DATABASE, PRIORITY_DEFAULT

Constructor Summary

Constructors

Constructor	Description
CockroachDatabase()

Method Summary

Modifier and Type	Method	Description
int	getDatabaseMajorVersion()
int	getDatabaseMinorVersion()
protected String	getDefaultDatabaseProductName()
Integer	getDefaultPort()
int	getPriority()
String	getShortName()	Returns an all-lower-case short name of the product.
boolean	isCorrectDatabaseImplementation(DatabaseConnection conn)	Checks if the given connection points to a CockroachDB database.
void	setConnection(DatabaseConnection conn)
boolean	supportsCompositeTypeSnapshot()	The standard composite-type snapshot generator reads composite types via pg_type/ typrelid, which CockroachDB does not populate for user-defined composite types, so it must not be treated as real PostgreSQL for composite-type snapshotting.
boolean	supportsCreateIfNotExists(Class<? extends DatabaseObject> type)	Does the database support the "if not exits" syntax?
boolean	supportsDDLInTransaction()	Determines if the database supports DDL within a transaction or not.
boolean	supportsInitiallyDeferrableColumns()	Returns whether this database support initially deferrable columns.
boolean	supportsStoredLogicSnapshot()	CockroachDB does not expose the stored-logic catalog the standard generators rely on.
boolean	supportsTablespaces()
boolean	useSerialDatatypes()

Methods inherited from class liquibase.database.core.PostgresDatabase

equals, generateAutoIncrementBy, generateAutoIncrementStartWith, generatePrimaryKeyName, getAutoIncrementClause, getAutoIncrementClause, getDefaultDriver, getMaxFractionalDigitsForTimestamp, hashCode, restoreSearchPath, rollback, saveSearchPath, supportsCheckConstraintSnapshot, supportsDatabaseChangeLogHistory, supportsEnumTypeSnapshot, supportsSequences

Methods inherited from class liquibase.database.core.AbstractPostgresDatabase

correctObjectName, escapeObjectName, getConnectionSchemaNameCallStatement, getDatabaseChangeLogLockTableName, getDatabaseChangeLogTableName, getSchemaAndCatalogCase, getSystemViews, hasMixedCase, isReservedWord, isSystemObject, setDefaultCatalogName, supportsCatalogInObjectName, unescapeDataTypeName

Methods inherited from class liquibase.database.AbstractJdbcDatabase

addReservedWords, canCreateChangeLogTable, close, commit, correctSchema, correctSchema, createsIndexesForForeignKeys, dataTypeIsNotModifiable, disableForeignKeyChecks, doesTagExist, dropDatabaseObjects, enableForeignKeyChecks, escapeColumnName, escapeColumnName, escapeColumnNameList, escapeConstraintName, escapeDataTypeName, escapeIndexName, escapeObjectName, escapeSequenceName, escapeStringForDatabase, escapeTableName, escapeViewName, execute, executeRollbackStatements, executeRollbackStatements, executeStatements, filterRollbackVisitors, generateDatabaseFunctionValue, get, getAutoCommitMode, getAutoIncrementByClause, getAutoIncrementClause, getAutoIncrementClosing, getAutoIncrementOpening, getAutoIncrementStartWithClause, getConcatSql, getConnection, getConnectionCatalogName, getConnectionSchemaName, getContainingObjects, getCurrentDateTimeFunction, getDatabaseProductName, getDatabaseProductVersion, getDataTypeMaxParameters, getDateFunctions, getDateLiteral, getDateLiteral, getDateLiteral, getDateTimeLiteral, getDefaultCatalogName, getDefaultFractionalDigitsForTimestamp, getDefaultScaleForNativeDataType, getDefaultSchema, getDefaultSchemaName, getFetchSize, getJdbcCatalogName, getJdbcCatalogName, getJdbcSchemaName, getJdbcSchemaName, getLineComment, getLiquibaseCatalogName, getLiquibaseSchemaName, getLiquibaseTablespaceName, getName, getObjectQuotingStrategy, getOutputDefaultCatalog, getOutputDefaultSchema, getQuotingEndCharacter, getQuotingEndReplacement, getQuotingStartCharacter, getRanChangeSet, getRanChangeSetList, getRanDate, getRawDatabaseChangeLogLockTableName, getRawDatabaseChangeLogTableName, getRunStatus, getSchemaFromJdbcInfo, getSystemSchema, getSystemTables, getTimeLiteral, getViewDefinition, isAutoCommit, isCaseSensitive, isCatalogOrSchemaType, isCurrentTimeFunction, isDateOnly, isDateTime, isDefaultCatalog, isDefaultSchema, isFunction, isLiquibaseObject, isSafeToRunUpdate, isSystemView, isTimeOnly, isTimestamp, jdbcCallsCatalogsSchemas, markChangeSetExecStatus, mustQuoteObjectName, parseDate, quoteObject, removeRanStatus, requiresExplicitNullForColumns, requiresPassword, requiresUsername, resetInternalState, saveRollbackStatement, saveStatements, set, setAutoCommit, setCanCacheLiquibaseTableInfo, setCaseSensitive, setCurrentDateTimeFunction, setDatabaseChangeLogLockTableName, setDatabaseChangeLogTableName, setDefaultSchemaName, setLiquibaseCatalogName, setLiquibaseSchemaName, setLiquibaseTablespaceName, setObjectQuotingStrategy, setOutputDefaultCatalog, setOutputDefaultSchema, setPreviousAutoCommit, startsWithNumeric, supportsAutoIncrement, supportsBatchUpdates, supportsCatalogs, supportsDropTableCascadeConstraints, supportsForeignKeyDisable, supportsNotNullConstraintNames, supportsPrimaryKeyNames, supportsRestrictForeignKeys, supportsSchemas, tag, toString, unescapeDataTypeString, validate

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface liquibase.database.Database

addCompleteSqlToScope, afterUpdate, checkDatabaseConnection, dropDatabaseObjects, escapeForLike, escapeTablespaceName, failOnDefferable, generateConnectCommandSuccessMessage, getDisplayName, supports, temporarilySetObjectQuotingStrategy

Constructor Details

CockroachDatabase

public CockroachDatabase()

Method Details

getPriority

public int getPriority()

Specified by:

getPriority in interface PrioritizedService

Overrides:

getPriority in class PostgresDatabase

getShortName

public String getShortName()

Description copied from interface: Database

Returns an all-lower-case short name of the product. Used for end-user selecting of database type such as the DBMS precondition.

Specified by:

getShortName in interface Database

Overrides:

getShortName in class PostgresDatabase

getDefaultDatabaseProductName

protected String getDefaultDatabaseProductName()

Overrides:

getDefaultDatabaseProductName in class PostgresDatabase

getDatabaseMajorVersion

public int getDatabaseMajorVersion()
                            throws DatabaseException

Specified by:

getDatabaseMajorVersion in interface Database

Overrides:

getDatabaseMajorVersion in class AbstractJdbcDatabase

Throws:

DatabaseException

getDatabaseMinorVersion

public int getDatabaseMinorVersion()
                            throws DatabaseException

Specified by:

getDatabaseMinorVersion in interface Database

Overrides:

getDatabaseMinorVersion in class AbstractJdbcDatabase

Throws:

DatabaseException

isCorrectDatabaseImplementation

public boolean isCorrectDatabaseImplementation(DatabaseConnection conn)
                                        throws DatabaseException

Checks if the given connection points to a CockroachDB database.

Returns false early if the URL is null (which can happen with some JDBC drivers like IBM Informix), since a null URL cannot match any database type.

Specified by:

isCorrectDatabaseImplementation in interface Database

Overrides:

isCorrectDatabaseImplementation in class PostgresDatabase

Parameters:

conn - the database connection to check

Returns:

true if this is a CockroachDB connection, false otherwise

Throws:

DatabaseException - if there is an error querying the database

getDefaultPort

public Integer getDefaultPort()

Specified by:

getDefaultPort in interface Database

Overrides:

getDefaultPort in class PostgresDatabase

supportsInitiallyDeferrableColumns

public boolean supportsInitiallyDeferrableColumns()

Description copied from interface: Database

Returns whether this database support initially deferrable columns.

Specified by:

supportsInitiallyDeferrableColumns in interface Database

Overrides:

supportsInitiallyDeferrableColumns in class PostgresDatabase

supportsTablespaces

public boolean supportsTablespaces()

Specified by:

supportsTablespaces in interface Database

Overrides:

supportsTablespaces in class PostgresDatabase

supportsDDLInTransaction

public boolean supportsDDLInTransaction()

Description copied from class: AbstractJdbcDatabase

Determines if the database supports DDL within a transaction or not.

Specified by:

supportsDDLInTransaction in interface Database

Overrides:

supportsDDLInTransaction in class AbstractJdbcDatabase

Returns:

True if the database supports DDL within a transaction, otherwise false.

setConnection

public void setConnection(DatabaseConnection conn)

Specified by:

setConnection in interface Database

Overrides:

setConnection in class PostgresDatabase

useSerialDatatypes

public boolean useSerialDatatypes()

Overrides:

useSerialDatatypes in class AbstractPostgresDatabase

supportsCreateIfNotExists

public boolean supportsCreateIfNotExists(Class<? extends DatabaseObject> type)

Description copied from interface: Database

Does the database support the "if not exits" syntax?

Specified by:

supportsCreateIfNotExists in interface Database

Overrides:

supportsCreateIfNotExists in class PostgresDatabase

Parameters:

type - the DatabaseObject type to be checked.

Returns:

true if the "if not exists" syntax is supported, false otherwise.

supportsCompositeTypeSnapshot

public boolean supportsCompositeTypeSnapshot()

The standard composite-type snapshot generator reads composite types via pg_type/ typrelid, which CockroachDB does not populate for user-defined composite types, so it must not be treated as real PostgreSQL for composite-type snapshotting. Opts down from PostgresDatabase.

Overrides:

supportsCompositeTypeSnapshot in class PostgresDatabase

Returns:

true if composite types on this database are snapshot-able via the standard generator

supportsStoredLogicSnapshot

public boolean supportsStoredLogicSnapshot()

CockroachDB does not expose the stored-logic catalog the standard generators rely on. Opts down from PostgresDatabase.

Overrides:

supportsStoredLogicSnapshot in class PostgresDatabase

Returns:

true if stored logic on this database is snapshot-able via the standard generators