ra.db

Interface DatabaseConnection

All Superinterfaces:

java.lang.AutoCloseable

All Known Subinterfaces:

KeepAvailable

All Known Implementing Classes:

ConcurrentConnection, OnceConnection, OriginalConnection

public interface DatabaseConnection
extends java.lang.AutoCloseable

Database Connection.

Author:

Ray Li

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	DatabaseConnection.ConnectionFunction Get current database connection.

Method Summary

Modifier and Type	Method and Description
boolean	connect() Get the connection state.
default boolean	connectIf(java.util.function.Consumer<StatementExecutor> executor) If database connection connected return StatementExecutor.
default StatementExecutor	createStatementExecutor() Create StatementExecutor.
java.sql.Connection	getConnection() Get current database connection.
int	getConnection(DatabaseConnection.ConnectionFunction consumer) Get current database connection.
DatabaseParameters	getParam() Returns database properties settings.
boolean	isLive() Returns database state whether available.
default void	loadDriveInstance(DatabaseParameters param) Load driver.
default java.sql.Connection	tryGetConnection(DatabaseParameters param) Try to get a database connection from database pool.

Methods inherited from interface java.lang.AutoCloseable

close

Method Detail

loadDriveInstance

default void loadDriveInstance(DatabaseParameters param)

Load driver.

Parameters:

param - The parameters of database connect setting.

createStatementExecutor

default StatementExecutor createStatementExecutor()

Create StatementExecutor.

Returns:

StatementExecutor

tryGetConnection

default java.sql.Connection tryGetConnection(DatabaseParameters param)
                                      throws RaSqlException,
                                             RaConnectException

Try to get a database connection from database pool.

Parameters:

param - The parameters of database connect setting.

Returns:

Connection

Throws:

RaSqlException - RaSqlException

RaConnectException - RaConnectException

connectIf

default boolean connectIf(java.util.function.Consumer<StatementExecutor> executor)

If database connection connected return StatementExecutor.

Parameters:

executor - Executor

Returns:

If connected return TRUE.

connect

boolean connect()

Get the connection state.

Returns:

Connection state.

getParam

DatabaseParameters getParam()

Returns database properties settings.

Returns:

DatabaseParameters

getConnection

java.sql.Connection getConnection()

Get current database connection.

Returns:

Database original connection.

getConnection

int getConnection(DatabaseConnection.ConnectionFunction consumer)
           throws RaSqlException,
                  RaConnectException

Get current database connection.

Parameters:

consumer - consumer

Returns:

Database original connection.

Throws:

RaSqlException - RaSqlException

RaConnectException - if can't to connect database.

isLive

boolean isLive()

Returns database state whether available.

Returns:

database state