Package migratedb.core.internal.database.bigquery

Class BigQueryDatabaseType

java.lang.Object

migratedb.core.internal.database.base.BaseDatabaseType

migratedb.core.internal.database.bigquery.BigQueryDatabaseType

All Implemented Interfaces:

DatabaseType

public class BigQueryDatabaseType
extends BaseDatabaseType

Field Summary

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

APPLICATION_NAME, LOG

Constructor Summary

Constructors

Constructor	Description
BigQueryDatabaseType()

Method Summary

Modifier and Type	Method	Description
Database<?>	createDatabase(Configuration configuration, JdbcConnectionFactory jdbcConnectionFactory)	Initializes the Database used by this Database Type.
BaseParser	createParser(Configuration configuration, ResourceProvider resourceProvider, ParsingContext parsingContext)	Initializes the Parser used by this Database Type.
String	getBackupDriverClass(String url, ClassLoader classLoader)	Retrieves a second choice backup driver for a JDBC url, in case the one returned by getDriverClass is not available.
String	getDriverClass(String url, ClassLoader classLoader)	Get the driver class used to handle this JDBC url.
Pattern	getJDBCCredentialsPattern()	A regex that identifies credentials in the JDBC URL, where they conform to a pattern specific to this database.
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.
String	instantiateClassExtendedErrorMessage()
void	modifyOverridingConnectionProps(Map<String,String> props)	These will override anything set by setDefaultConnectionProps and setConfigConnectionProps and should only be used if neither of those can satisfy your requirement.

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

alterConnectionAsNeeded, createDatabase, createExecutionStrategy, createSqlScriptExecutorFactory, createSqlScriptFactory, createTransactionalExecutionTemplate, detectPasswordRequiredByUrl, detectUserRequiredByUrl, externalAuthPropertiesRequired, getDefaultJDBCCredentialsPattern, getExternalAuthProperties, getSelectVersionOutput, modifyConfigConnectionProps, modifyDefaultConnectionProps, shutdownDatabase, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

BigQueryDatabaseType

public BigQueryDatabaseType()

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.

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

getJDBCCredentialsPattern

public Pattern getJDBCCredentialsPattern()

Description copied from class: BaseDatabaseType

A regex that identifies credentials in the JDBC URL, where they conform to a pattern specific to this database. The first captured group should represent the password text, so that it can be redacted if necessary.

Specified by:

getJDBCCredentialsPattern in interface DatabaseType

Overrides:

getJDBCCredentialsPattern in class BaseDatabaseType

Returns:

The URL regex.

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.

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.

getBackupDriverClass

public String getBackupDriverClass(String url,
                                   ClassLoader classLoader)

Description copied from class: BaseDatabaseType

Retrieves a second choice backup driver for a JDBC url, in case the one returned by getDriverClass is not available.

Specified by:

getBackupDriverClass in interface DatabaseType

Overrides:

getBackupDriverClass in class BaseDatabaseType

Parameters:

url - The JDBC url.

classLoader - The classLoader to check for driver classes.

Returns:

The JDBC driver class name, null if none.

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.

modifyOverridingConnectionProps

public void modifyOverridingConnectionProps(Map<String,String> props)

Description copied from class: BaseDatabaseType

These will override anything set by setDefaultConnectionProps and setConfigConnectionProps and should only be used if neither of those can satisfy your requirement.

Specified by:

modifyOverridingConnectionProps in interface DatabaseType

Overrides:

modifyOverridingConnectionProps in class BaseDatabaseType

Parameters:

props - The properties to write to.

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.

instantiateClassExtendedErrorMessage

public String instantiateClassExtendedErrorMessage()

Specified by:

instantiateClassExtendedErrorMessage in interface DatabaseType

Overrides:

instantiateClassExtendedErrorMessage in class BaseDatabaseType

Returns:

A hint on the requirements for creating database instances (libs on class path, etc.)