Module org.itsallcode.jdbc

Package org.itsallcode.jdbc

Interface DbOperations

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

SimpleConnection, Transaction

public interface DbOperations
extends AutoCloseable

Interface containing various DB operations. Use one of the implementations SimpleConnection or Transaction.

Method Summary

Modifier and Type	Method	Description
void	close()
void	executeScript(String sqlScript)	Execute all commands in a SQL script, separated with ;.
int	executeUpdate(String sql)	Execute a single SQL statement.
default int	executeUpdate(String sql, List<Object> parameters)	Execute a single SQL statement as a prepared statement with placeholders.
int	executeUpdate(String sql, PreparedStatementSetter preparedStatementSetter)	Execute a single SQL statement as a prepared statement with placeholders.
Connection	getOriginalConnection()	Get the original wrapped connection.
PreparedStatementBatchBuilder	preparedStatementBatch()	Create a prepared statement batch builder for inserting or updating rows by directly setting values of a PreparedStatement.
<T> RowPreparedStatementBatchBuilder<T>	preparedStatementBatch(Class<T> rowType)	Create a row-based prepared statement batch builder for inserting or updating rows from an Iterator or a Stream.
SimpleResultSet<Row>	query(String sql)	Execute a SQL query and return a result set with generic Rows.
default <T> SimpleResultSet<T>	query(String sql, List<Object> parameters, RowMapper<T> rowMapper)	Execute a SQL query, set parameters and return a result set with rows converted to a custom type DbOperations.
<T> SimpleResultSet<T>	query(String sql, PreparedStatementSetter preparedStatementSetter, RowMapper<T> rowMapper)	Execute a SQL query, set parameters and return a result set with rows converted to a custom type DbOperations.
default <T> SimpleResultSet<T>	query(String sql, RowMapper<T> rowMapper)	Execute a SQL query and return a result set with rows converted to a custom type DbOperations using the given RowMapper.
StatementBatchBuilder	statementBatch()	Create a batch statement builder for executing multiple statements in a batch.

Method Details

executeScript

void executeScript(String sqlScript)

Execute all commands in a SQL script, separated with ;.

Parameters:

sqlScript - script to execute.

executeUpdate

int executeUpdate(String sql)

Execute a single SQL statement.

Parameters:

sql - SQL statement

Returns:

either the row count for SQL Data Manipulation Language (DML) statements or 0 for SQL statements that return nothing

executeUpdate

default int executeUpdate(String sql,
 List<Object> parameters)

Execute a single SQL statement as a prepared statement with placeholders.

This will use PreparedStatement.setObject(int, Object) for setting parameters. If you need more control, use executeUpdate(String, PreparedStatementSetter).

Parameters:

sql - SQL statement

parameters - parameters to set in the prepared statement

Returns:

either the row count for SQL Data Manipulation Language (DML) statements or 0 for SQL statements that return nothing

executeUpdate

int executeUpdate(String sql,
 PreparedStatementSetter preparedStatementSetter)

Execute a single SQL statement as a prepared statement with placeholders.

Parameters:

sql - SQL statement

preparedStatementSetter - prepared statement setter

Returns:

either the row count for SQL Data Manipulation Language (DML) statements or 0 for SQL statements that return nothing

query

SimpleResultSet<Row> query(String sql)

Execute a SQL query and return a result set with generic Rows.

Parameters:

sql - SQL query

Returns:

result set

query

default <T> SimpleResultSet<T> query(String sql,
 RowMapper<T> rowMapper)

Execute a SQL query and return a result set with rows converted to a custom type DbOperations using the given RowMapper.

Type Parameters:

T - generic row type

Parameters:

sql - SQL query

rowMapper - row mapper

Returns:

the result set

query

default <T> SimpleResultSet<T> query(String sql,
 List<Object> parameters,
 RowMapper<T> rowMapper)

Execute a SQL query, set parameters and return a result set with rows converted to a custom type DbOperations.

This will use PreparedStatement.setObject(int, Object) for setting parameters. If you need more control, use executeUpdate(String, PreparedStatementSetter).

Type Parameters:

T - generic row type

Parameters:

sql - SQL query

parameters - parameters to set in the prepared statement

rowMapper - row mapper

Returns:

the result set

query

<T> SimpleResultSet<T> query(String sql,
 PreparedStatementSetter preparedStatementSetter,
 RowMapper<T> rowMapper)

Execute a SQL query, set parameters and return a result set with rows converted to a custom type DbOperations.

Type Parameters:

T - generic row type

Parameters:

sql - SQL query

preparedStatementSetter - the prepared statement setter

rowMapper - row mapper

Returns:

the result set

statementBatch

StatementBatchBuilder statementBatch()

Create a batch statement builder for executing multiple statements in a batch.

Returns:

batch statement builder

preparedStatementBatch

PreparedStatementBatchBuilder preparedStatementBatch()

Create a prepared statement batch builder for inserting or updating rows by directly setting values of a PreparedStatement.

If you want to insert rows from an Iterator or a Stream, use preparedStatementBatch(Class).

Returns:

batch insert builder

preparedStatementBatch

<T> RowPreparedStatementBatchBuilder<T> preparedStatementBatch(Class<T> rowType)

Create a row-based prepared statement batch builder for inserting or updating rows from an Iterator or a Stream.

If you want to insert rows by directly setting values of a PreparedStatement, use preparedStatementBatch().

Type Parameters:

T - row type

Parameters:

rowType - row type

Returns:

row-based batch insert builder

getOriginalConnection

Connection getOriginalConnection()

Get the original wrapped connection.

Use this in case of missing features in DbOperations.

Returns:

original wrapped connection

close

void close()

Specified by:

close in interface AutoCloseable