Package migratedb.core.internal.database.cockroachdb

Class CockroachDBDatabaseType

java.lang.Object

migratedb.core.internal.database.base.BaseDatabaseType

migratedb.core.internal.database.cockroachdb.CockroachDBDatabaseType

All Implemented Interfaces:

DatabaseType

public class CockroachDBDatabaseType
extends BaseDatabaseType

Field Summary

Fields inherited from class migratedb.core.internal.database.base.BaseDatabaseType

APPLICATION_NAME, LOG

Constructor Summary

Constructors

Constructor	Description
CockroachDBDatabaseType()

Method Summary

Modifier and Type	Method	Description
Database<?>	createDatabase(Configuration configuration, JdbcConnectionFactory jdbcConnectionFactory)	Initializes the Database used by this Database Type.
DatabaseExecutionStrategy	createExecutionStrategy(Connection connection)	Initializes the DatabaseExecutionStrategy used by this Database Type.
BaseParser	createParser(Configuration configuration, ResourceProvider resourceProvider, ParsingContext parsingContext)	Initializes the Parser used by this Database Type.
ExecutionTemplate	createTransactionalExecutionTemplate(Connection connection, boolean rollbackOnException)	Initializes the ExecutionTemplate used by this Database Type.
boolean	detectPasswordRequiredByUrl(String url)	Detects whether a password is required from configuration.
boolean	detectUserRequiredByUrl(String url)	Detects whether a user is required from configuration.
boolean	externalAuthPropertiesRequired(String url, String username, String password)	Detects whether or not external authentication is required.
String	getDriverClass(String url, ClassLoader classLoader)	Get the driver class used to handle this JDBC url.
Properties	getExternalAuthProperties(String url, String username)
String	getName()
int	getNullType()
int	getPriority()	When identifying database types, the priority with which this type will be used.
boolean	handlesDatabaseProductNameAndVersion(String databaseProductName, String databaseProductVersion, Connection connection)	This allows more fine-grained control over which DatabaseType handles which connection.
boolean	handlesJDBCUrl(String url)	Whether this database type should handle the given JDBC url.
void	modifyDefaultConnectionProps(String url, Properties props, ClassLoader classLoader)	Set the default connection properties for this database.

Methods inherited from class migratedb.core.internal.database.base.BaseDatabaseType

alterConnectionAsNeeded, createDatabase, createSqlScriptExecutorFactory, createSqlScriptFactory, getBackupDriverClass, getDefaultJDBCCredentialsPattern, getJDBCCredentialsPattern, getSelectVersionOutput, instantiateClassExtendedErrorMessage, modifyConfigConnectionProps, modifyOverridingConnectionProps, shutdownDatabase, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

CockroachDBDatabaseType

public CockroachDBDatabaseType()

Method Detail

getName

public String getName()

Specified by:

getName in interface DatabaseType

Specified by:

getName in class BaseDatabaseType

Returns:

The human-readable name for this database.

getNullType

public int getNullType()

Specified by:

getNullType in interface DatabaseType

Specified by:

getNullType in class BaseDatabaseType

Returns:

The JDBC type used to represent null in prepared statements.

handlesJDBCUrl

public boolean handlesJDBCUrl(String url)

Description copied from class: BaseDatabaseType

Whether this database type should handle the given JDBC url.

Specified by:

handlesJDBCUrl in interface DatabaseType

Specified by:

handlesJDBCUrl in class BaseDatabaseType

Parameters:

url - The JDBC url.

Returns:

true if this handles the JDBC url, false if not.

getPriority

public int getPriority()

Description copied from class: BaseDatabaseType

When identifying database types, the priority with which this type will be used. High numbers indicate that this type will be used in preference to others.

Specified by:

getPriority in interface DatabaseType

Overrides:

getPriority in class BaseDatabaseType

getDriverClass

public String getDriverClass(String url,
                             ClassLoader classLoader)

Description copied from interface: DatabaseType

Get the driver class used to handle this JDBC url. This will only be called if matchesJDBCUrl previously returned true.

Specified by:

getDriverClass in interface DatabaseType

Specified by:

getDriverClass in class BaseDatabaseType

Parameters:

url - The JDBC url.

classLoader - The classLoader to check for driver classes.

Returns:

The full driver class name to be instantiated to handle this url.

handlesDatabaseProductNameAndVersion

public boolean handlesDatabaseProductNameAndVersion(String databaseProductName,
                                                    String databaseProductVersion,
                                                    Connection connection)

Description copied from class: BaseDatabaseType

