be.bendem.sqlstreams

Interface SqlStream

All Superinterfaces:

AutoCloseable, Closeable

All Known Subinterfaces:

Transaction

All Known Implementing Classes:

SqlImpl

public interface SqlStream
extends Closeable

This class is the main entry point from this library. It provides static methods to set it up from a Connection or a DataSource as well as all methods to query it.

Method Summary

Modifier and Type	Method and Description
BatchUpdate	batchUpdate(String sql) Prepares a DML statement to provide it multiple batches of parameters.
Execute<CallableStatement>	call(String sql) Prepares a call and provides it the given parameters.
void	close() Closes the underlying DataSource.
static SqlStream	connect(Connection connection) Constructs a SqlStream instance holding a single connection.
static SqlStream	connect(DataSource dataSource) Constructs a SqlStream instance retrieving new Connections from the provided DataSource as needed.
default void	exec(String sql, Object... parameters) Shortcut for execute(sql).with(parameters).execute().
Execute<PreparedStatement>	execute(String sql) Prepares a query.
default <R> Optional<R>	first(String sql, SqlFunction<ResultSet,R> mapping, Object... parameters) Shortcut for query(sql).with(parameters).first(mapping).
Query	query(SqlFunction<Connection,PreparedStatement> preparer) Manually prepares a query from a Connection.
default Query	query(String sql) Prepares a query to be executed.
<T> SqlStream	registerCustomBinding(Class<T> clazz, PreparedStatementBinderByIndex<T> preparedStatementBinderByIndex)
Transaction	transaction() Opens a new transaction bound to a single connection.
Transaction	transaction(Transaction.IsolationLevel isolationLevel) Opens a new transaction bound to a single connection.
Update	update(SqlFunction<Connection,PreparedStatement> preparer) Manually prepares a DML query from a Connection.
default Update	update(String sql) Prepares a DML sql statement.

Method Detail

connect

static SqlStream connect(Connection connection)

Constructs a SqlStream instance holding a single connection.

Parameters:

connection - the connection to use

Returns:

the newly created Sql instance

See Also:

connect(DataSource)

connect

static SqlStream connect(DataSource dataSource)

Constructs a SqlStream instance retrieving new Connections from the provided DataSource as needed.

Parameters:

dataSource - the datasource supplying connections

Returns:

the newly created Sql instance

registerCustomBinding

<T> SqlStream registerCustomBinding(Class<T> clazz,
                                    PreparedStatementBinderByIndex<T> preparedStatementBinderByIndex)

transaction

Transaction transaction()

Opens a new transaction bound to a single connection.

Returns:

the new transaction

transaction

Transaction transaction(Transaction.IsolationLevel isolationLevel)

Opens a new transaction bound to a single connection.

Parameters:

isolationLevel - the isolation level of the underlying transaction

Returns:

the new transaction

See Also:

Connection.setTransactionIsolation(int)

query

Query query(SqlFunction<Connection,PreparedStatement> preparer)

Manually prepares a query from a Connection.

Parameters:

preparer - the code creating a PreparedStatement from a Connection

Returns:

an object to parametrize the statement and map the query result

query

default Query query(String sql)

Prepares a query to be executed.

Note that the query is not actually executed until a mapping method of Query is called.

Parameters:

sql - the sql query

Returns:

an object to parametrize the statement and map the query result

update

Update update(SqlFunction<Connection,PreparedStatement> preparer)

Manually prepares a DML query from a Connection.

Parameters:

preparer - the code creating a PreparedStatement from a Connection

Returns:

an object to parametrize and execute the DML statement

update

default Update update(String sql)

Prepares a DML sql statement.

Not that the query is not actually executed until you invoke a method from Update.

Parameters:

sql - the sql query

Returns:

an object to parametrize the statement and retrieve the number of rows affected by this query

batchUpdate

BatchUpdate batchUpdate(String sql)

Prepares a DML statement to provide it multiple batches of parameters.

Note that the query is not actually executed until you invoke a count method from BatchUpdate.

Parameters:

sql - the sql query

Returns:

an object to parametrize the statement and retrieve counts of affected rows

execute

Execute<PreparedStatement> execute(String sql)

Prepares a query.

Note that this method is not executed until you call Execute.execute().

Parameters:

sql - the sql query

Returns:

an object to parametrize the statement and execute the query

call

Execute<CallableStatement> call(String sql)

Prepares a call and provides it the given parameters.

Note that this method is not executed until you call Execute.execute().

Parameters:

sql - the sql query

Returns:

an object to parametrize the statement and execute the query

See Also:

Connection.prepareCall(String)

first

default <R> Optional<R> first(String sql,
                              SqlFunction<ResultSet,R> mapping,
                              Object... parameters)

Shortcut for query(sql).with(parameters).first(mapping).

Type Parameters:

R - the type of the elements of the returned stream

Parameters:

sql - the sql query

mapping - a function to map each row to an object

parameters - parameters to apply in order to the provided query

Returns:

a stream of elements mapped from the result set

See Also:

query(String), Query.first(SqlFunction)

exec

default void exec(String sql,
                  Object... parameters)

Shortcut for execute(sql).with(parameters).execute().

Parameters:

sql - the sql query

parameters - parameters to apply in order to the provided query

close

void close()

Closes the underlying DataSource.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable