com.djrapitops.plan.db

Interface Database

All Known Implementing Classes:

AbstractDatabase, H2DB, MySQLDB, SQLDB, SQLiteDB

public interface Database

Interface for interacting with a Plan SQL database.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Database.State

Method Summary

Modifier and Type	Method and Description
void	close()
java.util.concurrent.Future<?>	executeTransaction(Transaction transaction) Execute an SQL Transaction.
Database.State	getState()
DBType	getType() Used to get the DBType of the Database
void	init() Initializes the Database.
<T> T	query(Query<T> query) Execute an SQL Query statement to get a result.

Method Detail

init

void init()

Initializes the Database.

Queries can be performed after this request has completed all required transactions for the database operations.

Throws:

DBInitException - if Database fails to initiate.

close

void close()

query

<T> T query(Query<T> query)

Execute an SQL Query statement to get a result.

This method should only be called from an asynchronous thread.

Type Parameters:

T - Type of the object to be returned.

Parameters:

query - QueryStatement to execute.

Returns:

Result of the query.

executeTransaction

java.util.concurrent.Future<?> executeTransaction(Transaction transaction)

Execute an SQL Transaction.

Parameters:

transaction - Transaction to execute.

Returns:

Future that is finished when the transaction has been executed.

getType

DBType getType()

Used to get the DBType of the Database

Returns:

the DBType

See Also:

DBType

getState

Database.State getState()