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

Class AsyncMariaDBManager

java.lang.Object

io.github.mrtesz.teszcore.db.manager.AbstractDBManager

io.github.mrtesz.teszcore.db.manager.mariadb.AbstractMariaDBManager

io.github.mrtesz.teszcore.db.manager.mariadb.AsyncMariaDBManager

All Implemented Interfaces:

AsyncDBManager, DBManager, Copyable<DBManager>

public class AsyncMariaDBManager
extends AbstractMariaDBManager
implements AsyncDBManager

Field Summary

Fields

Modifier and Type	Field	Description
protected final int	timeoutSeconds

Fields inherited from class io.github.mrtesz.teszcore.db.manager.mariadb.AbstractMariaDBManager

dataSource, infoWhenCredentialsAreNull, name, password, projectName, url, user

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AsyncMariaDBManager(boolean infoWhenCredentialsAreNull, @Nullable String name, @Nullable String url, @Nullable String user, @Nullable String password, @Nullable com.zaxxer.hikari.HikariDataSource dataSource, @Nullable String projectName, int timeoutSeconds)

Method Summary

Modifier and Type	Method	Description
CompletableFuture<Boolean>	columnExists(@NotNull String tableName, @NotNull String columnName)	Show if a column exists in a table
AsyncMariaDBManager	copy()	Copy the executing class
CompletableFuture<Void>	createOrAlter(@NotNull DBTable dbTable)	Create a database table using a DBTable object, suitable for the DBManager (AsyncMariaDBManager: MariaDBTable AsyncSqliteManager: SqliteTable)
CompletableFuture<Integer>	deleteFrom(@NotNull String tableName, @Nullable String whereClause)	Delete entries e.g.: deleteFrom("users", "userId = " + userId);
CompletableFuture<Integer>	deleteFrom(@NotNull String tableName, @Nullable String whereClause, @NotNull List<Object> whereParams)	Delete entries with a List replacing the question marks in the whereClause e.g.: deleteFrom("users", "userId = ?"

Methods inherited from class io.github.mrtesz.teszcore.db.manager.mariadb.AbstractMariaDBManager

async, checkConnection, connect, createHikariConfig, disconnect, getConnection, sync

Methods inherited from class io.github.mrtesz.teszcore.db.manager.AbstractDBManager

close, isClosed

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.github.mrtesz.teszcore.api.db.manager.DBManager

async, async, buildSqlWithParams, checkConnection, close, connect, disconnect, getConnection, getName, isClosed, sync

Field Details

timeoutSeconds

protected final int timeoutSeconds

Constructor Details

AsyncMariaDBManager

protected AsyncMariaDBManager(boolean infoWhenCredentialsAreNull,
 @Nullable
 @Nullable String name,
 @Nullable
 @Nullable String url,
 @Nullable
 @Nullable String user,
 @Nullable
 @Nullable String password,
 @Nullable
 @Nullable com.zaxxer.hikari.HikariDataSource dataSource,
 @Nullable
 @Nullable String projectName,
 int timeoutSeconds)

Method Details

createOrAlter

public CompletableFuture<Void> createOrAlter(@NotNull
 @NotNull DBTable dbTable)
                                      throws IllegalArgumentException

Description copied from interface: AsyncDBManager

Create a database table using a DBTable object, suitable for the DBManager (AsyncMariaDBManager: MariaDBTable AsyncSqliteManager: SqliteTable)

Specified by:

createOrAlter in interface AsyncDBManager

Parameters:

dbTable - Table that is created or altered

Throws:

IllegalArgumentException - when the dbTable param is not the suitable type for the DBManager

executeSql

public CompletableFuture<Integer> executeSql(@NotNull
 @NotNull String sql,
 @NotNull
 @NotNull String tableName,
 @Nullable
 @Nullable String type,
 @NotNull
 @NotNull List<Object> sqlParams)

Description copied from interface: AsyncDBManager

Execute a SQL query with a List replacing the question marks in the sql
e.g.:
executeSql("UPDATE users SET name = ? WHERE id = ?", List.of(username, userId), "users", "update username"); sync

Specified by:

executeSql in interface AsyncDBManager

Parameters:

sql - Query that should be executed

tableName - Name of the table, querying to

type - Type of the execution

sqlParams - Values replacing the ?'s in the sql query

Returns:

A CompletableFuture supplying the return value of the PreparedStatement.executeUpdate()

executeSql

public CompletableFuture<Integer> executeSql(@NotNull
 @NotNull String sql,
 @NotNull
 @NotNull String tableName,
 @Nullable
 @Nullable String type)

Description copied from interface: AsyncDBManager

Execute a SQL query
e.g.:
executeSql("UPDATE users SET name = " + username + " WHERE id = " + userId, "users", "update username");

Specified by:

executeSql in interface AsyncDBManager

Parameters:

sql - Query that should be executed

tableName - Name of the table, querying to

type - Type of the execution

Returns:

A CompletableFuture supplying the return value of the PreparedStatement.executeUpdate()

executeBatchSql

@Deprecated
public CompletableFuture<int[]> executeBatchSql(@NotNull
 @NotNull List<BatchSqlStatement> sqlStatements,
 @NotNull
 @NotNull String tableName)
                                         throws IllegalArgumentException

Deprecated.

Description copied from interface: AsyncDBManager

Executes multiple SQL statements in batch mode for better performance
e.g.:
executeBatchSql(batchStatementList, "users", "batch update");

Specified by:

executeBatchSql in interface AsyncDBManager

Parameters:

sqlStatements - List of SQL statements with their parameters

tableName - Name of the table, querying to

Returns:

A CompletableFuture supplying the return value of Statement.executeBatch()

Throws:

IllegalArgumentException - if the SQL statements are not the same structure

executeBatchSql

public CompletableFuture<int[]> executeBatchSql(@NotNull
 @NotNull BatchSqlStatements sqlStatements,
 @NotNull
 @NotNull String tableName)

Description copied from interface: AsyncDBManager

Executes multiple SQL statements in batch mode for better performance
e.g.:
executeBatchSql(batchStatementList, "users", "batch update");

Specified by:

executeBatchSql in interface AsyncDBManager

Parameters:

sqlStatements - List of SQL statements with their parameters

tableName - Name of the table, querying to

Returns:

A CompletableFuture supplying the return value of Statement.executeBatch()

executeSelect

public CompletableFuture<SelectionResults> executeSelect(@NotNull
 @NotNull String sql,
 @NotNull
 @NotNull String tableName,
 @NotNull
 @NotNull List<Object> sqlParams)

Description copied from interface: AsyncDBManager

Execute a selection query with a List replacing the question marks in the sql
e.g.
executeSelect("SELECT email, number FROM users WHERE username = ?", List.of("Mr_Tesz"), "users");

Specified by:

executeSelect in interface AsyncDBManager

Parameters:

sql - Sql query

tableName - Name of the table, to select from

sqlParams - Values replacing the ?'s in the sql query

Returns:

A CompletableFuture supplying a SelectionResults object

executeSelect

public CompletableFuture<SelectionResults> executeSelect(@NotNull
 @NotNull String sql,
 @NotNull
 @NotNull String tableName)

Description copied from interface: AsyncDBManager

Execute a selection query
e.g.
executeSelect("SELECT email, number FROM users WHERE username = Mr_Tesz", "users");

Specified by:

executeSelect in interface AsyncDBManager

Parameters:

sql - Sql query

tableName - Name of the table, to select from

Returns:

A CompletableFuture supplying a SelectionResults object

insertInto

public CompletableFuture<Integer> insertInto(@NotNull
 @NotNull String tableName,
 @NotNull
 @NotNull Map<String,Object> values)

Description copied from interface: AsyncDBManager

Insert into a table
e.g.:
Map<String, Object> values = new HashMapinvalid input: '<'>();
values.put("id", userId);
values.put("name", username)
dbManager.insertInto("users", values);

Specified by:

insertInto in interface AsyncDBManager

Parameters:

tableName - Name of the table, inserting into

values - Values to insert

Returns:

A CompletableFuture supplying the return value of the PreparedStatement.executeUpdate()

insertIgnore

public CompletableFuture<Integer> insertIgnore(@NotNull
 @NotNull String tableName,
 @NotNull
 @NotNull Map<String,Object> values)

Description copied from interface: AsyncDBManager

Insert into a table ignoring when a unique is duplicated
e.g.:
Map<String, Object> values = new HashMapinvalid input: '<'>();
values.put("id", userId);
values.put("name", username);
dbManager.insertInto("users", values);

Specified by:

insertIgnore in interface AsyncDBManager

Parameters:

tableName - Name of the table, inserting into

values - Values to insert

Returns:

A CompletableFuture supplying the return value of the PreparedStatement.executeUpdate()

deleteFrom

public CompletableFuture<Integer> deleteFrom(@NotNull
 @NotNull String tableName,
 @Nullable
 @Nullable String whereClause,
 @NotNull
 @NotNull List<Object> whereParams)

Description copied from interface: AsyncDBManager

Delete entries with a List replacing the question marks in the whereClause
e.g.:
deleteFrom("users", "userId = ?", List.of(userId));

Specified by:

deleteFrom in interface AsyncDBManager

Parameters:

tableName - Name of the table, deleting from

whereClause - Clause, narrowing the targeted columns

whereParams - Values replacing the ?'s in the whereClause

Returns:

A CompletableFuture supplying the rows affected

deleteFrom

public CompletableFuture<Integer> deleteFrom(@NotNull
 @NotNull String tableName,
 @Nullable
 @Nullable String whereClause)

Description copied from interface: AsyncDBManager

Delete entries
e.g.:
deleteFrom("users", "userId = " + userId);

Specified by:

deleteFrom in interface AsyncDBManager

Parameters:

tableName - Name of the table, deleting from

whereClause - Clause, narrowing the targeted columns

Returns:

A CompletableFuture supplying the rows affected

update

public CompletableFuture<Integer> update(@NotNull
 @NotNull String tableName,
 @NotNull
 @NotNull Map<String,Object> values,
 @Nullable
 @Nullable String whereClause,
 @NotNull
 @NotNull List<Object> whereParams)

Description copied from interface: AsyncDBManager

Update a table with a List replacing the question marks in the whereClause
e.g.:
Map<String, Object> values = new HashMapinvalid input: '<'>();
values.put("name", username);
update("users", values, "id = ?", List.of(userId);

Specified by:

update in interface AsyncDBManager

Parameters:

tableName - Name of the table, updating

values - Values to update

whereClause - Clause, narrowing the targeted columns

whereParams - Values replacing the ?'s in the whereClause

Returns:

A CompletableFuture supplying the rows affected

update

public CompletableFuture<Integer> update(@NotNull
 @NotNull String tableName,
 @NotNull
 @NotNull Map<String,Object> values,
 @Nullable
 @Nullable String whereClause)

Description copied from interface: AsyncDBManager

Update a table
e.g.:
Map<String, Object> values = new HashMapinvalid input: '<'>();
values.put("name", username);
update("users", values, "id = " + userId);

Specified by:

update in interface AsyncDBManager

Parameters:

tableName - Name of the table, updating

values - Values to update

whereClause - Clause, narrowing the targeted columns

Returns:

A CompletableFuture supplying the rows affected

dropTable

public CompletableFuture<Integer> dropTable(@NotNull
 @NotNull String tableName)

Description copied from interface: AsyncDBManager

Drop a table from the database
e.g.:
dropTable("current-weak-save");

Specified by:

dropTable in interface AsyncDBManager

Parameters:

tableName - Name of the table to drop

Returns:

A CompletableFuture supplying the return value of the PreparedStatement.executeUpdate()

columnExists

public CompletableFuture<Boolean> columnExists(@NotNull
 @NotNull String tableName,
 @NotNull
 @NotNull String columnName)

Description copied from interface: AsyncDBManager

Show if a column exists in a table

Specified by:

columnExists in interface AsyncDBManager

Parameters:

tableName - Name of the table, checking

columnName - Name of the column to be checked

Returns:

A CompletableFuture supplying true if the column exists

indexExists

public CompletableFuture<Boolean> indexExists(@NotNull
 @NotNull String tableName,
 @NotNull
 @NotNull String indexName)

Description copied from interface: AsyncDBManager

Show if an index exists in a table

Specified by:

indexExists in interface AsyncDBManager

Parameters:

tableName - Name of the table, checking

indexName - Name of the index to be checked

Returns:

A CompletableFuture supplying true if the index exists

copy

public AsyncMariaDBManager copy()

Description copied from interface: Copyable

Copy the executing class

Specified by:

copy in interface Copyable<DBManager>

Returns:

a copy of the class executed in