me.lucko.helper.sql

Interface Sql

All Superinterfaces:

AutoCloseable, me.lucko.helper.terminable.Terminable

All Known Implementing Classes:

HelperSql

public interface Sql
extends me.lucko.helper.terminable.Terminable

Represents an individual SQL datasource, created by the library.

Field Summary

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

EMPTY

Method Summary

Modifier and Type	Method and Description
BatchBuilder	batch(String statement) Gets a BatchBuilder for the provided statement.
default void	execute(String statement) Executes a database statement with no preparation.
void	execute(String statement, be.bendem.sqlstreams.util.SqlConsumer<PreparedStatement> preparer) Executes a database statement with preparation.
default me.lucko.helper.promise.Promise<Void>	executeAsync(String statement) Executes a database statement with no preparation.
default me.lucko.helper.promise.Promise<Void>	executeAsync(String statement, be.bendem.sqlstreams.util.SqlConsumer<PreparedStatement> preparer) Executes a database statement with preparation.
void	executeBatch(BatchBuilder builder) Executes a batched database execution.
default me.lucko.helper.promise.Promise<Void>	executeBatchAsync(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.
default <R> Optional<R>	query(String query, be.bendem.sqlstreams.util.SqlFunction<ResultSet,R> handler) Executes a database query with no preparation.
default <R> me.lucko.helper.promise.Promise<Optional<R>>	queryAsync(String query, be.bendem.sqlstreams.util.SqlConsumer<PreparedStatement> preparer, be.bendem.sqlstreams.util.SqlFunction<ResultSet,R> handler) Executes a database query with preparation.
default <R> me.lucko.helper.promise.Promise<Optional<R>>	queryAsync(String query, be.bendem.sqlstreams.util.SqlFunction<ResultSet,R> handler) Executes a database query with no preparation.
be.bendem.sqlstreams.SqlStream	stream() Gets a SqlStream instance for this Sql.

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

bindWith, close, closeAndReportException, closeSilently, isClosed

Method Detail

getHikari

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

Gets the Hikari instance backing the datasource

Returns:

the hikari instance

getConnection

@Nonnull
Connection getConnection()
                            throws SQLException

Gets a connection from the datasource.

The connection should be returned once it has been used.

Returns:

a connection

Throws:

SQLException

stream

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

Gets a SqlStream instance for this Sql.

Returns:

a instance of the stream library for this connection.

executeAsync

@Nonnull
default me.lucko.helper.promise.Promise<Void> executeAsync(@Nonnull
                                                                     String statement)

Executes a database statement with no preparation.

This will be executed on an asynchronous thread.

Parameters:

statement - the statement to be executed

Returns:

a Promise of an asynchronous database execution

See Also:

to perform this action synchronously

execute

default void execute(@Nonnull
                     String statement)

Executes a database statement with no preparation.

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

Parameters:

statement - the statement to be executed

See Also:

to perform the same action asynchronously

executeAsync

@Nonnull
default me.lucko.helper.promise.Promise<Void> executeAsync(@Nonnull
                                                                     String statement,
                                                                     @Nonnull
                                                                     be.bendem.sqlstreams.util.SqlConsumer<PreparedStatement> preparer)

Executes a database statement with preparation.

This will be executed on an asynchronous thread.

Parameters:

statement - the statement to be executed

preparer - the preparation used for this statement

Returns:

a Promise of an asynchronous database execution

See Also:

to perform this action synchronously

execute

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

Executes a database statement with preparation.

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

Parameters:

statement - the statement to be executed

preparer - the preparation used for this statement

See Also:

to perform this action asynchronously

queryAsync

default <R> me.lucko.helper.promise.Promise<Optional<R>> queryAsync(@Nonnull
                                                                    String query,
                                                                    @Nonnull
                                                                    be.bendem.sqlstreams.util.SqlFunction<ResultSet,R> handler)

Executes a database query with no preparation.

This will be executed on an asynchronous thread.

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.

Type Parameters:

R - the returned type

Parameters:

query - the query to be executed

handler - the handler for the data returned by the query

Returns:

a Promise of an asynchronous database query

See Also:

to perform this query synchronously

query

default <R> Optional<R> query(@Nonnull
                              String query,
                              @Nonnull
                              be.bendem.sqlstreams.util.SqlFunction<ResultSet,R> handler)

Executes a database query with no 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.

Type Parameters:

R - the returned type

Parameters:

query - the query to be executed

handler - the handler for the data returned by the query

Returns:

the results of the database query

See Also:

to perform this query asynchronously

queryAsync

default <R> me.lucko.helper.promise.Promise<Optional<R>> queryAsync(@Nonnull
                                                                    String query,
                                                                    @Nonnull
                                                                    be.bendem.sqlstreams.util.SqlConsumer<PreparedStatement> preparer,
                                                                    @Nonnull
                                                                    be.bendem.sqlstreams.util.SqlFunction<ResultSet,R> handler)

Executes a database query with preparation.

This will be executed on an asynchronous thread.

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.

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:

a Promise of an asynchronous database query

See Also:

to perform this query synchronously

query

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

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.

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

executeBatchAsync

default me.lucko.helper.promise.Promise<Void> executeBatchAsync(@Nonnull
                                                                BatchBuilder builder)

Executes a batched database execution.

This will be executed on an asynchronous thread.

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 executeAsync(String, SqlConsumer)

Parameters:

builder - the builder to be used.

Returns:

a Promise of an asynchronous batched database execution

See Also:

to perform this action synchronously

executeBatch

void executeBatch(@Nonnull
                  BatchBuilder builder)

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 execute(String, SqlConsumer)

Parameters:

builder - the builder to be used.

See Also:

to perform this action asynchronously

batch

BatchBuilder batch(@Nonnull
                   String statement)

Gets a BatchBuilder for the provided statement.

Parameters:

statement - the statement to prepare for batching.

Returns:

a BatchBuilder