|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.springframework.jdbc.support.JdbcAccessor
org.springframework.jdbc.core.JdbcTemplate
public class JdbcTemplate
This is the central class in the JDBC core package.
It simplifies the use of JDBC and helps to avoid common errors.
It executes core JDBC workflow, leaving application code to provide SQL
and extract results. This class executes SQL queries or updates, initiating
iteration over ResultSets and catching JDBC exceptions and translating
them to the generic, more informative exception hierarchy defined in the
org.springframework.dao
package.
Code using this class need only implement callback interfaces, giving
them a clearly defined contract. The PreparedStatementCreator
callback
interface creates a prepared statement given a Connection, providing SQL and
any necessary parameters. The ResultSetExtractor
interface extracts
values from a ResultSet. See also PreparedStatementSetter
and
RowMapper
for two popular alternative callback interfaces.
Can be used within a service implementation via direct instantiation with a DataSource reference, or get prepared in an application context and given to services as bean reference. Note: The DataSource should always be configured as a bean in the application context, in the first case given to the service directly, in the second case to the prepared template.
Because this class is parameterizable by the callback interfaces and
the SQLExceptionTranslator
interface, there should be no need to subclass it.
All operations performed by this class are logged at debug level.
The motivation and design of this class is discussed in detail in Expert One-On-One J2EE Design and Development by Rod Johnson (Wrox, 2002).
PreparedStatementCreator
,
PreparedStatementSetter
,
CallableStatementCreator
,
PreparedStatementCallback
,
CallableStatementCallback
,
ResultSetExtractor
,
RowCallbackHandler
,
RowMapper
,
SQLExceptionTranslator
Field Summary |
---|
Fields inherited from class org.springframework.jdbc.support.JdbcAccessor |
---|
logger |
Constructor Summary | |
---|---|
JdbcTemplate()
Construct a new JdbcTemplate for bean usage. |
|
JdbcTemplate(DataSource dataSource)
Construct a new JdbcTemplate, given a DataSource to obtain connections from. |
|
JdbcTemplate(DataSource dataSource,
boolean lazyInit)
Construct a new JdbcTemplate, given a DataSource to obtain connections from. |
Method Summary | |
---|---|
protected void |
applyStatementSettings(Statement stmt)
Prepare the given JDBC Statement (or PreparedStatement or CallableStatement), applying statement settings such as fetch size, max rows, and query timeout. |
int[] |
batchUpdate(String[] sql)
Issue multiple SQL updates on a single Statement, using JDBC 2.0 batching. |
int[] |
batchUpdate(String sql,
BatchPreparedStatementSetter pss)
Issue multiple updates on a single PreparedStatement, using JDBC 2.0 batch updates and a BatchPreparedStatementSetter to set values. |
Map |
call(CallableStatementCreator csc,
List declaredParameters)
Execute a SQL call using a CallableStatementCreator to provide SQL and any required parameters. |
protected Connection |
createConnectionProxy(Connection con)
Create a close-suppressing proxy for the given JDBC Connection. |
Object |
execute(CallableStatementCreator csc,
CallableStatementCallback action)
Execute a JDBC data access operation, implemented as callback action working on a JDBC CallableStatement. |
Object |
execute(ConnectionCallback action)
Execute a JDBC data access operation, implemented as callback action working on a JDBC Connection. |
Object |
execute(PreparedStatementCreator psc,
PreparedStatementCallback action)
Execute a JDBC data access operation, implemented as callback action working on a JDBC PreparedStatement. |
Object |
execute(StatementCallback action)
Execute a JDBC data access operation, implemented as callback action working on a JDBC Statement. |
void |
execute(String sql)
Issue a single SQL execute, typically a DDL statement. |
Object |
execute(String callString,
CallableStatementCallback action)
Execute a JDBC data access operation, implemented as callback action working on a JDBC CallableStatement. |
Object |
execute(String sql,
PreparedStatementCallback action)
Execute a JDBC data access operation, implemented as callback action working on a JDBC PreparedStatement. |
protected Map |
extractOutputParameters(CallableStatement cs,
List parameters)
Extract output parameters from the completed stored procedure. |
protected Map |
extractReturnedResultSets(CallableStatement cs,
List parameters,
int updateCount)
Extract returned ResultSets from the completed stored procedure. |
protected RowMapper |
getColumnMapRowMapper()
Create a new RowMapper for reading columns as key-value pairs. |
int |
getFetchSize()
Return the fetch size specified for this JdbcTemplate. |
int |
getMaxRows()
Return the maximum number of rows specified for this JdbcTemplate. |
NativeJdbcExtractor |
getNativeJdbcExtractor()
Return the current NativeJdbcExtractor implementation. |
protected RowMapper |
getSingleColumnRowMapper(Class requiredType)
Create a new RowMapper for reading result objects from a single column. |
protected void |
handleWarnings(SQLWarning warning)
Throw an SQLWarningException if we're not ignoring warnings. |
boolean |
isIgnoreWarnings()
Return whether or not we ignore SQLWarnings. |
protected Map |
processResultSet(ResultSet rs,
ResultSetSupportingSqlParameter param)
Process the given ResultSet from a stored procedure. |
Object |
query(PreparedStatementCreator psc,
PreparedStatementSetter pss,
ResultSetExtractor rse)
Query using a prepared statement, allowing for a PreparedStatementCreator and a PreparedStatementSetter. |
Object |
query(PreparedStatementCreator psc,
ResultSetExtractor rse)
Query using a prepared statement, reading the ResultSet with a ResultSetExtractor. |
List |
query(PreparedStatementCreator psc,
RowCallbackHandler rch)
Query using a prepared statement, reading the ResultSet on a per-row basis with a RowCallbackHandler (potentially implementing the ResultReader A PreparedStatementCreator can either be implemented directly or configured through a PreparedStatementCreatorFactory. |
List |
query(PreparedStatementCreator psc,
RowMapper rowMapper)
Query using a prepared statement, mapping each row to a Java object via a RowMapper. |
Object |
query(String sql,
Object[] args,
int[] argTypes,
ResultSetExtractor rse)
Query given SQL to create a prepared statement from SQL and a list of arguments to bind to the query, reading the ResultSet with a ResultSetExtractor. |
List |
query(String sql,
Object[] args,
int[] argTypes,
RowCallbackHandler rch)
Query given SQL to create a prepared statement from SQL and a list of arguments to bind to the query, reading the ResultSet on a per-row basis with a RowCallbackHandler (potentially implementing the ResultReader sub-interface that provides a result List). |
List |
query(String sql,
Object[] args,
int[] argTypes,
RowMapper rowMapper)
Query given SQL to create a prepared statement from SQL and a list of arguments to bind to the query, mapping each row to a Java object via a RowMapper. |
Object |
query(String sql,
Object[] args,
ResultSetExtractor rse)
Query given SQL to create a prepared statement from SQL and a list of arguments to bind to the query, reading the ResultSet with a ResultSetExtractor. |
List |
query(String sql,
Object[] args,
RowCallbackHandler rch)
Query given SQL to create a prepared statement from SQL and a list of arguments to bind to the query, reading the ResultSet on a per-row basis with a RowCallbackHandler (potentially implementing the ResultReader sub-interface that provides a result List). |
List |
query(String sql,
Object[] args,
RowMapper rowMapper)
Query given SQL to create a prepared statement from SQL and a list of arguments to bind to the query, mapping each row to a Java object via a RowMapper. |
Object |
query(String sql,
PreparedStatementSetter pss,
ResultSetExtractor rse)
Query using a prepared statement, reading the ResultSet with a ResultSetExtractor. |
List |
query(String sql,
PreparedStatementSetter pss,
RowCallbackHandler rch)
Query given SQL to create a prepared statement from SQL and a PreparedStatementSetter implementation that knows how to bind values to the query, reading the ResultSet on a per-row basis with a RowCallbackHandler (potentially implementing the ResultReader sub-interface that provides a result List). |
List |
query(String sql,
PreparedStatementSetter pss,
RowMapper rowMapper)
Query given SQL to create a prepared statement from SQL and a PreparedStatementSetter implementation that knows how to bind values to the query, mapping each row to a Java object via a RowMapper. |
Object |
query(String sql,
ResultSetExtractor rse)
Execute a query given static SQL, reading the ResultSet with a ResultSetExtractor. |
List |
query(String sql,
RowCallbackHandler rch)
Execute a query given static SQL, reading the ResultSet on a per-row basis with a RowCallbackHandler (potentially implementing the ResultReader sub-interface that provides a result List). |
List |
query(String sql,
RowMapper rowMapper)
Execute a query given static SQL, mapping each row to a Java object via a RowMapper. |
int |
queryForInt(String sql)
Execute a query that results in an int value, given static SQL. |
int |
queryForInt(String sql,
Object[] args)
Query given SQL to create a prepared statement from SQL and a list of arguments to bind to the query, resulting in an int value. |
int |
queryForInt(String sql,
Object[] args,
int[] argTypes)
Query given SQL to create a prepared statement from SQL and a list of arguments to bind to the query, resulting in an int value. |
List |
queryForList(String sql)
Execute a query for a result list, given static SQL. |
List |
queryForList(String sql,
Class elementType)
Execute a query for a result list, given static SQL. |
List |
queryForList(String sql,
Object[] args)
Query given SQL to create a prepared statement from SQL and a list of arguments to bind to the query, expecting a result list. |
List |
queryForList(String sql,
Object[] args,
Class elementType)
Query given SQL to create a prepared statement from SQL and a list of arguments to bind to the query, expecting a result list. |
List |
queryForList(String sql,
Object[] args,
int[] argTypes)
Query given SQL to create a prepared statement from SQL and a list of arguments to bind to the query, expecting a result list. |
List |
queryForList(String sql,
Object[] args,
int[] argTypes,
Class elementType)
Query given SQL to create a prepared statement from SQL and a list of arguments to bind to the query, expecting a result list. |
long |
queryForLong(String sql)
Execute a query that results in a long value, given static SQL. |
long |
queryForLong(String sql,
Object[] args)
Query given SQL to create a prepared statement from SQL and a list of arguments to bind to the query, resulting in a long value. |
long |
queryForLong(String sql,
Object[] args,
int[] argTypes)
Query given SQL to create a prepared statement from SQL and a list of arguments to bind to the query, resulting in a long value. |
Map |
queryForMap(String sql)
Execute a query for a result Map, given static SQL. |
Map |
queryForMap(String sql,
Object[] args)
Query given SQL to create a prepared statement from SQL and a list of arguments to bind to the query, expecting a result Map. |
Map |
queryForMap(String sql,
Object[] args,
int[] argTypes)
Query given SQL to create a prepared statement from SQL and a list of arguments to bind to the query, expecting a result Map. |
Object |
queryForObject(String sql,
Class requiredType)
Execute a query for a result object, given static SQL. |
Object |
queryForObject(String sql,
Object[] args,
Class requiredType)
Query given SQL to create a prepared statement from SQL and a list of arguments to bind to the query, expecting a result object. |
Object |
queryForObject(String sql,
Object[] args,
int[] argTypes,
Class requiredType)
Query given SQL to create a prepared statement from SQL and a list of arguments to bind to the query, expecting a result object. |
Object |
queryForObject(String sql,
Object[] args,
int[] argTypes,
RowMapper rowMapper)
Query given SQL to create a prepared statement from SQL and a list of arguments to bind to the query, mapping a single result row to a Java object via a RowMapper. |
Object |
queryForObject(String sql,
Object[] args,
RowMapper rowMapper)
Query given SQL to create a prepared statement from SQL and a list of arguments to bind to the query, mapping a single result row to a Java object via a RowMapper. |
Object |
queryForObject(String sql,
RowMapper rowMapper)
Execute a query given static SQL, mapping a single result row to a Java object via a RowMapper. |
SqlRowSet |
queryForRowSet(String sql)
Execute a query for a SqlRowSet, given static SQL. |
SqlRowSet |
queryForRowSet(String sql,
Object[] args)
Query given SQL to create a prepared statement from SQL and a list of arguments to bind to the query, expecting a SqlRowSet. |
SqlRowSet |
queryForRowSet(String sql,
Object[] args,
int[] argTypes)
Query given SQL to create a prepared statement from SQL and a list of arguments to bind to the query, expecting a SqlRowSet. |
void |
setFetchSize(int fetchSize)
Set the fetch size for this JdbcTemplate. |
void |
setIgnoreWarnings(boolean ignoreWarnings)
Set whether or not we want to ignore SQLWarnings. |
void |
setMaxRows(int maxRows)
Set the maximum number of rows for this JdbcTemplate. |
void |
setNativeJdbcExtractor(NativeJdbcExtractor extractor)
Set a NativeJdbcExtractor to extract native JDBC objects from wrapped handles. |
int |
update(PreparedStatementCreator psc)
Issue an update using a PreparedStatementCreator to provide SQL and any required parameters. |
int |
update(PreparedStatementCreator psc,
KeyHolder generatedKeyHolder)
Issue an update using a PreparedStatementCreator to provide SQL and any required parameters. |
protected int |
update(PreparedStatementCreator psc,
PreparedStatementSetter pss)
|
int |
update(String sql)
Issue a single SQL update. |
int |
update(String sql,
Object[] args)
Issue an update via a prepared statement, binding the given arguments. |
int |
update(String sql,
Object[] args,
int[] argTypes)
Issue an update via a prepared statement, binding the given arguments. |
int |
update(String sql,
PreparedStatementSetter pss)
Issue an update using a PreparedStatementSetter to set bind parameters, with given SQL. |
Methods inherited from class org.springframework.jdbc.support.JdbcAccessor |
---|
afterPropertiesSet, getDataSource, getExceptionTranslator, isLazyInit, setDatabaseProductName, setDataSource, setExceptionTranslator, setLazyInit |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public JdbcTemplate()
JdbcAccessor.setDataSource(javax.sql.DataSource)
public JdbcTemplate(DataSource dataSource)
dataSource
- JDBC DataSource to obtain connections frompublic JdbcTemplate(DataSource dataSource, boolean lazyInit)
dataSource
- JDBC DataSource to obtain connections fromlazyInit
- whether to lazily initialize the SQLExceptionTranslatorMethod Detail |
---|
public void setNativeJdbcExtractor(NativeJdbcExtractor extractor)
public NativeJdbcExtractor getNativeJdbcExtractor()
public void setIgnoreWarnings(boolean ignoreWarnings)
Default is "true", swallowing and logging all warnings. Switch this flag to "false" to make the JdbcTemplate throw a SQLWarningException instead.
SQLWarning
,
SQLWarningException
,
handleWarnings(java.sql.SQLWarning)
public boolean isIgnoreWarnings()
public void setFetchSize(int fetchSize)
Default is 0, indicating to use the JDBC driver's default.
Statement.setFetchSize(int)
public int getFetchSize()
public void setMaxRows(int maxRows)
Default is 0, indicating to use the JDBC driver's default.
Statement.setMaxRows(int)
public int getMaxRows()
public Object execute(ConnectionCallback action) throws DataAccessException
JdbcOperations
The callback action can return a result object, for example a domain object or a collection of domain objects.
execute
in interface JdbcOperations
action
- the callback object that specifies the action
null
DataAccessException
- if there is any problemprotected Connection createConnectionProxy(Connection con)
execute
method.
The proxy also prepares returned JDBC Statements, applying statement settings such as fetch size, max rows, and query timeout.
con
- the JDBC Connection to create a proxy for
Connection.close()
,
execute(ConnectionCallback)
,
applyStatementSettings(java.sql.Statement)
public Object execute(StatementCallback action) throws DataAccessException
JdbcOperations
The callback action can return a result object, for example a domain object or a collection of domain objects.
execute
in interface JdbcOperations
action
- callback object that specifies the action
null
DataAccessException
- if there is any problempublic void execute(String sql) throws DataAccessException
JdbcOperations
execute
in interface JdbcOperations
sql
- static SQL to execute
DataAccessException
- if there is any problempublic Object query(String sql, ResultSetExtractor rse) throws DataAccessException
JdbcOperations
Uses a JDBC Statement, not a PreparedStatement. If you want to
execute a static query with a PreparedStatement, use the overloaded
query
method with null
as argument array.
query
in interface JdbcOperations
sql
- SQL query to executerse
- object that will extract all rows of results
DataAccessException
- if there is any problem executing the queryJdbcOperations.query(String, Object[], ResultSetExtractor)
public List query(String sql, RowCallbackHandler rch) throws DataAccessException
JdbcOperations
Uses a JDBC Statement, not a PreparedStatement. If you want to
execute a static query with a PreparedStatement, use the overloaded
query
method with null
as argument array.
query
in interface JdbcOperations
sql
- SQL query to executerch
- object that will extract results, one row at a time
null
else
DataAccessException
- if there is any problem executing the queryJdbcOperations.query(String, Object[], RowCallbackHandler)
,
ResultReader
public List query(String sql, RowMapper rowMapper) throws DataAccessException
JdbcOperations
Uses a JDBC Statement, not a PreparedStatement. If you want to
execute a static query with a PreparedStatement, use the overloaded
query
method with null
as argument array.
query
in interface JdbcOperations
sql
- SQL query to executerowMapper
- object that will map one object per row
DataAccessException
- if there is any problem executing the queryJdbcOperations.query(String, Object[], RowMapper)
public Map queryForMap(String sql) throws DataAccessException
JdbcOperations
Uses a JDBC Statement, not a PreparedStatement. If you want to
execute a static query with a PreparedStatement, use the overloaded
queryForMap
method with null
as argument array.
The query is expected to be a single row query; the result row will be mapped to a Map (one entry for each column, using the column name as the key).
queryForMap
in interface JdbcOperations
sql
- SQL query to execute
IncorrectResultSizeDataAccessException
- if the query does not
return exactly one row
DataAccessException
- if there is any problem executing the queryJdbcOperations.queryForMap(String, Object[])
,
ColumnMapRowMapper
public Object queryForObject(String sql, RowMapper rowMapper) throws DataAccessException
JdbcOperations
Uses a JDBC Statement, not a PreparedStatement. If you want to
execute a static query with a PreparedStatement, use the overloaded
queryForObject
method with null
as argument array.
queryForObject
in interface JdbcOperations
sql
- SQL query to executerowMapper
- object that will map one object per row
IncorrectResultSizeDataAccessException
- if the query does not
return exactly one row
DataAccessException
- if there is any problem executing the queryJdbcOperations.queryForObject(String, Object[], RowMapper)
public Object queryForObject(String sql, Class requiredType) throws DataAccessException
JdbcOperations
Uses a JDBC Statement, not a PreparedStatement. If you want to
execute a static query with a PreparedStatement, use the overloaded
queryForObject
method with null
as argument array.
This method is useful for running static SQL with a known outcome. The query is expected to be a single row/single column query; the returned result will be directly mapped to the corresponding object type.
queryForObject
in interface JdbcOperations
sql
- SQL query to executerequiredType
- the type that the result object is expected to match
null
in case of SQL NULL
IncorrectResultSizeDataAccessException
- if the query does not return
exactly one row, or does not return exactly one column in that row
DataAccessException
- if there is any problem executing the queryJdbcOperations.queryForObject(String, Object[], Class)
public long queryForLong(String sql) throws DataAccessException
JdbcOperations
Uses a JDBC Statement, not a PreparedStatement. If you want to
execute a static query with a PreparedStatement, use the overloaded
queryForLong
method with null
as argument array.
This method is useful for running static SQL with a known outcome. The query is expected to be a single row/single column query that results in a long value.
queryForLong
in interface JdbcOperations
sql
- SQL query to execute
IncorrectResultSizeDataAccessException
- if the query does not return
exactly one row, or does not return exactly one column in that row
DataAccessException
- if there is any problem executing the queryJdbcOperations.queryForLong(String, Object[])
public int queryForInt(String sql) throws DataAccessException
JdbcOperations
Uses a JDBC Statement, not a PreparedStatement. If you want to
execute a static query with a PreparedStatement, use the overloaded
queryForInt
method with null
as argument array.
This method is useful for running static SQL with a known outcome. The query is expected to be a single row/single column query that results in an int value.
queryForInt
in interface JdbcOperations
sql
- SQL query to execute
IncorrectResultSizeDataAccessException
- if the query does not return
exactly one row, or does not return exactly one column in that row
DataAccessException
- if there is any problem executing the queryJdbcOperations.queryForInt(String, Object[])
public List queryForList(String sql, Class elementType) throws DataAccessException
JdbcOperations
Uses a JDBC Statement, not a PreparedStatement. If you want to
execute a static query with a PreparedStatement, use the overloaded
queryForList
method with null
as argument array.
The results will be mapped to a List (one entry for each row) of result objects, each of them matching the specified element type.
queryForList
in interface JdbcOperations
sql
- SQL query to executeelementType
- the required type of element in the result list
(for example, Integer.class
)
DataAccessException
- if there is any problem executing the queryJdbcOperations.queryForList(String, Object[], Class)
,
SingleColumnRowMapper
public List queryForList(String sql) throws DataAccessException
JdbcOperations
Uses a JDBC Statement, not a PreparedStatement. If you want to
execute a static query with a PreparedStatement, use the overloaded
queryForList
method with null
as argument array.
The results will be mapped to a List (one entry for each row) of Maps (one entry for each column using the column name as the key). Each element in the list will be of the form returned by this interface's queryForMap() methods.
queryForList
in interface JdbcOperations
sql
- SQL query to execute
DataAccessException
- if there is any problem executing the queryJdbcOperations.queryForList(String, Object[])
public SqlRowSet queryForRowSet(String sql) throws DataAccessException
JdbcOperations
Uses a JDBC Statement, not a PreparedStatement. If you want to
execute a static query with a PreparedStatement, use the overloaded
queryForRowSet
method with null
as argument array.
The results will be mapped to an SqlRowSet which holds the data in a disconnected fashion. This wrapper will translate any SQLExceptions thrown.
Note that that, for the default implementation, JDBC RowSet support needs to
be available at runtime: by default, Sun's com.sun.rowset.CachedRowSetImpl
class is used, which is part of JDK 1.5+ and also available separately as part of
Sun's JDBC RowSet Implementations download (rowset.jar).
queryForRowSet
in interface JdbcOperations
sql
- SQL query to execute
javax.sql.rowset.CachedRowSet
)
DataAccessException
- if there is any problem executing the queryJdbcOperations.queryForRowSet(String, Object[])
,
SqlRowSetResultSetExtractor
,
CachedRowSet
public int update(String sql) throws DataAccessException
JdbcOperations
update
in interface JdbcOperations
sql
- static SQL to execute
DataAccessException
- if there is any problem.public int[] batchUpdate(String[] sql) throws DataAccessException
JdbcOperations
Will fall back to separate updates on a single Statement if the JDBC driver does not support batch updates.
batchUpdate
in interface JdbcOperations
sql
- defining an array of SQL statements that will be executed.
DataAccessException
- if there is any problem executing the batchpublic Object execute(PreparedStatementCreator psc, PreparedStatementCallback action) throws DataAccessException
JdbcOperations
The callback action can return a result object, for example a domain object or a collection of domain objects.
execute
in interface JdbcOperations
psc
- object that can create a PreparedStatement given a Connectionaction
- callback object that specifies the action
null
DataAccessException
- if there is any problempublic Object execute(String sql, PreparedStatementCallback action) throws DataAccessException
JdbcOperations
The callback action can return a result object, for example a domain object or a collection of domain objects.
execute
in interface JdbcOperations
sql
- SQL to executeaction
- callback object that specifies the action
null
DataAccessException
- if there is any problempublic Object query(PreparedStatementCreator psc, PreparedStatementSetter pss, ResultSetExtractor rse) throws DataAccessException
psc
- Callback handler that can create a PreparedStatement given a
Connectionpss
- object that knows how to set values on the prepared statement.
If this is null, the SQL will be assumed to contain no bind parameters.rse
- object that will extract results.
DataAccessException
- if there is any problempublic Object query(PreparedStatementCreator psc, ResultSetExtractor rse) throws DataAccessException
JdbcOperations
A PreparedStatementCreator can either be implemented directly or configured through a PreparedStatementCreatorFactory.
query
in interface JdbcOperations
psc
- object that can create a PreparedStatement given a Connectionrse
- object that will extract results
DataAccessException
- if there is any problemPreparedStatementCreatorFactory
public Object query(String sql, PreparedStatementSetter pss, ResultSetExtractor rse) throws DataAccessException
JdbcOperations
query
in interface JdbcOperations
sql
- SQL query to executepss
- object that knows how to set values on the prepared statement.
If this is null
, the SQL will be assumed to contain no bind parameters.
Even if there are no bind parameters, this object may be used to
set fetch size and other performance options.rse
- object that will extract results
DataAccessException
- if there is any problempublic Object query(String sql, Object[] args, int[] argTypes, ResultSetExtractor rse) throws DataAccessException
JdbcOperations
query
in interface JdbcOperations
sql
- SQL query to executeargs
- arguments to bind to the queryargTypes
- SQL types of the arguments
(constants from java.sql.Types
)rse
- object that will extract results
DataAccessException
- if the query failsTypes
public Object query(String sql, Object[] args, ResultSetExtractor rse) throws DataAccessException
JdbcOperations
query
in interface JdbcOperations
sql
- SQL query to executeargs
- arguments to bind to the query
(leaving it to the PreparedStatement to guess the corresponding SQL type)rse
- object that will extract results
DataAccessException
- if the query failspublic List query(PreparedStatementCreator psc, RowCallbackHandler rch) throws DataAccessException
JdbcOperations
A PreparedStatementCreator can either be implemented directly or configured through a PreparedStatementCreatorFactory.
query
in interface JdbcOperations
psc
- object that can create a PreparedStatement given a Connectionrch
- object that will extract results (potentially a ResultReader),
one row at a time
null
else
DataAccessException
- if there is any problemPreparedStatementCreatorFactory
public List query(String sql, PreparedStatementSetter pss, RowCallbackHandler rch) throws DataAccessException
JdbcOperations
query
in interface JdbcOperations
sql
- SQL query to executepss
- object that knows how to set values on the prepared statement.
If this is null
, the SQL will be assumed to contain no bind parameters.
Even if there are no bind parameters, this object may be used to
set fetch size and other performance options.rch
- object that will extract results (potentially a ResultReader),
one row at a time
null
else
DataAccessException
- if the query failsResultReader
public List query(String sql, Object[] args, int[] argTypes, RowCallbackHandler rch) throws DataAccessException
JdbcOperations
query
in interface JdbcOperations
sql
- SQL query to executeargs
- arguments to bind to the queryargTypes
- SQL types of the arguments
(constants from java.sql.Types
)rch
- object that will extract results (potentially a ResultReader),
one row at a time
null
else
DataAccessException
- if the query failsResultReader
,
Types
public List query(String sql, Object[] args, RowCallbackHandler rch) throws DataAccessException
JdbcOperations
query
in interface JdbcOperations
sql
- SQL query to executeargs
- arguments to bind to the query
(leaving it to the PreparedStatement to guess the corresponding SQL type)rch
- object that will extract results (potentially a ResultReader),
one row at a time
null
else
DataAccessException
- if the query failsResultReader
public List query(PreparedStatementCreator psc, RowMapper rowMapper) throws DataAccessException
JdbcOperations
A PreparedStatementCreator can either be implemented directly or configured through a PreparedStatementCreatorFactory.
query
in interface JdbcOperations
psc
- object that can create a PreparedStatement given a ConnectionrowMapper
- object that will map one object per row
DataAccessException
- if there is any problemPreparedStatementCreatorFactory
public List query(String sql, PreparedStatementSetter pss, RowMapper rowMapper) throws DataAccessException
JdbcOperations
query
in interface JdbcOperations
sql
- SQL query to executepss
- object that knows how to set values on the prepared statement.
If this is null
, the SQL will be assumed to contain no bind parameters.
Even if there are no bind parameters, this object may be used to
set fetch size and other performance options.rowMapper
- object that will map one object per row
DataAccessException
- if the query failspublic List query(String sql, Object[] args, int[] argTypes, RowMapper rowMapper) throws DataAccessException
JdbcOperations
query
in interface JdbcOperations
sql
- SQL query to executeargs
- arguments to bind to the queryargTypes
- SQL types of the arguments
(constants from java.sql.Types
)rowMapper
- object that will map one object per row
DataAccessException
- if the query failsTypes
public List query(String sql, Object[] args, RowMapper rowMapper) throws DataAccessException
JdbcOperations
query
in interface JdbcOperations
sql
- SQL query to executeargs
- arguments to bind to the query
(leaving it to the PreparedStatement to guess the corresponding SQL type)rowMapper
- object that will map one object per row
DataAccessException
- if the query failspublic Object queryForObject(String sql, Object[] args, int[] argTypes, RowMapper rowMapper) throws DataAccessException
JdbcOperations
queryForObject
in interface JdbcOperations
sql
- SQL query to executeargs
- arguments to bind to the query
(leaving it to the PreparedStatement to guess the corresponding SQL type)argTypes
- SQL types of the arguments
(constants from java.sql.Types
)rowMapper
- object that will map one object per row
IncorrectResultSizeDataAccessException
- if the query does not
return exactly one row
DataAccessException
- if the query failspublic Object queryForObject(String sql, Object[] args, RowMapper rowMapper) throws DataAccessException
JdbcOperations
queryForObject
in interface JdbcOperations
sql
- SQL query to executeargs
- arguments to bind to the query
(leaving it to the PreparedStatement to guess the corresponding SQL type)rowMapper
- object that will map one object per row
IncorrectResultSizeDataAccessException
- if the query does not
return exactly one row
DataAccessException
- if the query failspublic Object queryForObject(String sql, Object[] args, int[] argTypes, Class requiredType) throws DataAccessException
JdbcOperations
The query is expected to be a single row/single column query; the returned result will be directly mapped to the corresponding object type.
queryForObject
in interface JdbcOperations
sql
- SQL query to executeargs
- arguments to bind to the queryargTypes
- SQL types of the arguments
(constants from java.sql.Types
)requiredType
- the type that the result object is expected to match
null
in case of SQL NULL
IncorrectResultSizeDataAccessException
- if the query does not return
exactly one row, or does not return exactly one column in that row
DataAccessException
- if the query failsJdbcOperations.queryForObject(String, Class)
,
Types
public Object queryForObject(String sql, Object[] args, Class requiredType) throws DataAccessException
JdbcOperations
The query is expected to be a single row/single column query; the returned result will be directly mapped to the corresponding object type.
queryForObject
in interface JdbcOperations
sql
- SQL query to executeargs
- arguments to bind to the query
(leaving it to the PreparedStatement to guess the corresponding SQL type)requiredType
- the type that the result object is expected to match
null
in case of SQL NULL
IncorrectResultSizeDataAccessException
- if the query does not return
exactly one row, or does not return exactly one column in that row
DataAccessException
- if the query failsJdbcOperations.queryForObject(String, Class)
public Map queryForMap(String sql, Object[] args, int[] argTypes) throws DataAccessException
JdbcOperations
The query is expected to be a single row query; the result row will be mapped to a Map (one entry for each column, using the column name as the key).
queryForMap
in interface JdbcOperations
sql
- SQL query to executeargs
- arguments to bind to the queryargTypes
- SQL types of the arguments
(constants from java.sql.Types
)
IncorrectResultSizeDataAccessException
- if the query does not
return exactly one row
DataAccessException
- if the query failsJdbcOperations.queryForMap(String)
,
ColumnMapRowMapper
,
Types
public Map queryForMap(String sql, Object[] args) throws DataAccessException
JdbcOperations
The query is expected to be a single row query; the result row will be mapped to a Map (one entry for each column, using the column name as the key).
queryForMap
in interface JdbcOperations
sql
- SQL query to executeargs
- arguments to bind to the query
(leaving it to the PreparedStatement to guess the corresponding SQL type)
IncorrectResultSizeDataAccessException
- if the query does not
return exactly one row
DataAccessException
- if the query failsJdbcOperations.queryForMap(String)
,
ColumnMapRowMapper
public long queryForLong(String sql, Object[] args, int[] argTypes) throws DataAccessException
JdbcOperations
The query is expected to be a single row/single column query that results in a long value.
queryForLong
in interface JdbcOperations
sql
- SQL query to executeargs
- arguments to bind to the queryargTypes
- SQL types of the arguments
(constants from java.sql.Types
)
IncorrectResultSizeDataAccessException
- if the query does not return
exactly one row, or does not return exactly one column in that row
DataAccessException
- if the query failsJdbcOperations.queryForLong(String)
,
Types
public long queryForLong(String sql, Object[] args) throws DataAccessException
JdbcOperations
The query is expected to be a single row/single column query that results in a long value.
queryForLong
in interface JdbcOperations
sql
- SQL query to executeargs
- arguments to bind to the query
(leaving it to the PreparedStatement to guess the corresponding SQL type)
IncorrectResultSizeDataAccessException
- if the query does not return
exactly one row, or does not return exactly one column in that row
DataAccessException
- if the query failsJdbcOperations.queryForLong(String)
public int queryForInt(String sql, Object[] args, int[] argTypes) throws DataAccessException
JdbcOperations
The query is expected to be a single row/single column query that results in an int value.
queryForInt
in interface JdbcOperations
sql
- SQL query to executeargs
- arguments to bind to the queryargTypes
- SQL types of the arguments
(constants from java.sql.Types
)
IncorrectResultSizeDataAccessException
- if the query does not return
exactly one row, or does not return exactly one column in that row
DataAccessException
- if the query failsJdbcOperations.queryForInt(String)
,
Types
public int queryForInt(String sql, Object[] args) throws DataAccessException
JdbcOperations
The query is expected to be a single row/single column query that results in an int value.
queryForInt
in interface JdbcOperations
sql
- SQL query to executeargs
- arguments to bind to the query
(leaving it to the PreparedStatement to guess the corresponding SQL type)
IncorrectResultSizeDataAccessException
- if the query does not return
exactly one row, or does not return exactly one column in that row
DataAccessException
- if the query failsJdbcOperations.queryForInt(String)
public List queryForList(String sql, Object[] args, int[] argTypes, Class elementType) throws DataAccessException
JdbcOperations
The results will be mapped to a List (one entry for each row) of result objects, each of them matching the specified element type.
queryForList
in interface JdbcOperations
sql
- SQL query to executeargs
- arguments to bind to the query
(leaving it to the PreparedStatement to guess the corresponding SQL type)argTypes
- SQL types of the arguments
(constants from java.sql.Types
)elementType
- the required type of element in the result list
(for example, Integer.class
)
DataAccessException
- if the query failsJdbcOperations.queryForList(String, Class)
,
SingleColumnRowMapper
public List queryForList(String sql, Object[] args, Class elementType) throws DataAccessException
JdbcOperations
The results will be mapped to a List (one entry for each row) of result objects, each of them matching the specified element type.
queryForList
in interface JdbcOperations
sql
- SQL query to executeargs
- arguments to bind to the query
(leaving it to the PreparedStatement to guess the corresponding SQL type)elementType
- the required type of element in the result list
(for example, Integer.class
)
DataAccessException
- if the query failsJdbcOperations.queryForList(String, Class)
,
SingleColumnRowMapper
public List queryForList(String sql, Object[] args, int[] argTypes) throws DataAccessException
JdbcOperations
The results will be mapped to a List (one entry for each row) of Maps (one entry for each column, using the column name as the key). Thus Each element in the list will be of the form returned by this interface's queryForMap() methods.
queryForList
in interface JdbcOperations
sql
- SQL query to executeargs
- arguments to bind to the query
(leaving it to the PreparedStatement to guess the corresponding SQL type)argTypes
- SQL types of the arguments
(constants from java.sql.Types
)
DataAccessException
- if the query failsJdbcOperations.queryForList(String)
,
Types
public List queryForList(String sql, Object[] args) throws DataAccessException
JdbcOperations
The results will be mapped to a List (one entry for each row) of Maps (one entry for each column, using the column name as the key). Each element in the list will be of the form returned by this interface's queryForMap() methods.
queryForList
in interface JdbcOperations
sql
- SQL query to executeargs
- arguments to bind to the query
(leaving it to the PreparedStatement to guess the corresponding SQL type)
DataAccessException
- if the query failsJdbcOperations.queryForList(String)
public SqlRowSet queryForRowSet(String sql, Object[] args, int[] argTypes) throws DataAccessException
JdbcOperations
The results will be mapped to an SqlRowSet which holds the data in a disconnected fashion. This wrapper will translate any SQLExceptions thrown.
Note that that, for the default implementation, JDBC RowSet support needs to
be available at runtime: by default, Sun's com.sun.rowset.CachedRowSetImpl
class is used, which is part of JDK 1.5+ and also available separately as part of
Sun's JDBC RowSet Implementations download (rowset.jar).
queryForRowSet
in interface JdbcOperations
sql
- SQL query to executeargs
- arguments to bind to the queryargTypes
- SQL types of the arguments
(constants from java.sql.Types
)
javax.sql.rowset.CachedRowSet
)
DataAccessException
- if there is any problem executing the queryJdbcOperations.queryForRowSet(String)
,
SqlRowSetResultSetExtractor
,
CachedRowSet
,
Types
public SqlRowSet queryForRowSet(String sql, Object[] args) throws DataAccessException
JdbcOperations
The results will be mapped to an SqlRowSet which holds the data in a disconnected fashion. This wrapper will translate any SQLExceptions thrown.
Note that that, for the default implementation, JDBC RowSet support needs to
be available at runtime: by default, Sun's com.sun.rowset.CachedRowSetImpl
class is used, which is part of JDK 1.5+ and also available separately as part of
Sun's JDBC RowSet Implementations download (rowset.jar).
queryForRowSet
in interface JdbcOperations
sql
- SQL query to executeargs
- arguments to bind to the query
(leaving it to the PreparedStatement to guess the corresponding SQL type)
javax.sql.rowset.CachedRowSet
)
DataAccessException
- if there is any problem executing the queryJdbcOperations.queryForRowSet(String)
,
SqlRowSetResultSetExtractor
,
CachedRowSet
protected int update(PreparedStatementCreator psc, PreparedStatementSetter pss) throws DataAccessException
DataAccessException
public int update(PreparedStatementCreator psc) throws DataAccessException
JdbcOperations
A PreparedStatementCreator can either be implemented directly or configured through a PreparedStatementCreatorFactory.
update
in interface JdbcOperations
psc
- object that provides SQL and any necessary parameters
DataAccessException
- if there is any problem issuing the updatePreparedStatementCreatorFactory
public int update(PreparedStatementCreator psc, KeyHolder generatedKeyHolder) throws DataAccessException
JdbcOperations
Note that the given PreparedStatementCreator has to create a statement with activated extraction of generated keys (a JDBC 3.0 feature). This can either be done directly or through using a PreparedStatementCreatorFactory.
update
in interface JdbcOperations
psc
- object that provides SQL and any necessary parametersgeneratedKeyHolder
- KeyHolder that will hold the generated keys
DataAccessException
- if there is any problem issuing the updatePreparedStatementCreatorFactory
,
GeneratedKeyHolder
public int update(String sql, PreparedStatementSetter pss) throws DataAccessException
JdbcOperations
update
in interface JdbcOperations
sql
- SQL containing bind parameterspss
- helper that sets bind parameters. If this is null
we run an update with static SQL.
DataAccessException
- if there is any problem issuing the updatepublic int update(String sql, Object[] args, int[] argTypes) throws DataAccessException
JdbcOperations
update
in interface JdbcOperations
sql
- SQL containing bind parametersargs
- arguments to bind to the queryargTypes
- SQL types of the arguments
(constants from java.sql.Types
)
DataAccessException
- if there is any problem issuing the updateTypes
public int update(String sql, Object[] args) throws DataAccessException
JdbcOperations
update
in interface JdbcOperations
sql
- SQL containing bind parametersargs
- arguments to bind to the query
(leaving it to the PreparedStatement to guess the corresponding SQL type)
DataAccessException
- if there is any problem issuing the updatepublic int[] batchUpdate(String sql, BatchPreparedStatementSetter pss) throws DataAccessException
JdbcOperations
Will fall back to separate updates on a single PreparedStatement if the JDBC driver does not support batch updates.
batchUpdate
in interface JdbcOperations
sql
- defining PreparedStatement that will be reused.
All statements in the batch will use the same SQL.pss
- object to set parameters on the PreparedStatement
created by this method
DataAccessException
- if there is any problem issuing the updatepublic Object execute(CallableStatementCreator csc, CallableStatementCallback action) throws DataAccessException
JdbcOperations
The callback action can return a result object, for example a domain object or a collection of domain objects.
execute
in interface JdbcOperations
csc
- object that can create a CallableStatement given a Connectionaction
- callback object that specifies the action
null
DataAccessException
- if there is any problempublic Object execute(String callString, CallableStatementCallback action) throws DataAccessException
JdbcOperations
The callback action can return a result object, for example a domain object or a collection of domain objects.
execute
in interface JdbcOperations
callString
- the SQL call string to executeaction
- callback object that specifies the action
null
DataAccessException
- if there is any problempublic Map call(CallableStatementCreator csc, List declaredParameters) throws DataAccessException
JdbcOperations
call
in interface JdbcOperations
csc
- object that provides SQL and any necessary parametersdeclaredParameters
- list of declared SqlParameter objects
DataAccessException
- if there is any problem issuing the updateprotected Map extractReturnedResultSets(CallableStatement cs, List parameters, int updateCount) throws SQLException
cs
- JDBC wrapper for the stored procedureparameters
- Parameter list for the stored procedure
SQLException
protected Map extractOutputParameters(CallableStatement cs, List parameters) throws SQLException
cs
- JDBC wrapper for the stored procedureparameters
- parameter list for the stored procedure
SQLException
protected Map processResultSet(ResultSet rs, ResultSetSupportingSqlParameter param) throws SQLException
rs
- the ResultSet to processparam
- the corresponding stored procedure parameter
SQLException
protected RowMapper getColumnMapRowMapper()
ColumnMapRowMapper
protected RowMapper getSingleColumnRowMapper(Class requiredType)
requiredType
- the type that each result object is expected to match
SingleColumnRowMapper
protected void applyStatementSettings(Statement stmt) throws SQLException
stmt
- the JDBC Statement to prepare
SQLException
setFetchSize(int)
,
setMaxRows(int)
,
DataSourceUtils.applyTransactionTimeout(java.sql.Statement, javax.sql.DataSource)
protected void handleWarnings(SQLWarning warning) throws SQLWarningException
warning
- the warnings object from the current statement.
May be null
, in which case this method does nothing.
SQLWarningException
SQLWarningException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |