org.apache.commons.dbutils
Class AsyncQueryRunner

java.lang.Object
  extended by org.apache.commons.dbutils.AbstractQueryRunner
      extended by org.apache.commons.dbutils.AsyncQueryRunner

public class AsyncQueryRunner
extends AbstractQueryRunner

Executes SQL queries with pluggable strategies for handling ResultSets. This class is thread safe.

Since:
1.4
See Also:
ResultSetHandler

Nested Class Summary
protected  class AsyncQueryRunner.BatchCallableStatement
          Class that encapsulates the continuation for batch calls.
protected  class AsyncQueryRunner.QueryCallableStatement<T>
          Class that encapsulates the continuation for query calls.
protected  class AsyncQueryRunner.UpdateCallableStatement
          Class that encapsulates the continuation for update calls.
 
Field Summary
 
Fields inherited from class org.apache.commons.dbutils.AbstractQueryRunner
ds
 
Constructor Summary
AsyncQueryRunner(boolean pmdKnownBroken, ExecutorService executorService)
          Constructor for AsyncQueryRunner, allows workaround for Oracle drivers
AsyncQueryRunner(DataSource ds, boolean pmdKnownBroken, ExecutorService executorService)
          Constructor for QueryRunner, allows workaround for Oracle drivers.
AsyncQueryRunner(DataSource ds, ExecutorService executorService)
          Constructor for AsyncQueryRunner which takes a DataSource.
AsyncQueryRunner(ExecutorService executorService)
          Constructor for AsyncQueryRunner.
 
Method Summary
 Future<int[]> batch(Connection conn, String sql, Object[][] params)
          Execute a batch of SQL INSERT, UPDATE, or DELETE queries.
 Future<int[]> batch(String sql, Object[][] params)
          Execute a batch of SQL INSERT, UPDATE, or DELETE queries.
<T> Future<T>
query(Connection conn, String sql, ResultSetHandler<T> rsh)
          Execute an SQL SELECT query without any replacement parameters.
<T> Future<T>
query(Connection conn, String sql, ResultSetHandler<T> rsh, Object... params)
          Execute an SQL SELECT query with replacement parameters.
<T> Future<T>
query(String sql, ResultSetHandler<T> rsh)
          Executes the given SELECT SQL without any replacement parameters.
<T> Future<T>
query(String sql, ResultSetHandler<T> rsh, Object... params)
          Executes the given SELECT SQL query and returns a result object.
 Future<Integer> update(Connection conn, String sql)
          Execute an SQL INSERT, UPDATE, or DELETE query without replacement parameters.
 Future<Integer> update(Connection conn, String sql, Object... params)
          Execute an SQL INSERT, UPDATE, or DELETE query.
 Future<Integer> update(Connection conn, String sql, Object param)
          Execute an SQL INSERT, UPDATE, or DELETE query with a single replacement parameter.
 Future<Integer> update(String sql)
          Executes the given INSERT, UPDATE, or DELETE SQL statement without any replacement parameters.
 Future<Integer> update(String sql, Object... params)
          Executes the given INSERT, UPDATE, or DELETE SQL statement.
 Future<Integer> update(String sql, Object param)
          Executes the given INSERT, UPDATE, or DELETE SQL statement with a single replacement parameter.
 
Methods inherited from class org.apache.commons.dbutils.AbstractQueryRunner
close, close, close, fillStatement, fillStatementWithBean, fillStatementWithBean, getDataSource, isPmdKnownBroken, prepareConnection, prepareStatement, rethrow, wrap
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

AsyncQueryRunner

public AsyncQueryRunner(ExecutorService executorService)
Constructor for AsyncQueryRunner.

Parameters:
executorService - the ExecutorService instance used to run JDBC invocations concurrently.

AsyncQueryRunner

public AsyncQueryRunner(boolean pmdKnownBroken,
                        ExecutorService executorService)
Constructor for AsyncQueryRunner, allows workaround for Oracle drivers

Parameters:
pmdKnownBroken - Oracle drivers don't support ParameterMetaData.getParameterType(int); if pmdKnownBroken is set to true, we won't even try it; if false, we'll try it, and if it breaks, we'll remember not to use it again.
executorService - the ExecutorService instance used to run JDBC invocations concurrently.

AsyncQueryRunner

public AsyncQueryRunner(DataSource ds,
                        ExecutorService executorService)
Constructor for AsyncQueryRunner which takes a DataSource. Methods that do not take a Connection parameter will retrieve connections from this DataSource.

Parameters:
ds - The DataSource to retrieve connections from.
executorService - the ExecutorService instance used to run JDBC invocations concurrently.

AsyncQueryRunner

public AsyncQueryRunner(DataSource ds,
                        boolean pmdKnownBroken,
                        ExecutorService executorService)
Constructor for QueryRunner, allows workaround for Oracle drivers. Methods that do not take a Connection parameter will retrieve connections from this DataSource.

Parameters:
ds - The DataSource to retrieve connections from.
pmdKnownBroken - Oracle drivers don't support ParameterMetaData.getParameterType(int); if pmdKnownBroken is set to true, we won't even try it; if false, we'll try it, and if it breaks, we'll remember not to use it again.
executorService - the ExecutorService instance used to run JDBC invocations concurrently.
Method Detail

batch

public Future<int[]> batch(Connection conn,
                           String sql,
                           Object[][] params)
                    throws SQLException
Execute a batch of SQL INSERT, UPDATE, or DELETE queries.

