Package lu.kbra.pclib.db.base

Class Database

java.lang.Object

lu.kbra.pclib.db.base.Database

Direct Known Subclasses:

DeferredDatabase

public class Database
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	Database.AbstractTableTransaction

Field Summary

Fields

Modifier and Type	Field	Description
protected DatabaseConnector	connector
protected Map<String,Object>	customHints
protected DatabaseEntryUtils	databaseEntryUtils
protected final String	databaseName
protected String	migrationSchemaName
protected DatabaseStructure	structure
protected final List<AbstractDBTable<? extends DatabaseEntry>>	tables
protected final List<AbstractDBView<? extends DatabaseEntry>>	views

Constructor Summary

Constructors

Constructor	Description
Database(DatabaseConnector connector, String name)
Database(DatabaseConnector connector, String name, Map<String,Object> customHints, DatabaseEntryUtils dbEntryUtils)
Database(DatabaseConnector connector, String name, DatabaseEntryUtils dbEntryUtils)

Method Summary

Modifier and Type	Method	Description
Database	clearBeans()
DatabaseStatus	create()
DBTransaction	createTransaction()
Database	drop()
boolean	exists()
protected final Database	getDatabase()
int	migrate(Collection<? extends DatabaseMigration> migrations)
int	migrate(Collection<? extends DatabaseMigration> migrations, Collection<? extends AbstractDBTable<?>> tables, SchemaMigrationOptions schemaOptions)
int	migrate(Collection<? extends DatabaseMigration> migrations, SchemaMigrationOptions options)
void	migrateSchemas(Collection<? extends AbstractDBTable<?>> tables, SchemaMigrationOptions schemaOptions)
Database	register(SQLQueryable<?>... instances)
Database	registerTable(AbstractDBTable<?>... table)
Database	registerView(AbstractDBView<?>... view)
void	scanFromBeans()
void	setDatabaseStructure(DatabaseStructure databaseStructure)
void	setMigrationSchemaName(String migrationSchemaName)
String	toString()
void	updateDatabaseConnector()
AbstractConnection	use()
protected void	validateStructure()

Methods inherited from class java.lang.Object

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

Field Details

connector

protected DatabaseConnector connector

databaseEntryUtils

protected DatabaseEntryUtils databaseEntryUtils

databaseName

protected final String databaseName

migrationSchemaName

protected String migrationSchemaName

structure

protected DatabaseStructure structure

tables

protected final List<AbstractDBTable<? extends DatabaseEntry>> tables

views

protected final List<AbstractDBView<? extends DatabaseEntry>> views

customHints

protected Map<String,Object> customHints

Constructor Details

Database

public Database(DatabaseConnector connector,
 String name)

Database

public Database(DatabaseConnector connector,
 String name,
 DatabaseEntryUtils dbEntryUtils)

Database

public Database(DatabaseConnector connector,
 String name,
 Map<String,Object> customHints,
 DatabaseEntryUtils dbEntryUtils)

Method Details

clearBeans

public Database clearBeans()

registerTable

public Database registerTable(AbstractDBTable<?>... table)

registerView

public Database registerView(AbstractDBView<?>... view)

register

public Database register(SQLQueryable<?>... instances)

scanFromBeans

public void scanFromBeans()

setDatabaseStructure

public void setDatabaseStructure(DatabaseStructure databaseStructure)

create

public DatabaseStatus create()
                      throws DBException

Throws:

DBException

createTransaction

public DBTransaction createTransaction()

drop

public Database drop()
              throws DBException

Throws:

DBException

exists

public boolean exists()
               throws DBException

Throws:

DBException

migrate

@ExperimentalApi
public int migrate(Collection<? extends DatabaseMigration> migrations)
            throws DBException

Throws:

DBException

migrate

@ExperimentalApi
public int migrate(Collection<? extends DatabaseMigration> migrations,
 SchemaMigrationOptions options)
            throws DBException

Throws:

DBException

migrate

@ExperimentalApi
public int migrate(Collection<? extends DatabaseMigration> migrations,
 Collection<? extends AbstractDBTable<?>> tables,
 SchemaMigrationOptions schemaOptions)
            throws DBException

Throws:

DBException

migrateSchemas

@ExperimentalApi
public void migrateSchemas(Collection<? extends AbstractDBTable<?>> tables,
 SchemaMigrationOptions schemaOptions)
                    throws DBException

Throws:

DBException

setMigrationSchemaName

public void setMigrationSchemaName(String migrationSchemaName)

updateDatabaseConnector

public void updateDatabaseConnector()
                             throws DBException

Throws:

DBException

use

public AbstractConnection use()
                       throws DBException

Throws:

DBException

getDatabase

protected final Database getDatabase()

validateStructure

protected void validateStructure()

toString

public String toString()

Overrides:

toString in class Object