Package migratedb.v1.core.internal.database.base

Class BaseDatabase

java.lang.Object

migratedb.v1.core.internal.database.base.BaseDatabase

All Implemented Interfaces:

Closeable, AutoCloseable, Database

Direct Known Subclasses:

BigQueryDatabase, CockroachDBDatabase, DB2Database, DerbyDatabase, FirebirdDatabase, H2Database, HSQLDBDatabase, IgniteThinDatabase, InformixDatabase, MySQLDatabase, OracleDatabase, PostgreSQLDatabase, RedshiftDatabase, SAPHANADatabase, SnowflakeDatabase, SpannerDatabase, SQLiteDatabase, SQLServerDatabase, SybaseASEDatabase

public abstract class BaseDatabase
extends Object
implements Database

Abstraction for database-specific functionality.

Field Summary

Fields

Modifier and Type	Field	Description
protected Configuration	configuration
protected DatabaseType	databaseType
protected JdbcConnectionFactory	jdbcConnectionFactory
protected JdbcTemplate	jdbcTemplate
protected Connection	rawMainJdbcConnection	The main JDBC connection, without any wrapping.

Constructor Summary

Constructors

Constructor	Description
BaseDatabase(Configuration configuration, JdbcConnectionFactory jdbcConnectionFactory)

Method Summary

Modifier and Type	Method	Description
void	close()
protected String	computeVersionDisplayName(Version version)	Compute the user-friendly display name for this database version.
protected Version	determineVersion()
protected String	doGetCatalog()
protected String	doGetCurrentUser()
protected abstract Session	doGetSession(Connection connection)	Retrieves a MigrateDB session for this JDBC connection.
protected String	doQuote(String identifier)	Quotes this identifier for use in SQL queries.
protected void	ensureDatabaseIsRecentEnough(String oldestSupportedVersion)
List<? extends Schema>	getAllSchemas()
String	getBaselineStatement(Table table)
String	getCatalog()
protected String	getCloseQuote()
SqlScript	getCreateScript(SqlScriptFactory sqlScriptFactory, Table table, boolean baseline)	Retrieves the script used to create the schema history table.
String	getCurrentUser()
DatabaseType	getDatabaseType()
Delimiter	getDefaultDelimiter()
protected String	getEscapedQuote()
String	getInsertStatement(Table table)
String	getInstalledBy()
DatabaseMetaData	getJdbcMetaData()
Session	getMainSession()
Session	getMigrationSession()
protected String	getOpenQuote()
String	getSelectStatement(Table table)
Version	getVersion()
String	quote(String... identifiers)	Quotes these identifiers for use in SQL queries.
protected void	recommendMigrateDbUpgradeIfNecessary(String newestSupportedVersion)
protected void	recommendMigrateDbUpgradeIfNecessaryForMajorVersion(String newestSupportedVersion)
boolean	supportsEmptyMigrationDescription()
boolean	supportsMultiStatementTransactions()
String	unQuote(String identifier)
boolean	usesSingleSession()

Methods inherited from class java.lang.Object

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

Methods inherited from interface migratedb.v1.core.api.internal.database.base.Database

catalogIsSchema, ensureSupported, getBooleanFalse, getBooleanTrue, getRawCreateScript, supportsChangingCurrentSchema, supportsDdlTransactions

Field Detail

databaseType

protected final DatabaseType databaseType

configuration

protected final Configuration configuration

jdbcConnectionFactory

protected final JdbcConnectionFactory jdbcConnectionFactory

jdbcTemplate

protected final JdbcTemplate jdbcTemplate

rawMainJdbcConnection

protected final Connection rawMainJdbcConnection

The main JDBC connection, without any wrapping.

Constructor Detail

BaseDatabase

public BaseDatabase(Configuration configuration,
                    JdbcConnectionFactory jdbcConnectionFactory)

Method Detail

doGetSession

protected abstract Session doGetSession(Connection connection)

