| java.lang.Object
 org.apache.commons.dbutils.QueryRunner
| QueryRunner | | public class QueryRunner (Code) | | 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. |
| Method Summary | |
| public int[] | batch(Connection conn, String sql, Object[][] params)
Execute a batch of SQL INSERT, UPDATE, or DELETE queries.
Parameters:
conn - The Connection to use to run the query. | | public 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(Statement stmt)
Close a Statement. | | protected void | close(ResultSet rs)
Close a ResultSet. | | protected void | fillStatement(PreparedStatement stmt, Object[] params)
Fill the PreparedStatement replacement parameters with
the given objects. | | public 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. | | public Object | query(Connection conn, String sql, Object param, ResultSetHandler rsh)
Execute an SQL SELECT query with a single replacement parameter. | | public Object | query(Connection conn, String sql, Object[] params, ResultSetHandler rsh)
Execute an SQL SELECT query with replacement parameters. | | public Object | query(Connection conn, String sql, ResultSetHandler rsh)
Execute an SQL SELECT query without any replacement parameters. | | public Object | query(String sql, Object param, ResultSetHandler rsh)
Executes the given SELECT SQL with a single replacement parameter.
The Connection is retrieved from the
DataSource set in the constructor.
Parameters:
sql - The SQL statement to execute.
Parameters:
param - The replacement parameter.
Parameters:
rsh - The handler used to create the result object from the ResultSet. | | public Object | query(String sql, Object[] params, ResultSetHandler rsh)
Executes the given SELECT SQL query and returns a result object.
The Connection is retrieved from the
DataSource set in the constructor.
Parameters:
sql - The SQL statement to execute.
Parameters:
params - Initialize the PreparedStatement's IN parameters with this array.
Parameters:
rsh - The handler used to create the result object from the ResultSet. | | public Object | query(String sql, ResultSetHandler rsh)
Executes the given SELECT SQL without any replacement parameters.
The Connection is retrieved from the
DataSource set in the constructor.
Parameters:
sql - The SQL statement to execute.
Parameters:
rsh - The handler used to create the result object from the ResultSet. | | protected void | rethrow(SQLException cause, String sql, Object[] params)
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. | | public void | setDataSource(DataSource dataSource)
Sets the DataSource this runner will use to get
database connections from. | | public int | update(Connection conn, String sql)
Execute an SQL INSERT, UPDATE, or DELETE query without replacement
parameters.
Parameters:
conn - The connection to use to run the query.
Parameters:
sql - The SQL to execute. | | public int | update(Connection conn, String sql, Object param)
Execute an SQL INSERT, UPDATE, or DELETE query with a single replacement
parameter.
Parameters:
conn - The connection to use to run the query.
Parameters:
sql - The SQL to execute.
Parameters:
param - The replacement parameter. | | public int | update(Connection conn, String sql, Object[] params)
Execute an SQL INSERT, UPDATE, or DELETE query.
Parameters:
conn - The connection to use to run the query.
Parameters:
sql - The SQL to execute.
Parameters:
params - The query replacement parameters. | | public int | update(String sql)
Executes the given INSERT, UPDATE, or DELETE SQL statement without
any replacement parameters. | | public int | update(String sql, Object param)
Executes the given INSERT, UPDATE, or DELETE SQL statement with
a single replacement parameter. | | public int | update(String sql, Object[] params)
Executes the given INSERT, UPDATE, or DELETE SQL statement. | | 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. |
| QueryRunner | | public QueryRunner()(Code) | | Constructor for QueryRunner.
|
| QueryRunner | | public QueryRunner(DataSource ds)(Code) | | Constructor for QueryRunner. Methods that do not take a
Connection parameter will retrieve connections from this
DataSource.
Parameters:
ds - The DataSource to retrieve connections from. |
| batch | | public int[] batch(Connection conn, String sql, Object[][] params) throws SQLException(Code) | | Execute a batch of SQL INSERT, UPDATE, or DELETE queries.
Parameters:
conn - The Connection to use to run the query. The caller isresponsible for closing this Connection.
Parameters:
sql - The SQL to execute.
Parameters:
params - An array of query replacement parameters. Each row inthis array is one set of batch replacement values. 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(Code) | | 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.
Parameters:
params - An array of query replacement parameters. Each row inthis array is one set of batch replacement values. The number of rows updated per statement.
throws:
SQLException - if a database access error occurs
since:
DbUtils 1.1 |
| close | | protected void close(Connection conn) throws SQLException(Code) | | 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(Code) | | 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(Code) | | Close a ResultSet. This implementation avoids closing if
null and does not suppress any exceptions. Subclasses
can override to provide special handling like logging.
throws:
SQLException - if a database access error occurs
Parameters:
rs - ResultSet to close
since:
DbUtils 1.1 |
| fillStatement | | protected void fillStatement(PreparedStatement stmt, Object[] params) throws SQLException(Code) | | Fill the PreparedStatement replacement parameters with
the given objects.
Parameters:
stmt - PreparedStatement to fill
Parameters:
params - Query replacement parameters; null is a validvalue to pass in.
throws:
SQLException - if a database access error occurs |
| getDataSource | | public DataSource getDataSource()(Code) | | Returns the DataSource this runner is using.
QueryRunner methods always call this method to get the
DataSource so subclasses can provide specialized
behavior.
DataSource the runner is using |
| prepareConnection | | protected Connection prepareConnection() throws SQLException(Code) | | 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().
An initialized Connection.
throws:
SQLException - if a database access error occurs
since:
DbUtils 1.1 |
| prepareStatement | | protected PreparedStatement prepareStatement(Connection conn, String sql) throws SQLException(Code) | | 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
Parameters:
sql - The SQL statement to prepare. An initialized PreparedStatement.
throws:
SQLException - if a database access error occurs |
| query | | public Object query(Connection conn, String sql, Object param, ResultSetHandler rsh) throws SQLException(Code) | | Execute an SQL SELECT query with a single replacement parameter. The
caller is responsible for closing the connection.
Parameters:
conn - The connection to execute the query in.
Parameters:
sql - The query to execute.
Parameters:
param - The replacement parameter.
Parameters:
rsh - The handler that converts the results into an object. The object returned by the handler.
throws:
SQLException - if a database access error occurs |
| query | | public Object query(Connection conn, String sql, Object[] params, ResultSetHandler rsh) throws SQLException(Code) | | Execute an SQL SELECT query with replacement parameters. The
caller is responsible for closing the connection.
Parameters:
conn - The connection to execute the query in.
Parameters:
sql - The query to execute.
Parameters:
params - The replacement parameters.
Parameters:
rsh - The handler that converts the results into an object. The object returned by the handler.
throws:
SQLException - if a database access error occurs |
| query | | public Object query(Connection conn, String sql, ResultSetHandler rsh) throws SQLException(Code) | | Execute an SQL SELECT query without any replacement parameters. The
caller is responsible for closing the connection.
Parameters:
conn - The connection to execute the query in.
Parameters:
sql - The query to execute.
Parameters:
rsh - The handler that converts the results into an object. The object returned by the handler.
throws:
SQLException - if a database access error occurs |
| query | | public Object query(String sql, Object param, ResultSetHandler rsh) throws SQLException(Code) | | Executes the given SELECT SQL with a single replacement parameter.
The Connection is retrieved from the
DataSource set in the constructor.
Parameters:
sql - The SQL statement to execute.
Parameters:
param - The replacement parameter.
Parameters:
rsh - The handler used to create the result object from the ResultSet. An object generated by the handler.
throws:
SQLException - if a database access error occurs |
| query | | public Object query(String sql, Object[] params, ResultSetHandler rsh) throws SQLException(Code) | | Executes the given SELECT SQL query and returns a result object.
The Connection is retrieved from the
DataSource set in the constructor.
Parameters:
sql - The SQL statement to execute.
Parameters:
params - Initialize the PreparedStatement's IN parameters with this array.
Parameters:
rsh - The handler used to create the result object from the ResultSet. An object generated by the handler.
throws:
SQLException - if a database access error occurs |
| query | | public Object query(String sql, ResultSetHandler rsh) throws SQLException(Code) | | Executes the given SELECT SQL without any replacement parameters.
The Connection is retrieved from the
DataSource set in the constructor.
Parameters:
sql - The SQL statement to execute.
Parameters:
rsh - The handler used to create the result object from the ResultSet. 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(Code) | | 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.
Parameters:
sql - The query that was executing when the exception happened.
Parameters:
params - The query replacement parameters; null is a valid value to pass in.
throws:
SQLException - if a database access error occurs |
| setDataSource | | public void setDataSource(DataSource dataSource)(Code) | | Sets the DataSource this runner will use to get
database connections from. This should be called after creating a
runner with the default constructor if you intend to use the
execute methods without passing in a Connection.
Parameters:
dataSource - The DataSource to use. |
| update | | public int update(Connection conn, String sql) throws SQLException(Code) | | Execute an SQL INSERT, UPDATE, or DELETE query without replacement
parameters.
Parameters:
conn - The connection to use to run the query.
Parameters:
sql - The SQL to execute. 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(Code) | | Execute an SQL INSERT, UPDATE, or DELETE query with a single replacement
parameter.
Parameters:
conn - The connection to use to run the query.
Parameters:
sql - The SQL to execute.
Parameters:
param - The replacement parameter. 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(Code) | | Execute an SQL INSERT, UPDATE, or DELETE query.
Parameters:
conn - The connection to use to run the query.
Parameters:
sql - The SQL to execute.
Parameters:
params - The query replacement parameters. The number of rows updated.
throws:
SQLException - if a database access error occurs |
| update | | public int update(String sql) throws SQLException(Code) | | 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.
throws:
SQLException - if a database access error occurs The number of rows updated. |
| update | | public int update(String sql, Object param) throws SQLException(Code) | | 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.
Parameters:
param - The replacement parameter.
throws:
SQLException - if a database access error occurs The number of rows updated. |
| update | | public int update(String sql, Object[] params) throws SQLException(Code) | | 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.
Parameters:
params - Initializes the PreparedStatement's IN (i.e. '?') parameters.
throws:
SQLException - if a database access error occurs The number of rows updated. |
| wrap | | protected ResultSet wrap(ResultSet rs)(Code) | | 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. The ResultSet wrapped in some decorator. |
|
|