Package io.github.mrtesz.teszcore.api.db.manager

Interface DBManager

All Superinterfaces:

Copyable<DBManager>

All Known Subinterfaces:

AsyncDBManager, SyncDBManager

All Known Implementing Classes:

AbstractDBManager, AbstractMariaDBManager, AbstractSqliteManager, AsyncMariaDBManager, AsyncSqliteManager, MariaDBManager, SqliteManager

public interface DBManager
extends Copyable<DBManager>

Parent interface of all database managers

Method Summary

Modifier and Type	Method	Description
default AsyncDBManager	async()	Calls async(int) with timeoutSecs being 2
AsyncDBManager	async(int timeoutSeconds)	Creates an AsyncDBManager with same information as the current database manager
default String	buildSqlWithParams(String sql, @NotNull List<Object> params, boolean cut)	Creates a SQL statement by replacing question marks with the params list
void	checkConnection()	Connects the manager to the database again, when it is not connected
void	close()	Close the database manager
void	connect()	Connect the database manager with the database
void	disconnect()	Close the database manager
Connection	getConnection()	calls checkConnection() and returns a database connection
String	getName()	Get the name of this database manager
boolean	isClosed()	Show if the database manager is closed
SyncDBManager	sync()	Creates a SyncDBManager with same information as the current database manager (When called from an AsyncDBManager the param timeoutSeconds will be forgotten)

Methods inherited from interface io.github.mrtesz.teszcore.copyable.Copyable

copy

Method Details

getName

String getName()

Get the name of this database manager

Returns:

name

isClosed

boolean isClosed()

Show if the database manager is closed

Returns:

true if the database manager is closed

close

void close()

Close the database manager

connect

void connect()
      throws IllegalStateException

Connect the database manager with the database

Throws:

IllegalStateException - if the DBManager is closed

disconnect

void disconnect()

Close the database manager

checkConnection

void checkConnection()
              throws IllegalStateException

Connects the manager to the database again, when it is not connected

Throws:

IllegalStateException - when the DBManager is closed

getConnection

Connection getConnection()
                  throws IllegalStateException

calls checkConnection() and returns a database connection

Returns:

a database connection

Throws:

IllegalStateException - when the DBManager is closed

async

default AsyncDBManager async()

Calls async(int) with timeoutSecs being 2

Returns:

an AsyncDBManager with the values initialized with

async

AsyncDBManager async(int timeoutSeconds)

Creates an AsyncDBManager with same information as the current database manager

Parameters:

timeoutSeconds - The CompletableFuture.completeOnTimeout(T, long, java.util.concurrent.TimeUnit) time in seconds

Returns:

an asynchronous copy of the current database manager

sync

SyncDBManager sync()

Creates a SyncDBManager with same information as the current database manager (When called from an AsyncDBManager the param timeoutSeconds will be forgotten)

Returns:

a synchronous copy of the current database manager

buildSqlWithParams

default String buildSqlWithParams(String sql,
 @NotNull
 @NotNull List<Object> params,
 boolean cut)

Creates a SQL statement by replacing question marks with the params list

Parameters:

sql - SQL Command with ?'s

params - Parameter for ?'s in SQL

cut - Shorten SELECT, WHERE, FROM to SEL, WRE, FR

Returns:

the SQL with replaced question marks