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

Class BaseSession

java.lang.Object

migratedb.v1.core.internal.database.base.BaseSession

All Implemented Interfaces:

AutoCloseable, Session

Direct Known Subclasses:

BigQuerySession, CockroachDBSession, DB2Session, DerbySession, FirebirdSession, H2Session, HSQLDBSession, IgniteThinSession, InformixSession, MySQLSession, OracleSession, PostgreSQLSession, RedshiftSession, SAPHANASession, SnowflakeSession, SpannerSession, SQLiteSession, SQLServerSession, SybaseASESession

public abstract class BaseSession
extends Object
implements Session

Field Summary

Fields

Modifier and Type	Field	Description
protected JdbcTemplate	jdbcTemplate
protected String	originalSchemaNameOrSearchPath

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	BaseSession(Database database, Connection connection)

Method Summary

Modifier and Type	Method	Description
void	changeCurrentSchemaTo(Schema schema)	Sets the current schema, which is the default owner of new database objects.
void	close()
protected void	doChangeCurrentSchemaOrSearchPathTo(String schemaNameOrSearchPath)
protected Schema	doGetCurrentSchema()
protected void	doRestoreOriginalState()
Schema	getCurrentSchema()	Retrieves the current schema, which is the default owner of new database objects.
protected abstract String	getCurrentSchemaNameOrSearchPath()
Database	getDatabase()
Connection	getJdbcConnection()
JdbcTemplate	getJdbcTemplate()
<T> T	lock(Table table, Callable<T> callable)	Locks this table and executes this callable.
void	restoreOriginalState()	Undoes all changes to database settings and variables whose scope is bound to the lifetime of the JDBC connection.

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.Session

getSchema

Field Detail

jdbcTemplate

protected JdbcTemplate jdbcTemplate

originalSchemaNameOrSearchPath

protected final String originalSchemaNameOrSearchPath

Constructor Detail

BaseSession

protected BaseSession(Database database,
                      Connection connection)

Method Detail

getCurrentSchemaNameOrSearchPath

protected abstract String getCurrentSchemaNameOrSearchPath()
                                                    throws SQLException

Throws:

SQLException - when the current schema name or search path could not be retrieved.

getCurrentSchema

public Schema getCurrentSchema()

Description copied from interface: Session

Retrieves the current schema, which is the default owner of new database objects. In many databases, the current schema is also used to lookup tables whenever the schema qualifier is omitted.

Specified by:

getCurrentSchema in interface Session

doGetCurrentSchema

protected Schema doGetCurrentSchema()
                             throws SQLException

Throws:

SQLException

changeCurrentSchemaTo

public void changeCurrentSchemaTo(Schema schema)

Description copied from interface: Session

Sets the current schema, which is the default owner of new database objects. In many databases, the current schema is also used to lookup tables whenever the schema qualifier is omitted.

Specified by:

changeCurrentSchemaTo in interface Session

doChangeCurrentSchemaOrSearchPathTo

protected void doChangeCurrentSchemaOrSearchPathTo(String schemaNameOrSearchPath)
                                            throws SQLException

Parameters:

schemaNameOrSearchPath - The new current schema for this connection.

Throws:

SQLException - when the current schema could not be set.

lock

public <T> T lock(Table table,
                  Callable<T> callable)

Description copied from interface: Session

Locks this table and executes this callable.

Specified by:

lock in interface Session

Returns:

The result of the callable.

getJdbcTemplate

public final JdbcTemplate getJdbcTemplate()

Specified by:

getJdbcTemplate in interface Session

close

public final void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Session

restoreOriginalState

public final void restoreOriginalState()

Description copied from interface: Session

Undoes all changes to database settings and variables whose scope is bound to the lifetime of the JDBC connection. An example of such state is the search_path setting of PostgreSQL. Methods that may change state are:

• Session.changeCurrentSchemaTo(Schema)
• Session.lock(Table, Callable)

Will only undo changes that have been made through this object. Changes made by migration scripts are not accounted for.

Specified by:

restoreOriginalState in interface Session

doRestoreOriginalState

protected void doRestoreOriginalState()
                               throws SQLException

Throws:

SQLException

getJdbcConnection

public final Connection getJdbcConnection()

Specified by:

getJdbcConnection in interface Session

getDatabase

public Database getDatabase()