Parameters:
conn - The Connection to use to run the query. The caller is responsible for closing this Connection.
sql - The SQL to execute.
params - An array of query replacement parameters. Each row in this array is one set of batch replacement values.
Returns:
A Future which returns the number of rows updated per statement.
Throws:
SQLException - if a database access error occurs

batch

public Future<int[]> batch(String sql,
                           Object[][] params)
                    throws SQLException
Execute a batch of SQL INSERT, UPDATE, or DELETE queries. The Connection is retrieved from the DataSource set in the constructor. This Connection must be in auto-commit mode or the update will not be saved.

Parameters:
sql - The SQL to execute.
params - An array of query replacement parameters. Each row in this array is one set of batch replacement values.
Returns:
A Future which returns the number of rows updated per statement.
Throws:
SQLException - if a database access error occurs

query

public <T> Future<T> query(Connection conn,
                           String sql,
                           ResultSetHandler<T> rsh,
                           Object... params)
                throws SQLException
Execute an SQL SELECT query with replacement parameters. The caller is responsible for closing the connection.

Type Parameters:
T - The type of object that the handler returns
Parameters:
conn - The connection to execute the query in.
sql - The query to execute.
rsh - The handler that converts the results into an object.
params - The replacement parameters.
Returns:
A Future which returns the result of the query call.
Throws:
SQLException - if a database access error occurs

query

public <T> Future<T> query(Connection conn,
                           String sql,
                           ResultSetHandler<T> rsh)
                throws SQLException
Execute an SQL SELECT query without any replacement parameters. The caller is responsible for closing the connection.

Type Parameters:
T - The type of object that the handler returns
Parameters:
conn - The connection to execute the query in.
sql - The query to execute.
rsh - The handler that converts the results into an object.
Returns:
A Future which returns the result of the query call.
Throws:
SQLException - if a database access error occurs

query

public <T> Future<T> query(String sql,
                           ResultSetHandler<T> rsh,
                           Object... params)
                throws SQLException
Executes the given SELECT SQL query and returns a result object. The Connection is retrieved from the DataSource set in the constructor.

Type Parameters:
T - The type of object that the handler returns
Parameters:
sql - The SQL statement to execute.
rsh - The handler used to create the result object from the ResultSet.
params - Initialize the PreparedStatement's IN parameters with this array.
Returns:
A Future which returns the result of the query call.
Throws:
SQLException - if a database access error occurs

query

public <T> Future<T> query(String sql,
                           ResultSetHandler<T> rsh)
                throws SQLException
Executes the given SELECT SQL without any replacement parameters. The Connection is retrieved from the DataSource set in the constructor.

Type Parameters:
T - The type of object that the handler returns
Parameters:
sql - The SQL statement to execute.
rsh - The handler used to create the result object from the ResultSet.
Returns:
A Future which returns the result of the query call.
Throws:
SQLException - if a database access error occurs

update

public Future<Integer> update(Connection conn,
                              String sql)
                       throws SQLException
Execute an SQL INSERT, UPDATE, or DELETE query without replacement parameters.

Parameters:
conn - The connection to use to run the query.
sql - The SQL to execute.
Returns:
A Future which returns the number of rows updated.
Throws:
SQLException - if a database access error occurs

update

public Future<Integer> update(Connection conn,
                              String sql,
                              Object param)
                       throws SQLException
Execute an SQL INSERT, UPDATE, or DELETE query with a single replacement parameter.

Parameters:
conn - The connection to use to run the query.
sql - The SQL to execute.
param - The replacement parameter.
Returns:
A Future which returns the number of rows updated.
Throws:
SQLException - if a database access error occurs

update

public Future<Integer> update(Connection conn,
                              String sql,
                              Object... params)
                       throws SQLException
Execute an SQL INSERT, UPDATE, or DELETE query.

Parameters:
conn - The connection to use to run the query.
sql - The SQL to execute.
params - The query replacement parameters.
Returns:
A Future which returns the number of rows updated.
Throws:
SQLException - if a database access error occurs

update

public Future<Integer> update(String sql)
                       throws SQLException
Executes the given INSERT, UPDATE, or DELETE SQL statement without any replacement parameters. The Connection is retrieved from the DataSource set in the constructor. This Connection must be in auto-commit mode or the update will not be saved.

Parameters:
sql - The SQL statement to execute.
Returns:
A Future which returns the number of rows updated.
Throws:
SQLException - if a database access error occurs

update

public Future<Integer> update(String sql,
                              Object param)
                       throws SQLException
Executes the given INSERT, UPDATE, or DELETE SQL statement with a single replacement parameter. The Connection is retrieved from the DataSource set in the constructor. This Connection must be in auto-commit mode or the update will not be saved.

Parameters:
sql - The SQL statement to execute.
param - The replacement parameter.
Returns:
A Future which returns the number of rows updated.
Throws:
SQLException - if a database access error occurs

update

public Future<Integer> update(String sql,
                              Object... params)
                       throws SQLException
Executes the given INSERT, UPDATE, or DELETE SQL statement. The Connection is retrieved from the DataSource set in the constructor. This Connection must be in auto-commit mode or the update will not be saved.

Parameters:
sql - The SQL statement to execute.
params - Initializes the PreparedStatement's IN (i.e. '?') parameters.
Returns:
A Future which returns the number of rows updated.
Throws:
SQLException - if a database access error occurs


Copyright © 2002-2011 The Apache Software Foundation. All Rights Reserved.