me.lucko.helper.sql.plugin

Class HelperSql

java.lang.Object

me.lucko.helper.sql.plugin.HelperSql

All Implemented Interfaces:

AutoCloseable, Sql, me.lucko.helper.terminable.Terminable

public class HelperSql
extends Object
implements Sql

Field Summary

Fields inherited from interface me.lucko.helper.terminable.Terminable

EMPTY

Constructor Summary

Constructors

Constructor and Description
HelperSql(DatabaseCredentials credentials)

Method Summary

Modifier and Type	Method and Description
BatchBuilder	batch(String statement) Gets a BatchBuilder for the provided statement.
void	close()
void	execute(String statement, be.bendem.sqlstreams.util.SqlConsumer<PreparedStatement> preparer) Executes a database statement with preparation.
void	executeBatch(BatchBuilder builder) Executes a batched database execution.
Connection	getConnection() Gets a connection from the datasource.
com.zaxxer.hikari.HikariDataSource	getHikari() Gets the Hikari instance backing the datasource
<R> Optional<R>	query(String query, be.bendem.sqlstreams.util.SqlConsumer<PreparedStatement> preparer, be.bendem.sqlstreams.util.SqlFunction<ResultSet,R> handler) Executes a database query with preparation.
be.bendem.sqlstreams.SqlStream	stream() Gets a SqlStream instance for this Sql.

Methods inherited from class java.lang.Object

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

Methods inherited from interface me.lucko.helper.sql.Sql

execute, executeAsync, executeAsync, executeBatchAsync, query, queryAsync, queryAsync

Methods inherited from interface me.lucko.helper.terminable.Terminable

bindWith, closeAndReportException, closeSilently, isClosed

Constructor Detail

HelperSql

public HelperSql(@Nonnull
                 DatabaseCredentials credentials)

Method Detail

getHikari

@Nonnull
public com.zaxxer.hikari.HikariDataSource getHikari()

Description copied from interface: Sql

Gets the Hikari instance backing the datasource

Specified by:

getHikari in interface Sql

Returns:

the hikari instance

getConnection

@Nonnull
public Connection getConnection()
                                   throws SQLException

Description copied from interface: Sql

Gets a connection from the datasource.

The connection should be returned once it has been used.

Specified by:

getConnection in interface Sql

Returns:

a connection

Throws:

SQLException

stream

@Nonnull
public be.bendem.sqlstreams.SqlStream stream()

Description copied from interface: Sql

Gets a SqlStream instance for this Sql.

Specified by:

stream in interface Sql

Returns:

a instance of the stream library for this connection.

execute

public void execute(@Nonnull
                    String statement,
                    @Nonnull
                    be.bendem.sqlstreams.util.SqlConsumer<PreparedStatement> preparer)

Description copied from interface: Sql

Executes a database statement with preparation.

This will be executed on whichever thread it's called from.

Specified by:

execute in interface Sql

Parameters:

statement - the statement to be executed

preparer - the preparation used for this statement

See Also:

to perform this action asynchronously

query

public <R> Optional<R> query(@Nonnull
                             String query,
                             @Nonnull
                             be.bendem.sqlstreams.util.SqlConsumer<PreparedStatement> preparer,
                             @Nonnull
                             be.bendem.sqlstreams.util.SqlFunction<ResultSet,R> handler)

Description copied from interface: Sql

Executes a database query with preparation.

This will be executed on whichever thread it's called from.

In the case of a SQLException or in the case of no data being returned, or the handler evaluating to null, this method will return an Optional.empty() object.

Specified by:

query in interface Sql

Type Parameters:

R - the returned type

Parameters:

query - the query to be executed

preparer - the preparation used for this statement

handler - the handler for the data returned by the query

Returns:

the results of the database query

See Also:

to perform this query asynchronously

executeBatch

public void executeBatch(@Nonnull
                         BatchBuilder builder)

Description copied from interface: Sql

Executes a batched database execution.

This will be executed on whichever thread it's called from.

Note that proper implementations of this method should determine if the provided BatchBuilder is actually worth of being a batched statement. For instance, a BatchBuilder with only one handler can safely be referred to Sql.execute(String, SqlConsumer)

Specified by:

executeBatch in interface Sql

Parameters:

builder - the builder to be used.

See Also:

to perform this action asynchronously

batch

public BatchBuilder batch(@Nonnull
                          String statement)

Description copied from interface: Sql

Gets a BatchBuilder for the provided statement.

Specified by:

batch in interface Sql

Parameters:

statement - the statement to prepare for batching.

Returns:

a BatchBuilder

close

public void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface me.lucko.helper.terminable.Terminable