com.moandjiezana.uncommons.dbutils

Class QueryRunner

java.lang.Object

com.moandjiezana.uncommons.dbutils.QueryRunner

public class QueryRunner
extends Object

Executes SQL queries with pluggable strategies for handling ResultSets. Immutable, but only as threadsafe as the underlying Connection. Avoid sharing Connection instances across threads!

See Also:

ResultSetHandler

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	QueryRunner.Transaction

Method Summary

Modifier and Type	Method and Description
int[]	batch(String sql, List<List<Object>> params)
<T> T	batchInsert(String sql, ResultSetHandler<T> resultSetHandler, List<List<Object>> batchParams)
static QueryRunner	create(Connection connection) try (Connection connection = DriverManager.getConnection(jdbcUrl)) { QueryRunner queryRunner = QueryRunner.create(connection); }
int	execute(String sql, Object... params)
QueryRunner	initializeWith(ConsumerWithException<Connection> initializer)
<T> T	insert(String sql, ResultSetHandler<T> resultSetHandler, Object... params)
<T> T	select(String sql, ResultSetHandler<T> resultSetHandler, Object... params)
void	tx(BiConsumerWithException<QueryRunner,QueryRunner.Transaction> txQueryRunner) Provides a QueryRunner that can be used in a transaction.

Methods inherited from class java.lang.Object

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

Method Detail

create

public static QueryRunner create(Connection connection)

 try (Connection connection = DriverManager.getConnection(jdbcUrl)) {
   QueryRunner queryRunner = QueryRunner.create(connection);
 }
 

Parameters:

connection - the Connection to be used. Must be managed by the caller

Returns:

a Connection-based QueryRunner

initializeWith

public QueryRunner initializeWith(ConsumerWithException<Connection> initializer)

select

public <T> T select(String sql,
                    ResultSetHandler<T> resultSetHandler,
                    Object... params)
             throws Exception

Type Parameters:

T - the type of instance to return

Parameters:

sql - the SELECT to execute

resultSetHandler - transforms the ResultSet

params - values for the SQL placeholders

Returns:

an instance of T as determined by resultSetHandler

Throws:

Exception - if anything goes wrong

execute

public int execute(String sql,
                   Object... params)
            throws Exception

Parameters:

sql - the UPDATE, DELETE or DDL to execute. Ignores any values returned by the ResultSet.

params - values for the SQL placeholders

Returns:

The number of rows updated.

Throws:

Exception - if anything goes wrong

insert

public <T> T insert(String sql,
                    ResultSetHandler<T> resultSetHandler,
                    Object... params)
             throws Exception

Type Parameters:

T - the type of instance to return

Parameters:

sql - the INSERT to execute

resultSetHandler - transforms the ResultSet, which contains the generated keys

params - values for the SQL placeholders

Returns:

an instance of T as determined by resultSetHandler

Throws:

Exception - if anything goes wrong

batch

public int[] batch(String sql,
                   List<List<Object>> params)
            throws Exception

Parameters:

sql - the SQL to execute

params - values for the SQL placeholders. Eg. Arrays.asList(Arrays.asList(1L), Arrays.asList(2L)) will create a batch of 2 queries, using 1, then 2, as values.

Returns:

the number of affected rows for each time the SQL was executed

Throws:

Exception - if anything goes wrong

batchInsert

public <T> T batchInsert(String sql,
                         ResultSetHandler<T> resultSetHandler,
                         List<List<Object>> batchParams)
                  throws Exception

Type Parameters:

T - the type of instance to return

Parameters:

sql - The INSERT to execute

resultSetHandler - transforms the ResultSet, which contains the generated keys

batchParams - values for the SQL placeholders. Eg. Arrays.asList(Arrays.asList(1L), Arrays.asList(2L)) will create a batch of 2 queries, using 1, then 2, as values.

Returns:

an instance of T as determined by resultSetHandler

Throws:

Exception - if anything goes wrong

tx

public void tx(BiConsumerWithException<QueryRunner,QueryRunner.Transaction> txQueryRunner)
        throws Exception

Provides a QueryRunner that can be used in a transaction.

The underlying Connection is configured in the same way as any other Connection from this QueryRunner, except that Connection.setAutoCommit(boolean) is set to false before any calls are made and set to true afterwards.

Make sure to call Connection.commit() or Connection.rollback()!

Parameters:

txQueryRunner - Make sure to use this QueryRunner in the transaction block

Throws:

Exception - if anything goes wrong