QueryRunner (Commons DbUtils 1.3 API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.apache.commons.dbutils
Class QueryRunner

java.lang.Object
  org.apache.commons.dbutils.QueryRunner

public class QueryRunner
extends Object
extends Object

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

See Also:: ResultSetHandler

Field Summary
`protected DataSource`	`ds` The DataSource to retrieve connections from.

Constructor Summary
`QueryRunner()` Constructor for QueryRunner.
`QueryRunner(boolean pmdKnownBroken)` Constructor for QueryRunner, allows workaround for Oracle drivers
`QueryRunner(DataSource ds)` Constructor for QueryRunner, allows workaround for Oracle drivers.
`QueryRunner(DataSource ds, boolean pmdKnownBroken)` Constructor for QueryRunner, allows workaround for Oracle drivers.

Method Summary

int[] batch(Connection conn, String sql, Object[][] params)
Execute a batch of SQL INSERT, UPDATE, or DELETE queries.

int[] batch(String sql, Object[][] params)
Execute a batch of SQL INSERT, UPDATE, or DELETE queries.

protected void close(Connection conn)
Close a Connection.

protected void close(ResultSet rs)
Close a ResultSet.

protected void close(Statement stmt)
Close a Statement.

void fillStatement(PreparedStatement stmt, Object... params)
Fill the PreparedStatement replacement parameters with the given objects.

void fillStatementWithBean(PreparedStatement stmt, Object bean, PropertyDescriptor[] properties)
Fill the PreparedStatement replacement parameters with the given object's bean property values.

void fillStatementWithBean(PreparedStatement stmt, Object bean, String... propertyNames)
Fill the PreparedStatement replacement parameters with the given object's bean property values.

DataSource getDataSource()
Returns the DataSource this runner is using.

protected Connection prepareConnection()
Factory method that creates and initializes a Connection object.

protected PreparedStatement prepareStatement(Connection conn, String sql)
Factory method that creates and initializes a PreparedStatement object for the given SQL.





<T> T

query(Connection conn,
           String sql,
           Object[] params,
           ResultSetHandler<T> rsh)

Deprecated. Use query(Connection,String,ResultSetHandler,Object...) instead





<T> T

query(Connection conn,
           String sql,
           Object param,
           ResultSetHandler<T> rsh)

Deprecated. Use query(Connection, String, ResultSetHandler, Object...)





<T> T

query(Connection conn,
           String sql,
           ResultSetHandler<T> rsh)

Execute an SQL SELECT query without any replacement parameters.





<T> T

query(Connection conn,
           String sql,
           ResultSetHandler<T> rsh,
           Object... params)

Execute an SQL SELECT query with replacement parameters.





<T> T

query(String sql,
           Object[] params,
           ResultSetHandler<T> rsh)

Deprecated. Use query(String, ResultSetHandler, Object...)





<T> T

query(String sql,
           Object param,
           ResultSetHandler<T> rsh)

Deprecated. Use query(String, ResultSetHandler, Object...)





<T> T

query(String sql,
           ResultSetHandler<T> rsh)

Executes the given SELECT SQL without any replacement parameters.





<T> T

query(String sql,
           ResultSetHandler<T> rsh,
           Object... params)

Executes the given SELECT SQL query and returns a result object.

protected void rethrow(SQLException cause, String sql, Object... params)
Throws a new exception with a more informative error message.

int update(Connection conn, String sql)
Execute an SQL INSERT, UPDATE, or DELETE query without replacement parameters.

int update(Connection conn, String sql, Object... params)
Execute an SQL INSERT, UPDATE, or DELETE query.

int update(Connection conn, String sql, Object param)
Execute an SQL INSERT, UPDATE, or DELETE query with a single replacement parameter.

int update(String sql)
Executes the given INSERT, UPDATE, or DELETE SQL statement without any replacement parameters.

int update(String sql, Object... params)
Executes the given INSERT, UPDATE, or DELETE SQL statement.

int update(String sql, Object param)
Executes the given INSERT, UPDATE, or DELETE SQL statement with a single replacement parameter.

protected ResultSet wrap(ResultSet rs)
Wrap the ResultSet in a decorator before processing it.

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Field Detail

ds

protected final DataSource ds

The DataSource to retrieve connections from.

Constructor Detail

QueryRunner

public QueryRunner()

Constructor for QueryRunner.

QueryRunner

public QueryRunner(boolean pmdKnownBroken)

Constructor for QueryRunner, 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.

QueryRunner

public QueryRunner(DataSource ds)

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.

QueryRunner

public QueryRunner(DataSource ds,
                   boolean pmdKnownBroken)

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.

Method Detail

batch

public 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:: The number of rows updated per statement.
Throws:: SQLException - if a database access error occurs
Since:: DbUtils 1.1

batch

public 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:: The number of rows updated per statement.
Throws:: SQLException - if a database access error occurs
Since:: DbUtils 1.1

fillStatement

public void fillStatement(PreparedStatement stmt,
                          Object... params)
                   throws SQLException

Fill the PreparedStatement replacement parameters with the given objects.

Parameters:: stmt - PreparedStatement to fill; params - Query replacement parameters; null is a valid value to pass in.
Throws:: SQLException - if a database access error occurs

fillStatementWithBean

public void fillStatementWithBean(PreparedStatement stmt,
                                  Object bean,
                                  PropertyDescriptor[] properties)
                           throws SQLException

Fill the PreparedStatement replacement parameters with the given object's bean property values.

Parameters:: stmt - PreparedStatement to fill; bean - a JavaBean object; properties - an ordered array of properties; this gives the order to insert values in the statement
Throws:: SQLException - if a database access error occurs

fillStatementWithBean

public void fillStatementWithBean(PreparedStatement stmt,
                                  Object bean,
                                  String... propertyNames)
                           throws SQLException

Fill the PreparedStatement replacement parameters with the given object's bean property values.

Parameters:: stmt - PreparedStatement to fill; bean - a JavaBean object; propertyNames - an ordered array of property names (these should match the getters/setters); this gives the order to insert values in the statement
Throws:: SQLException - if a database access error occurs

getDataSource

public DataSource getDataSource()

Returns the DataSource this runner is using. QueryRunner methods always call this method to get the DataSource so subclasses can provide specialized behavior.

Returns:: DataSource the runner is using

prepareStatement

protected PreparedStatement prepareStatement(Connection conn,
                                             String sql)
                                      throws SQLException

Factory method that creates and initializes a PreparedStatement object for the given SQL. QueryRunner methods always call this method to prepare statements for them. Subclasses can override this method to provide special PreparedStatement configuration if needed. This implementation simply calls conn.prepareStatement(sql).

Parameters:: conn - The Connection used to create the PreparedStatement; sql - The SQL statement to prepare.
Returns:: An initialized PreparedStatement.
Throws:: SQLException - if a database access error occurs

prepareConnection

protected Connection prepareConnection()
                                throws SQLException

Factory method that creates and initializes a Connection object. QueryRunner methods always call this method to retrieve connections from its DataSource. Subclasses can override this method to provide special Connection configuration if needed. This implementation simply calls ds.getConnection().

Returns:: An initialized Connection.
Throws:: SQLException - if a database access error occurs
Since:: DbUtils 1.1

query

public <T> T query(Connection conn,
                   String sql,
                   Object param,
                   ResultSetHandler<T> rsh)
        throws SQLException

Deprecated. Use query(Connection, String, ResultSetHandler, Object...)

Execute an SQL SELECT query with a single replacement parameter. 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.; param - The replacement parameter.; rsh - The handler that converts the results into an object.
Returns:: The object returned by the handler.
Throws:: SQLException - if a database access error occurs

query

public <T> T query(Connection conn,
                   String sql,
                   Object[] params,
                   ResultSetHandler<T> rsh)
        throws SQLException

Deprecated. Use query(Connection,String,ResultSetHandler,Object...) instead

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.; params - The replacement parameters.; rsh - The handler that converts the results into an object.
Returns:: The object returned by the handler.
Throws:: SQLException - if a database access error occurs

query

public <T> 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:: The object returned by the handler.
Throws:: SQLException - if a database access error occurs

query

public <T> 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:: The object returned by the handler.
Throws:: SQLException - if a database access error occurs

query

public <T> T query(String sql,
                   Object param,
                   ResultSetHandler<T> rsh)
        throws SQLException

Deprecated. Use query(String, ResultSetHandler, Object...)

Executes the given SELECT SQL with a single replacement parameter. 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.; param - The replacement parameter.; rsh - The handler used to create the result object from the ResultSet.
Returns:: An object generated by the handler.
Throws:: SQLException - if a database access error occurs

query

public <T> T query(String sql,
                   Object[] params,
                   ResultSetHandler<T> rsh)
        throws SQLException

Deprecated. Use query(String, ResultSetHandler, Object...)

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.; params - Initialize the PreparedStatement's IN parameters with this array.; rsh - The handler used to create the result object from the ResultSet.
Returns:: An object generated by the handler.
Throws:: SQLException - if a database access error occurs

query

public <T> 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:: An object generated by the handler.
Throws:: SQLException - if a database access error occurs

query

public <T> 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:: An object generated by the handler.
Throws:: SQLException - if a database access error occurs

rethrow

protected void rethrow(SQLException cause,
                       String sql,
                       Object... params)
                throws SQLException

Throws a new exception with a more informative error message.

Parameters:: cause - The original exception that will be chained to the new exception when it's rethrown.; sql - The query that was executing when the exception happened.; params - The query replacement parameters; null is a valid value to pass in.
Throws:: SQLException - if a database access error occurs

update

public int 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:: The number of rows updated.
Throws:: SQLException - if a database access error occurs

update

public int 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:: The number of rows updated.
Throws:: SQLException - if a database access error occurs

update

public int 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:: The number of rows updated.
Throws:: SQLException - if a database access error occurs

update

public int 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:: The number of rows updated.
Throws:: SQLException - if a database access error occurs

update

public int 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:: The number of rows updated.
Throws:: SQLException - if a database access error occurs

update

public int 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:: The number of rows updated.
Throws:: SQLException - if a database access error occurs

wrap

protected ResultSet wrap(ResultSet rs)

Wrap the ResultSet in a decorator before processing it. This implementation returns the ResultSet it is given without any decoration.

Often, the implementation of this method can be done in an anonymous inner class like this:

 
 QueryRunner run = new QueryRunner() {
     protected ResultSet wrap(ResultSet rs) {
         return StringTrimmedResultSet.wrap(rs);
     }
 };

Parameters:: rs - The ResultSet to decorate; never null.
Returns:: The ResultSet wrapped in some decorator.

close

protected void close(Connection conn)
              throws SQLException

Close a Connection. This implementation avoids closing if null and does not suppress any exceptions. Subclasses can override to provide special handling like logging.

Parameters:: conn - Connection to close
Throws:: SQLException - if a database access error occurs
Since:: DbUtils 1.1

close

protected void close(Statement stmt)
              throws SQLException

Close a Statement. This implementation avoids closing if null and does not suppress any exceptions. Subclasses can override to provide special handling like logging.

Parameters:: stmt - Statement to close
Throws:: SQLException - if a database access error occurs
Since:: DbUtils 1.1

close

protected void close(ResultSet rs)
              throws SQLException

Close a ResultSet. This implementation avoids closing if null and does not suppress any exceptions. Subclasses can override to provide special handling like logging.

Parameters:: rs - ResultSet to close
Throws:: SQLException - if a database access error occurs
Since:: DbUtils 1.1

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.apache.commons.dbutils Class QueryRunner

ds

QueryRunner

QueryRunner

QueryRunner

QueryRunner

batch

batch

fillStatement

fillStatementWithBean

fillStatementWithBean

getDataSource

prepareStatement

prepareConnection

query

query

query

query

query

query

query

query

rethrow

update

update

update

update

update

update

wrap

close

close

close

org.apache.commons.dbutils
Class QueryRunner