Retrieves a MigrateDB session for this JDBC connection.

getVersion

public final Version getVersion()

Specified by:

getVersion in interface Database

Returns:

The 'major.minor' version of this database.

ensureDatabaseIsRecentEnough

protected final void ensureDatabaseIsRecentEnough(String oldestSupportedVersion)

recommendMigrateDbUpgradeIfNecessary

protected final void recommendMigrateDbUpgradeIfNecessary(String newestSupportedVersion)

recommendMigrateDbUpgradeIfNecessaryForMajorVersion

protected final void recommendMigrateDbUpgradeIfNecessaryForMajorVersion(String newestSupportedVersion)

computeVersionDisplayName

protected String computeVersionDisplayName(Version version)

Compute the user-friendly display name for this database version.

getDefaultDelimiter

public Delimiter getDefaultDelimiter()

Specified by:

getDefaultDelimiter in interface Database

getCatalog

public final String getCatalog()

Specified by:

getCatalog in interface Database

Returns:

The name of the database, by default as determined by JDBC.

doGetCatalog

protected String doGetCatalog()
                       throws SQLException

Throws:

SQLException

getCurrentUser

public final String getCurrentUser()

Specified by:

getCurrentUser in interface Database

doGetCurrentUser

protected String doGetCurrentUser()
                           throws SQLException

Throws:

SQLException

quote

public final String quote(String... identifiers)

Description copied from interface: Database

Quotes these identifiers for use in SQL queries. Multiple identifiers will be quoted and separated by a dot.

Specified by:

quote in interface Database

doQuote

protected String doQuote(String identifier)

Quotes this identifier for use in SQL queries.

getOpenQuote

protected String getOpenQuote()

getCloseQuote

protected String getCloseQuote()

getEscapedQuote

protected String getEscapedQuote()

unQuote

public String unQuote(String identifier)

Specified by:

unQuote in interface Database

usesSingleSession

public boolean usesSingleSession()

Specified by:

usesSingleSession in interface Database

Returns:

Whether a single session is used for both schema history table management and applying migrations.

getJdbcMetaData

public DatabaseMetaData getJdbcMetaData()

Specified by:

getJdbcMetaData in interface Database

getMainSession

public Session getMainSession()

Specified by:

getMainSession in interface Database

Returns:

The main session used to manipulate the schema history.

getMigrationSession

public Session getMigrationSession()

Specified by:

getMigrationSession in interface Database

Returns:

The migration session used to apply migrations.

determineVersion

protected Version determineVersion()

Returns:

The major and minor version of the database.

getCreateScript

public final SqlScript getCreateScript(SqlScriptFactory sqlScriptFactory,
                                       Table table,
                                       boolean baseline)

Description copied from interface: Database

Retrieves the script used to create the schema history table.

Specified by:

getCreateScript in interface Database

Parameters:

sqlScriptFactory - The factory used to create the SQL script.

table - The table to create.

baseline - Whether to include the creation of a baseline marker.

getInsertStatement

public String getInsertStatement(Table table)

Specified by:

getInsertStatement in interface Database

getBaselineStatement

public final String getBaselineStatement(Table table)

Specified by:

getBaselineStatement in interface Database

getSelectStatement

public String getSelectStatement(Table table)

Specified by:

getSelectStatement in interface Database

getInstalledBy

public final String getInstalledBy()

Specified by:

getInstalledBy in interface Database

close

public void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Specified by:

close in interface Database

getDatabaseType

public DatabaseType getDatabaseType()

Specified by:

getDatabaseType in interface Database

supportsEmptyMigrationDescription

public boolean supportsEmptyMigrationDescription()

Specified by:

supportsEmptyMigrationDescription in interface Database

supportsMultiStatementTransactions

public boolean supportsMultiStatementTransactions()

Specified by:

supportsMultiStatementTransactions in interface Database

getAllSchemas

public List<? extends Schema> getAllSchemas()

Specified by:

getAllSchemas in interface Database