This allows more fine-grained control over which DatabaseType handles which connection. MigrateDB will use the first DatabaseType that returns true for this method.

Specified by:

handlesDatabaseProductNameAndVersion in interface DatabaseType

Specified by:

handlesDatabaseProductNameAndVersion in class BaseDatabaseType

Parameters:

databaseProductName - The product name returned by the database.

databaseProductVersion - The product version returned by the database.

connection - The connection used to connect to the database.

Returns:

true if this handles the product name and version, false if not.

createDatabase

public Database<?> createDatabase(Configuration configuration,
                                  JdbcConnectionFactory jdbcConnectionFactory)

Description copied from interface: DatabaseType

Initializes the Database used by this Database Type.

Specified by:

createDatabase in interface DatabaseType

Specified by:

createDatabase in class BaseDatabaseType

Parameters:

configuration - The MigrateDB configuration.

jdbcConnectionFactory - The current connection factory.

Returns:

The Database.

createParser

public BaseParser createParser(Configuration configuration,
                               ResourceProvider resourceProvider,
                               ParsingContext parsingContext)

Description copied from interface: DatabaseType

Initializes the Parser used by this Database Type.

Specified by:

createParser in interface DatabaseType

Specified by:

createParser in class BaseDatabaseType

Parameters:

configuration - The MigrateDB configuration.

Returns:

The Parser.

createExecutionStrategy

public DatabaseExecutionStrategy createExecutionStrategy(Connection connection)

Description copied from interface: DatabaseType

Initializes the DatabaseExecutionStrategy used by this Database Type.

Specified by:

createExecutionStrategy in interface DatabaseType

Overrides:

createExecutionStrategy in class BaseDatabaseType

Returns:

The DatabaseExecutionStrategy.

createTransactionalExecutionTemplate

public ExecutionTemplate createTransactionalExecutionTemplate(Connection connection,
                                                              boolean rollbackOnException)

Description copied from interface: DatabaseType

Initializes the ExecutionTemplate used by this Database Type.

Specified by:

createTransactionalExecutionTemplate in interface DatabaseType

Overrides:

createTransactionalExecutionTemplate in class BaseDatabaseType

Returns:

The ExecutionTemplate.

modifyDefaultConnectionProps

public void modifyDefaultConnectionProps(String url,
                                         Properties props,
                                         ClassLoader classLoader)

Description copied from class: BaseDatabaseType

Set the default connection properties for this database. These can be overridden by setConfigConnectionProps and setOverridingConnectionProps.

Specified by:

modifyDefaultConnectionProps in interface DatabaseType

Overrides:

modifyDefaultConnectionProps in class BaseDatabaseType

Parameters:

url - The JDBC url.

props - The properties to write to.

classLoader - The classLoader to use.

detectUserRequiredByUrl

public boolean detectUserRequiredByUrl(String url)

Description copied from class: BaseDatabaseType

Detects whether a user is required from configuration. This may not be the case if the driver supports other authentication mechanisms, or supports the user being encoded in the URL.

Specified by:

detectUserRequiredByUrl in interface DatabaseType

Overrides:

detectUserRequiredByUrl in class BaseDatabaseType

Parameters:

url - The url to check

Returns:

true if a username needs to be provided

detectPasswordRequiredByUrl

public boolean detectPasswordRequiredByUrl(String url)

Description copied from class: BaseDatabaseType

Detects whether a password is required from configuration. This may not be the case if the driver supports other authentication mechanisms, or supports the password being encoded in the URL.

Specified by:

detectPasswordRequiredByUrl in interface DatabaseType

Overrides:

detectPasswordRequiredByUrl in class BaseDatabaseType

Parameters:

url - The url to check

Returns:

true if a password needs to be provided

externalAuthPropertiesRequired

public boolean externalAuthPropertiesRequired(String url,
                                              String username,
                                              String password)

Description copied from interface: DatabaseType

Detects whether or not external authentication is required.

Specified by:

externalAuthPropertiesRequired in interface DatabaseType

Overrides:

externalAuthPropertiesRequired in class BaseDatabaseType

Returns:

true if external authentication is required, else false.

getExternalAuthProperties

public Properties getExternalAuthProperties(String url,
                                            String username)

Specified by:

getExternalAuthProperties in interface DatabaseType

Overrides:

getExternalAuthProperties in class BaseDatabaseType

Parameters:

url - The JDBC url.

username - The username for the connection.

Returns:

Authentication properties from database specific locations (e.g. pgpass)