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

Field Summary

Fields

Modifier and Type	Field	Description
protected DatabaseConnector	connector
protected Map<String,Object>	customHints
protected DatabaseEntryUtils	databaseEntryUtils
protected MigrationSupport	migrationSupport
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()
boolean	create()
void	createBeans(BiConsumer<Object,Boolean> successConsumer)	Do not use this if you're using Migrations, call #migrate(List, BiConsumer) instead.
DBTransaction	createTransaction()
DBTransaction	createTransaction(Consumer<DBTransaction.TransactionCustomizer> customizer)
Database	drop()
boolean	exists()
protected final Database	getDatabase()
String	getDatabaseName()
Database	initMigrationSupport()
Database	initMigrationSupport(boolean force)
OptionalInt	migrate(List<DatabaseMigration> migrations, BiConsumer<Object,Boolean> successConsumer, EnumSet<MigrationOption> allowedOptions)
Database	register(SQLQueryable<?>... instances)
Database	registerTable(AbstractDBTable<?>... table)
Database	registerView(AbstractDBView<?>... view)
Database	scanFromBeans()
void	setDatabaseStructure(DatabaseStructure databaseStructure)
void	setMigrationSchemaName(String migrationSchemaName)
Database	setMigrationSupport(boolean value)
void	setMigrationSupport(MigrationSupport migrationSupport)
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

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

migrationSupport

protected MigrationSupport migrationSupport

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

setMigrationSupport

public Database setMigrationSupport(boolean value)

initMigrationSupport

public Database initMigrationSupport()

initMigrationSupport

public Database initMigrationSupport(boolean force)

migrate

public OptionalInt migrate(List<DatabaseMigration> migrations,
 BiConsumer<Object,Boolean> successConsumer,
 EnumSet<MigrationOption> allowedOptions)

clearBeans

public Database clearBeans()

registerTable

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

registerView

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

register

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

scanFromBeans

public Database scanFromBeans()

setDatabaseStructure

public void setDatabaseStructure(DatabaseStructure databaseStructure)

createBeans

public void createBeans(BiConsumer<Object,Boolean> successConsumer)
                 throws DBException

Do not use this if you're using Migrations, call #migrate(List, BiConsumer) instead.

Throws:

DBException

create

public boolean create()
               throws DBException

Throws:

DBException

createTransaction

public DBTransaction createTransaction()

createTransaction

public DBTransaction createTransaction(Consumer<DBTransaction.TransactionCustomizer> customizer)

drop

public Database drop()
              throws DBException

Throws:

DBException

exists

public boolean exists()
               throws DBException

Throws:

DBException

setMigrationSchemaName

public void setMigrationSchemaName(String migrationSchemaName)

setMigrationSupport

public void setMigrationSupport(MigrationSupport migrationSupport)

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()

getDatabaseName

public String getDatabaseName()

toString

public String toString()

Overrides:

toString in class Object