public class JdbcTemplate extends JdbcAccessor implements JdbcOperations
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 SQL operations performed by this class are logged at debug level, using "org.springframework.jdbc.core.JdbcTemplate" as log category.
NOTE: An instance of this class is thread-safe once configured.
PreparedStatementCreator
,
PreparedStatementSetter
,
CallableStatementCreator
,
PreparedStatementCallback
,
CallableStatementCallback
,
ResultSetExtractor
,
RowCallbackHandler
,
RowMapper
,
SQLExceptionTranslator
logger
Constructor and Description |
---|
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.
|
Modifier and Type | Method and Description |
---|---|
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 JDBC Statement using batching.
|
int[] |
batchUpdate(String sql,
BatchPreparedStatementSetter pss)
Issue multiple update statements on a single PreparedStatement,
using batch updates and a BatchPreparedStatementSetter to set values.
|
<T> int[][] |
batchUpdate(String sql,
Collection<T> batchArgs,
int batchSize,
ParameterizedPreparedStatementSetter<T> pss)
Execute multiple batches using the supplied SQL statement with the collect of supplied
arguments.
|
int[] |
batchUpdate(String sql,
List<Object[]> batchArgs)
Execute a batch using the supplied SQL statement with the batch of supplied arguments.
|
int[] |
batchUpdate(String sql,
List<Object[]> batchArgs,
int[] argTypes)
Execute a batch using the supplied SQL statement with the batch of supplied arguments.
|
Map<String,Object> |
call(CallableStatementCreator csc,
List<SqlParameter> declaredParameters)
Execute an 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.
|
protected Map<String,Object> |
createResultsMap()
Create a Map instance to be used as the results map.
|
<T> T |
execute(CallableStatementCreator csc,
CallableStatementCallback<T> action)
Execute a JDBC data access operation, implemented as callback action
working on a JDBC CallableStatement.
|
<T> T |
execute(ConnectionCallback<T> action)
Execute a JDBC data access operation, implemented as callback action
working on a JDBC Connection.
|
<T> T |
execute(PreparedStatementCreator psc,
PreparedStatementCallback<T> action)
Execute a JDBC data access operation, implemented as callback action
working on a JDBC PreparedStatement.
|
<T> T |
execute(StatementCallback<T> 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.
|
<T> T |
execute(String callString,
CallableStatementCallback<T> action)
Execute a JDBC data access operation, implemented as callback action
working on a JDBC CallableStatement.
|
<T> T |
execute(String sql,
PreparedStatementCallback<T> action)
Execute a JDBC data access operation, implemented as callback action
working on a JDBC PreparedStatement.
|
protected Map<String,Object> |
extractOutputParameters(CallableStatement cs,
List<SqlParameter> parameters)
Extract output parameters from the completed stored procedure.
|
protected Map<String,Object> |
extractReturnedResults(CallableStatement cs,
List<SqlParameter> updateCountParameters,
List<SqlParameter> resultSetParameters,
int updateCount)
Extract returned ResultSets from the completed stored procedure.
|
protected RowMapper<Map<String,Object>> |
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.
|
int |
getQueryTimeout()
Return the query timeout for statements that this JdbcTemplate executes.
|
protected <T> RowMapper<T> |
getSingleColumnRowMapper(Class<T> requiredType)
Create a new RowMapper for reading result objects from a single column.
|
protected void |
handleWarnings(SQLWarning warning)
Throw an SQLWarningException if encountering an actual warning.
|
protected void |
handleWarnings(Statement stmt)
Throw an SQLWarningException if we're not ignoring warnings,
otherwise log the warnings at debug level.
|
boolean |
isIgnoreWarnings()
Return whether or not we ignore SQLWarnings.
|
boolean |
isResultsMapCaseInsensitive()
Return whether execution of a CallableStatement will return the results in a Map
that uses case insensitive names for the parameters.
|
boolean |
isSkipResultsProcessing()
Return whether results processing should be skipped.
|
boolean |
isSkipUndeclaredResults()
Return whether undeclared results should be skipped.
|
protected PreparedStatementSetter |
newArgPreparedStatementSetter(Object[] args)
Create a new arg-based PreparedStatementSetter using the args passed in.
|
protected PreparedStatementSetter |
newArgTypePreparedStatementSetter(Object[] args,
int[] argTypes)
Create a new arg-type-based PreparedStatementSetter using the args and types passed in.
|
protected Map<String,Object> |
processResultSet(ResultSet rs,
ResultSetSupportingSqlParameter param)
Process the given ResultSet from a stored procedure.
|
<T> T |
query(PreparedStatementCreator psc,
PreparedStatementSetter pss,
ResultSetExtractor<T> rse)
Query using a prepared statement, allowing for a PreparedStatementCreator
and a PreparedStatementSetter.
|
<T> T |
query(PreparedStatementCreator psc,
ResultSetExtractor<T> rse)
Query using a prepared statement, reading the ResultSet with a ResultSetExtractor.
|
void |
query(PreparedStatementCreator psc,
RowCallbackHandler rch)
Query using a prepared statement, reading the ResultSet on a per-row basis
with a RowCallbackHandler.
|
<T> List<T> |
query(PreparedStatementCreator psc,
RowMapper<T> rowMapper)
Query using a prepared statement, mapping each row to a result object
via a RowMapper.
|
<T> T |
query(String sql,
Object[] args,
int[] argTypes,
ResultSetExtractor<T> 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.
|
void |
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.
|
<T> List<T> |
query(String sql,
Object[] args,
int[] argTypes,
RowMapper<T> 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 result object
via a RowMapper.
|
<T> T |
query(String sql,
Object[] args,
ResultSetExtractor<T> rse)
Deprecated.
|
void |
query(String sql,
Object[] args,
RowCallbackHandler rch)
Deprecated.
|
<T> List<T> |
query(String sql,
Object[] args,
RowMapper<T> rowMapper)
Deprecated.
|
<T> T |
query(String sql,
PreparedStatementSetter pss,
ResultSetExtractor<T> rse)
Query using a prepared statement, reading the ResultSet with a ResultSetExtractor.
|
void |
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.
|
<T> List<T> |
query(String sql,
PreparedStatementSetter pss,
RowMapper<T> 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 result object via a RowMapper.
|
<T> T |
query(String sql,
ResultSetExtractor<T> rse)
Execute a query given static SQL, reading the ResultSet with a
ResultSetExtractor.
|
<T> T |
query(String sql,
ResultSetExtractor<T> rse,
Object... args)
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.
|
void |
query(String sql,
RowCallbackHandler rch)
Execute a query given static SQL, reading the ResultSet on a per-row
basis with a RowCallbackHandler.
|
void |
query(String sql,
RowCallbackHandler rch,
Object... args)
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.
|
<T> List<T> |
query(String sql,
RowMapper<T> rowMapper)
Execute a query given static SQL, mapping each row to a result object
via a RowMapper.
|
<T> List<T> |
query(String sql,
RowMapper<T> rowMapper,
Object... args)
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 result object
via a RowMapper.
|
List<Map<String,Object>> |
queryForList(String sql)
Execute a query for a result list, given static SQL.
|
<T> List<T> |
queryForList(String sql,
Class<T> elementType)
Execute a query for a result list, given static SQL.
|
<T> List<T> |
queryForList(String sql,
Class<T> elementType,
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<Map<String,Object>> |
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.
|
<T> List<T> |
queryForList(String sql,
Object[] args,
Class<T> elementType)
Deprecated.
|
List<Map<String,Object>> |
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.
|
<T> List<T> |
queryForList(String sql,
Object[] args,
int[] argTypes,
Class<T> 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.
|
Map<String,Object> |
queryForMap(String sql)
Execute a query for a result map, given static SQL.
|
Map<String,Object> |
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<String,Object> |
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.
|
<T> T |
queryForObject(String sql,
Class<T> requiredType)
Execute a query for a result object, given static SQL.
|
<T> T |
queryForObject(String sql,
Class<T> requiredType,
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 object.
|
<T> T |
queryForObject(String sql,
Object[] args,
Class<T> requiredType)
Deprecated.
|
<T> T |
queryForObject(String sql,
Object[] args,
int[] argTypes,
Class<T> 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.
|
<T> T |
queryForObject(String sql,
Object[] args,
int[] argTypes,
RowMapper<T> 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
result object via a RowMapper.
|
<T> T |
queryForObject(String sql,
Object[] args,
RowMapper<T> rowMapper)
Deprecated.
|
<T> T |
queryForObject(String sql,
RowMapper<T> rowMapper)
Execute a query given static SQL, mapping a single result row to a
result object via a RowMapper.
|
<T> T |
queryForObject(String sql,
RowMapper<T> rowMapper,
Object... args)
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
result object via a RowMapper.
|
SqlRowSet |
queryForRowSet(String sql)
Execute a query for an 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 an 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 an SqlRowSet.
|
<T> Stream<T> |
queryForStream(PreparedStatementCreator psc,
PreparedStatementSetter pss,
RowMapper<T> rowMapper)
Query using a prepared statement, allowing for a PreparedStatementCreator
and a PreparedStatementSetter.
|
<T> Stream<T> |
queryForStream(PreparedStatementCreator psc,
RowMapper<T> rowMapper)
Query using a prepared statement, mapping each row to a result object
via a RowMapper, and turning it into an iterable and closeable Stream.
|
<T> Stream<T> |
queryForStream(String sql,
PreparedStatementSetter pss,
RowMapper<T> 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 result object via a RowMapper,
and turning it into an iterable and closeable Stream.
|
<T> Stream<T> |
queryForStream(String sql,
RowMapper<T> rowMapper)
Execute a query given static SQL, mapping each row to a result object
via a RowMapper, and turning it into an iterable and closeable Stream.
|
<T> Stream<T> |
queryForStream(String sql,
RowMapper<T> rowMapper,
Object... args)
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 result object
via a RowMapper, and turning it into an iterable and closeable Stream.
|
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 |
setQueryTimeout(int queryTimeout)
Set the query timeout for statements that this JdbcTemplate executes.
|
void |
setResultsMapCaseInsensitive(boolean resultsMapCaseInsensitive)
Set whether execution of a CallableStatement will return the results in a Map
that uses case insensitive names for the parameters.
|
void |
setSkipResultsProcessing(boolean skipResultsProcessing)
Set whether results processing should be skipped.
|
void |
setSkipUndeclaredResults(boolean skipUndeclaredResults)
Set whether undeclared results should be skipped.
|
protected DataAccessException |
translateException(String task,
String sql,
SQLException ex)
Translate the given
SQLException into a generic DataAccessException . |
int |
update(PreparedStatementCreator psc)
Issue a single SQL update operation (such as an insert, update or delete
statement) using a PreparedStatementCreator to provide SQL and any
required parameters.
|
int |
update(PreparedStatementCreator psc,
KeyHolder generatedKeyHolder)
Issue an update statement 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 operation (such as an insert, update or delete statement).
|
int |
update(String sql,
Object... args)
Issue a single SQL update operation (such as an insert, update or delete statement)
via a prepared statement, binding the given arguments.
|
int |
update(String sql,
Object[] args,
int[] argTypes)
Issue a single SQL update operation (such as an insert, update or delete statement)
via a prepared statement, binding the given arguments.
|
int |
update(String sql,
PreparedStatementSetter pss)
Issue an update statement using a PreparedStatementSetter to set bind parameters,
with given SQL.
|
afterPropertiesSet, getDataSource, getExceptionTranslator, isLazyInit, obtainDataSource, setDatabaseProductName, setDataSource, setExceptionTranslator, setLazyInit
public JdbcTemplate()
Note: The DataSource has to be set before using the instance.
public JdbcTemplate(DataSource dataSource)
Note: This will not trigger initialization of the exception translator.
dataSource
- the JDBC DataSource to obtain connections frompublic JdbcTemplate(DataSource dataSource, boolean lazyInit)
Note: Depending on the "lazyInit" flag, initialization of the exception translator will be triggered.
dataSource
- the JDBC DataSource to obtain connections fromlazyInit
- whether to lazily initialize the SQLExceptionTranslatorpublic void setIgnoreWarnings(boolean ignoreWarnings)
Default is "true", swallowing and logging all warnings. Switch this flag to "false" to make the JdbcTemplate throw an SQLWarningException instead.
public boolean isIgnoreWarnings()
public void setFetchSize(int fetchSize)
Default is -1, indicating to use the JDBC driver's default configuration (i.e. to not pass a specific fetch size setting on to the driver).
Note: As of 4.3, negative values other than -1 will get passed on to the
driver, since e.g. MySQL supports special behavior for Integer.MIN_VALUE
.
Statement.setFetchSize(int)
public int getFetchSize()
public void setMaxRows(int maxRows)
Default is -1, indicating to use the JDBC driver's default configuration (i.e. to not pass a specific max rows setting on to the driver).
Note: As of 4.3, negative values other than -1 will get passed on to the
driver, in sync with setFetchSize(int)
's support for special MySQL values.
Statement.setMaxRows(int)
public int getMaxRows()
public void setQueryTimeout(int queryTimeout)
Default is -1, indicating to use the JDBC driver's default (i.e. to not pass a specific query timeout setting on the driver).
Note: Any timeout specified here will be overridden by the remaining transaction timeout when executing within a transaction that has a timeout specified at the transaction level.
Statement.setQueryTimeout(int)
public int getQueryTimeout()
public void setSkipResultsProcessing(boolean skipResultsProcessing)
public boolean isSkipResultsProcessing()
public void setSkipUndeclaredResults(boolean skipUndeclaredResults)
public boolean isSkipUndeclaredResults()
public void setResultsMapCaseInsensitive(boolean resultsMapCaseInsensitive)
public boolean isResultsMapCaseInsensitive()
@Nullable public <T> T execute(ConnectionCallback<T> 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
- a callback object that specifies the actionnull
if noneDataAccessException
- 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 forConnection.close()
,
execute(ConnectionCallback)
,
applyStatementSettings(java.sql.Statement)
@Nullable public <T> T execute(StatementCallback<T> 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
- a callback that specifies the actionnull
if noneDataAccessException
- if there is any problempublic void execute(String sql) throws DataAccessException
JdbcOperations
execute
in interface JdbcOperations
sql
- static SQL to executeDataAccessException
- if there is any problem@Nullable public <T> T query(String sql, ResultSetExtractor<T> 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
- the SQL query to executerse
- a callback that will extract all rows of resultsDataAccessException
- if there is any problem executing the queryJdbcOperations.query(String, ResultSetExtractor, Object...)
public void 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
- the SQL query to executerch
- a callback that will extract results, one row at a timeDataAccessException
- if there is any problem executing the queryJdbcOperations.query(String, RowCallbackHandler, Object...)
public <T> List<T> query(String sql, RowMapper<T> 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
- the SQL query to executerowMapper
- a callback that will map one object per rowDataAccessException
- if there is any problem executing the queryJdbcOperations.query(String, RowMapper, Object...)
public <T> Stream<T> queryForStream(String sql, RowMapper<T> 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.
queryForStream
in interface JdbcOperations
sql
- the SQL query to executerowMapper
- a callback that will map one object per rowDataAccessException
- if there is any problem executing the queryJdbcOperations.queryForStream(String, RowMapper, Object...)
public Map<String,Object> 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
JdbcOperations.queryForMap(String, Object...)
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
- the SQL query to executeIncorrectResultSizeDataAccessException
- if the query does not return exactly one rowDataAccessException
- if there is any problem executing the queryJdbcOperations.queryForMap(String, Object...)
,
ColumnMapRowMapper
@Nullable public <T> T queryForObject(String sql, RowMapper<T> 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
JdbcOperations.queryForObject(String, RowMapper, Object...)
method with
null
as argument array.
queryForObject
in interface JdbcOperations
sql
- the SQL query to executerowMapper
- a callback that will map one object per rownull
if the given
RowMapper
returned null)IncorrectResultSizeDataAccessException
- if the query does not return exactly one rowDataAccessException
- if there is any problem executing the queryJdbcOperations.queryForObject(String, RowMapper, Object...)
@Nullable public <T> T queryForObject(String sql, Class<T> 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
JdbcOperations.queryForObject(String, Class, Object...)
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
- the SQL query to executerequiredType
- the type that the result object is expected to matchnull
in case of SQL NULLIncorrectResultSizeDataAccessException
- if the query does not return exactly one rowIncorrectResultSetColumnCountException
- if the query does not return a row containing a single columnDataAccessException
- if there is any problem executing the queryJdbcOperations.queryForObject(String, Class, Object...)
public <T> List<T> queryForList(String sql, Class<T> 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
- the 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, Class, Object...)
,
SingleColumnRowMapper
public List<Map<String,Object>> 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
- the SQL query to executeDataAccessException
- 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, 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
- the SQL query to executejavax.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 executeDataAccessException
- 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 batch@Nullable public <T> T execute(PreparedStatementCreator psc, PreparedStatementCallback<T> 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
- a callback that creates a PreparedStatement given a Connectionaction
- a callback that specifies the actionnull
if noneDataAccessException
- if there is any problem@Nullable public <T> T execute(String sql, PreparedStatementCallback<T> 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
- the SQL to executeaction
- a callback that specifies the actionnull
if noneDataAccessException
- if there is any problem@Nullable public <T> T query(PreparedStatementCreator psc, @Nullable PreparedStatementSetter pss, ResultSetExtractor<T> rse) throws DataAccessException
psc
- a callback that creates a PreparedStatement given a Connectionpss
- a callback 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
- a callback that will extract resultsDataAccessException
- if there is any problem@Nullable public <T> T query(PreparedStatementCreator psc, ResultSetExtractor<T> rse) throws DataAccessException
JdbcOperations
A PreparedStatementCreator can either be implemented directly or configured through a PreparedStatementCreatorFactory.
query
in interface JdbcOperations
psc
- a callback that creates a PreparedStatement given a Connectionrse
- a callback that will extract resultsDataAccessException
- if there is any problemPreparedStatementCreatorFactory
@Nullable public <T> T query(String sql, @Nullable PreparedStatementSetter pss, ResultSetExtractor<T> rse) throws DataAccessException
JdbcOperations
query
in interface JdbcOperations
sql
- the SQL query to executepss
- a callback 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 callback may be used to set the
fetch size and other performance options.rse
- a callback that will extract resultsDataAccessException
- if there is any problem@Nullable public <T> T query(String sql, Object[] args, int[] argTypes, ResultSetExtractor<T> rse) throws DataAccessException
JdbcOperations
query
in interface JdbcOperations
sql
- the SQL query to executeargs
- arguments to bind to the queryargTypes
- the SQL types of the arguments
(constants from java.sql.Types
)rse
- a callback that will extract resultsDataAccessException
- if the query failsTypes
@Deprecated @Nullable public <T> T query(String sql, @Nullable Object[] args, ResultSetExtractor<T> rse) throws DataAccessException
JdbcOperations
query
in interface JdbcOperations
sql
- the SQL query to executeargs
- arguments to bind to the query
(leaving it to the PreparedStatement to guess the corresponding SQL type);
may also contain SqlParameterValue
objects which indicate not
only the argument value but also the SQL type and optionally the scalerse
- a callback that will extract resultsDataAccessException
- if the query fails@Nullable public <T> T query(String sql, ResultSetExtractor<T> rse, @Nullable Object... args) throws DataAccessException
JdbcOperations
query
in interface JdbcOperations
sql
- the SQL query to executerse
- a callback that will extract resultsargs
- arguments to bind to the query
(leaving it to the PreparedStatement to guess the corresponding SQL type);
may also contain SqlParameterValue
objects which indicate not
only the argument value but also the SQL type and optionally the scaleDataAccessException
- if the query failspublic void 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
- a callback that creates a PreparedStatement given a Connectionrch
- a callback that will extract results, one row at a timeDataAccessException
- if there is any problemPreparedStatementCreatorFactory
public void query(String sql, @Nullable PreparedStatementSetter pss, RowCallbackHandler rch) throws DataAccessException
JdbcOperations
query
in interface JdbcOperations
sql
- the SQL query to executepss
- a callback 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 callback may be used to set the
fetch size and other performance options.rch
- a callback that will extract results, one row at a timeDataAccessException
- if the query failspublic void query(String sql, Object[] args, int[] argTypes, RowCallbackHandler rch) throws DataAccessException
JdbcOperations
query
in interface JdbcOperations
sql
- the SQL query to executeargs
- arguments to bind to the queryargTypes
- the SQL types of the arguments
(constants from java.sql.Types
)rch
- a callback that will extract results, one row at a timeDataAccessException
- if the query failsTypes
@Deprecated public void query(String sql, @Nullable Object[] args, RowCallbackHandler rch) throws DataAccessException
JdbcOperations
query
in interface JdbcOperations
sql
- the SQL query to executeargs
- arguments to bind to the query
(leaving it to the PreparedStatement to guess the corresponding SQL type);
may also contain SqlParameterValue
objects which indicate not
only the argument value but also the SQL type and optionally the scalerch
- a callback that will extract results, one row at a timeDataAccessException
- if the query failspublic void query(String sql, RowCallbackHandler rch, @Nullable Object... args) throws DataAccessException
JdbcOperations
query
in interface JdbcOperations
sql
- the SQL query to executerch
- a callback that will extract results, one row at a timeargs
- arguments to bind to the query
(leaving it to the PreparedStatement to guess the corresponding SQL type);
may also contain SqlParameterValue
objects which indicate not
only the argument value but also the SQL type and optionally the scaleDataAccessException
- if the query failspublic <T> List<T> query(PreparedStatementCreator psc, RowMapper<T> rowMapper) throws DataAccessException
JdbcOperations
A PreparedStatementCreator can either be implemented directly or configured through a PreparedStatementCreatorFactory.
query
in interface JdbcOperations
psc
- a callback that creates a PreparedStatement given a ConnectionrowMapper
- a callback that will map one object per rowDataAccessException
- if there is any problemPreparedStatementCreatorFactory
public <T> List<T> query(String sql, @Nullable PreparedStatementSetter pss, RowMapper<T> rowMapper) throws DataAccessException
JdbcOperations
query
in interface JdbcOperations
sql
- the SQL query to executepss
- a callback 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 callback may be used to set the
fetch size and other performance options.rowMapper
- a callback that will map one object per rowDataAccessException
- if the query failspublic <T> List<T> query(String sql, Object[] args, int[] argTypes, RowMapper<T> rowMapper) throws DataAccessException
JdbcOperations
query
in interface JdbcOperations
sql
- the SQL query to executeargs
- arguments to bind to the queryargTypes
- the SQL types of the arguments
(constants from java.sql.Types
)rowMapper
- a callback that will map one object per rowDataAccessException
- if the query failsTypes
@Deprecated public <T> List<T> query(String sql, @Nullable Object[] args, RowMapper<T> rowMapper) throws DataAccessException
JdbcOperations
query
in interface JdbcOperations
sql
- the SQL query to executeargs
- arguments to bind to the query
(leaving it to the PreparedStatement to guess the corresponding SQL type);
may also contain SqlParameterValue
objects which indicate not
only the argument value but also the SQL type and optionally the scalerowMapper
- a callback that will map one object per rowDataAccessException
- if the query failspublic <T> List<T> query(String sql, RowMapper<T> rowMapper, @Nullable Object... args) throws DataAccessException
JdbcOperations
query
in interface JdbcOperations
sql
- the SQL query to executerowMapper
- a callback that will map one object per rowargs
- arguments to bind to the query
(leaving it to the PreparedStatement to guess the corresponding SQL type);
may also contain SqlParameterValue
objects which indicate not
only the argument value but also the SQL type and optionally the scaleDataAccessException
- if the query failspublic <T> Stream<T> queryForStream(PreparedStatementCreator psc, @Nullable PreparedStatementSetter pss, RowMapper<T> rowMapper) throws DataAccessException
psc
- a callback that creates a PreparedStatement given a Connectionpss
- a callback that knows how to set values on the prepared statement.
If this is null
, the SQL will be assumed to contain no bind parameters.rowMapper
- a callback that will map one object per rowDataAccessException
- if the query failspublic <T> Stream<T> queryForStream(PreparedStatementCreator psc, RowMapper<T> rowMapper) throws DataAccessException
JdbcOperations
A PreparedStatementCreator can either be implemented directly or configured through a PreparedStatementCreatorFactory.
queryForStream
in interface JdbcOperations
psc
- a callback that creates a PreparedStatement given a ConnectionrowMapper
- a callback that will map one object per rowDataAccessException
- if there is any problemPreparedStatementCreatorFactory
public <T> Stream<T> queryForStream(String sql, @Nullable PreparedStatementSetter pss, RowMapper<T> rowMapper) throws DataAccessException
JdbcOperations
queryForStream
in interface JdbcOperations
sql
- the SQL query to executepss
- a callback 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 callback may be used to set the
fetch size and other performance options.rowMapper
- a callback that will map one object per rowDataAccessException
- if the query failspublic <T> Stream<T> queryForStream(String sql, RowMapper<T> rowMapper, @Nullable Object... args) throws DataAccessException
JdbcOperations
queryForStream
in interface JdbcOperations
sql
- the SQL query to executerowMapper
- a callback that will map one object per rowargs
- arguments to bind to the query
(leaving it to the PreparedStatement to guess the corresponding SQL type);
may also contain SqlParameterValue
objects which indicate not
only the argument value but also the SQL type and optionally the scaleDataAccessException
- if the query fails@Nullable public <T> T queryForObject(String sql, Object[] args, int[] argTypes, RowMapper<T> rowMapper) throws DataAccessException
JdbcOperations
queryForObject
in interface JdbcOperations
sql
- the SQL query to executeargs
- arguments to bind to the query
(leaving it to the PreparedStatement to guess the corresponding SQL type)argTypes
- the SQL types of the arguments
(constants from java.sql.Types
)rowMapper
- a callback that will map one object per rownull
if the given
RowMapper
returned null)IncorrectResultSizeDataAccessException
- if the query does not return exactly one rowDataAccessException
- if the query fails@Deprecated @Nullable public <T> T queryForObject(String sql, @Nullable Object[] args, RowMapper<T> rowMapper) throws DataAccessException
JdbcOperations
queryForObject
in interface JdbcOperations
sql
- the SQL query to executeargs
- arguments to bind to the query
(leaving it to the PreparedStatement to guess the corresponding SQL type);
may also contain SqlParameterValue
objects which indicate not
only the argument value but also the SQL type and optionally the scalerowMapper
- a callback that will map one object per rownull
if the given
RowMapper
returned null)IncorrectResultSizeDataAccessException
- if the query does not return exactly one rowDataAccessException
- if the query fails@Nullable public <T> T queryForObject(String sql, RowMapper<T> rowMapper, @Nullable Object... args) throws DataAccessException
JdbcOperations
queryForObject
in interface JdbcOperations
sql
- the SQL query to executerowMapper
- a callback that will map one object per rowargs
- arguments to bind to the query
(leaving it to the PreparedStatement to guess the corresponding SQL type);
may also contain SqlParameterValue
objects which indicate not
only the argument value but also the SQL type and optionally the scalenull
if the given
RowMapper
returned null)IncorrectResultSizeDataAccessException
- if the query does not return exactly one rowDataAccessException
- if the query fails@Nullable public <T> T queryForObject(String sql, Object[] args, int[] argTypes, Class<T> 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
- the SQL query to executeargs
- arguments to bind to the queryargTypes
- the SQL types of the arguments
(constants from java.sql.Types
)requiredType
- the type that the result object is expected to matchnull
in case of SQL NULLIncorrectResultSizeDataAccessException
- if the query does not return exactly one rowIncorrectResultSetColumnCountException
- if the query does not return a row containing a single columnDataAccessException
- if the query failsJdbcOperations.queryForObject(String, Class)
,
Types
@Deprecated public <T> T queryForObject(String sql, @Nullable Object[] args, Class<T> 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
- the SQL query to executeargs
- arguments to bind to the query
(leaving it to the PreparedStatement to guess the corresponding SQL type);
may also contain SqlParameterValue
objects which indicate not
only the argument value but also the SQL type and optionally the scalerequiredType
- the type that the result object is expected to matchnull
in case of SQL NULLIncorrectResultSizeDataAccessException
- if the query does not return exactly one rowIncorrectResultSetColumnCountException
- if the query does not return a row containing a single columnDataAccessException
- if the query failsJdbcOperations.queryForObject(String, Class)
public <T> T queryForObject(String sql, Class<T> requiredType, @Nullable Object... args) 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
- the SQL query to executerequiredType
- the type that the result object is expected to matchargs
- arguments to bind to the query
(leaving it to the PreparedStatement to guess the corresponding SQL type);
may also contain SqlParameterValue
objects which indicate not
only the argument value but also the SQL type and optionally the scalenull
in case of SQL NULLIncorrectResultSizeDataAccessException
- if the query does not return exactly one rowIncorrectResultSetColumnCountException
- if the query does not return a row containing a single columnDataAccessException
- if the query failsJdbcOperations.queryForObject(String, Class)
public Map<String,Object> 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
- the SQL query to executeargs
- arguments to bind to the queryargTypes
- the SQL types of the arguments
(constants from java.sql.Types
)IncorrectResultSizeDataAccessException
- if the query does not return exactly one rowDataAccessException
- if the query failsJdbcOperations.queryForMap(String)
,
ColumnMapRowMapper
,
Types
public Map<String,Object> queryForMap(String sql, @Nullable Object... args) throws DataAccessException
JdbcOperations
The queryForMap
methods defined by this interface are appropriate
when you don't have a domain model. Otherwise, consider using one of the
queryForObject
methods.
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
- the SQL query to executeargs
- arguments to bind to the query
(leaving it to the PreparedStatement to guess the corresponding SQL type);
may also contain SqlParameterValue
objects which indicate not
only the argument value but also the SQL type and optionally the scaleIncorrectResultSizeDataAccessException
- if the query does not return exactly one rowDataAccessException
- if the query failsJdbcOperations.queryForMap(String)
,
ColumnMapRowMapper
public <T> List<T> queryForList(String sql, Object[] args, int[] argTypes, Class<T> 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
- the SQL query to executeargs
- arguments to bind to the queryargTypes
- the 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
@Deprecated public <T> List<T> queryForList(String sql, @Nullable Object[] args, Class<T> 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
- the SQL query to executeargs
- arguments to bind to the query
(leaving it to the PreparedStatement to guess the corresponding SQL type);
may also contain SqlParameterValue
objects which indicate not
only the argument value but also the SQL type and optionally the scaleelementType
- the required type of element in the result list
(for example, Integer.class
)DataAccessException
- if the query failsJdbcOperations.queryForList(String, Class)
,
SingleColumnRowMapper
public <T> List<T> queryForList(String sql, Class<T> elementType, @Nullable Object... args) 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
- the SQL query to executeelementType
- the required type of element in the result list
(for example, Integer.class
)args
- arguments to bind to the query
(leaving it to the PreparedStatement to guess the corresponding SQL type);
may also contain SqlParameterValue
objects which indicate not
only the argument value but also the SQL type and optionally the scaleDataAccessException
- if the query failsJdbcOperations.queryForList(String, Class)
,
SingleColumnRowMapper
public List<Map<String,Object>> 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).
Each element in the list will be of the form returned by this interface's
queryForMap
methods.
queryForList
in interface JdbcOperations
sql
- the SQL query to executeargs
- arguments to bind to the queryargTypes
- the SQL types of the arguments
(constants from java.sql.Types
)DataAccessException
- if the query failsJdbcOperations.queryForList(String)
,
Types
public List<Map<String,Object>> queryForList(String sql, @Nullable 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
- the SQL query to executeargs
- arguments to bind to the query
(leaving it to the PreparedStatement to guess the corresponding SQL type);
may also contain SqlParameterValue
objects which indicate not
only the argument value but also the SQL type and optionally the scaleDataAccessException
- 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, 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
- the SQL query to executeargs
- arguments to bind to the queryargTypes
- the 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, @Nullable 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, 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
- the SQL query to executeargs
- arguments to bind to the query
(leaving it to the PreparedStatement to guess the corresponding SQL type);
may also contain SqlParameterValue
objects which indicate not
only the argument value but also the SQL type and optionally the scalejavax.sql.rowset.CachedRowSet
)DataAccessException
- if there is any problem executing the queryJdbcOperations.queryForRowSet(String)
,
SqlRowSetResultSetExtractor
,
CachedRowSet
protected int update(PreparedStatementCreator psc, @Nullable 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
- a callback that provides SQL and any necessary parametersDataAccessException
- 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
- a callback that provides SQL and any necessary parametersgeneratedKeyHolder
- a KeyHolder that will hold the generated keysDataAccessException
- if there is any problem issuing the updatePreparedStatementCreatorFactory
,
GeneratedKeyHolder
public int update(String sql, @Nullable PreparedStatementSetter pss) throws DataAccessException
JdbcOperations
update
in interface JdbcOperations
sql
- the 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
- the SQL containing bind parametersargs
- arguments to bind to the queryargTypes
- the SQL types of the arguments
(constants from java.sql.Types
)DataAccessException
- if there is any problem issuing the updateTypes
public int update(String sql, @Nullable Object... args) throws DataAccessException
JdbcOperations
update
in interface JdbcOperations
sql
- the SQL containing bind parametersargs
- arguments to bind to the query
(leaving it to the PreparedStatement to guess the corresponding SQL type);
may also contain SqlParameterValue
objects which indicate not
only the argument value but also the SQL type and optionally the scaleDataAccessException
- 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 methodStatement.SUCCESS_NO_INFO
/Statement.EXECUTE_FAILED
)DataAccessException
- if there is any problem issuing the updatepublic int[] batchUpdate(String sql, List<Object[]> batchArgs) throws DataAccessException
JdbcOperations
batchUpdate
in interface JdbcOperations
sql
- the SQL statement to executebatchArgs
- the List of Object arrays containing the batch of arguments for the queryStatement.SUCCESS_NO_INFO
/Statement.EXECUTE_FAILED
)DataAccessException
- if there is any problem issuing the updatepublic int[] batchUpdate(String sql, List<Object[]> batchArgs, int[] argTypes) throws DataAccessException
JdbcOperations
batchUpdate
in interface JdbcOperations
sql
- the SQL statement to execute.batchArgs
- the List of Object arrays containing the batch of arguments for the queryargTypes
- the SQL types of the arguments
(constants from java.sql.Types
)Statement.SUCCESS_NO_INFO
/Statement.EXECUTE_FAILED
)DataAccessException
- if there is any problem issuing the updatepublic <T> int[][] batchUpdate(String sql, Collection<T> batchArgs, int batchSize, ParameterizedPreparedStatementSetter<T> pss) throws DataAccessException
JdbcOperations
batchUpdate
in interface JdbcOperations
sql
- the SQL statement to execute.batchArgs
- the List of Object arrays containing the batch of arguments for the querybatchSize
- batch sizepss
- the ParameterizedPreparedStatementSetter to useStatement.SUCCESS_NO_INFO
/Statement.EXECUTE_FAILED
)DataAccessException
- if there is any problem issuing the update@Nullable public <T> T execute(CallableStatementCreator csc, CallableStatementCallback<T> 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
- a callback that creates a CallableStatement given a Connectionaction
- a callback that specifies the actionnull
if noneDataAccessException
- if there is any problem@Nullable public <T> T execute(String callString, CallableStatementCallback<T> 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
- a callback that specifies the actionnull
if noneDataAccessException
- if there is any problempublic Map<String,Object> call(CallableStatementCreator csc, List<SqlParameter> declaredParameters) throws DataAccessException
JdbcOperations
call
in interface JdbcOperations
csc
- a callback that provides SQL and any necessary parametersdeclaredParameters
- list of declared SqlParameter objectsDataAccessException
- if there is any problem issuing the updateprotected Map<String,Object> extractReturnedResults(CallableStatement cs, @Nullable List<SqlParameter> updateCountParameters, @Nullable List<SqlParameter> resultSetParameters, int updateCount) throws SQLException
cs
- a JDBC wrapper for the stored procedureupdateCountParameters
- the parameter list of declared update count parameters for the stored procedureresultSetParameters
- the parameter list of declared resultSet parameters for the stored procedureSQLException
protected Map<String,Object> extractOutputParameters(CallableStatement cs, List<SqlParameter> parameters) throws SQLException
cs
- the JDBC wrapper for the stored procedureparameters
- parameter list for the stored procedureSQLException
protected Map<String,Object> processResultSet(@Nullable ResultSet rs, ResultSetSupportingSqlParameter param) throws SQLException
rs
- the ResultSet to processparam
- the corresponding stored procedure parameterSQLException
protected RowMapper<Map<String,Object>> getColumnMapRowMapper()
ColumnMapRowMapper
protected <T> RowMapper<T> getSingleColumnRowMapper(Class<T> requiredType)
requiredType
- the type that each result object is expected to matchSingleColumnRowMapper
protected Map<String,Object> createResultsMap()
If resultsMapCaseInsensitive
has been set to true,
a LinkedCaseInsensitiveMap
will be created; otherwise, a
LinkedHashMap
will be created.
setResultsMapCaseInsensitive(boolean)
,
isResultsMapCaseInsensitive()
protected void applyStatementSettings(Statement stmt) throws SQLException
stmt
- the JDBC Statement to prepareSQLException
- if thrown by JDBC APIsetFetchSize(int)
,
setMaxRows(int)
,
setQueryTimeout(int)
,
DataSourceUtils.applyTransactionTimeout(java.sql.Statement, javax.sql.DataSource)
protected PreparedStatementSetter newArgPreparedStatementSetter(@Nullable Object[] args)
By default, we'll create an ArgumentPreparedStatementSetter
.
This method allows for the creation to be overridden by subclasses.
args
- object array with argumentsprotected PreparedStatementSetter newArgTypePreparedStatementSetter(Object[] args, int[] argTypes)
By default, we'll create an ArgumentTypePreparedStatementSetter
.
This method allows for the creation to be overridden by subclasses.
args
- object array with argumentsargTypes
- int array of SQLTypes for the associated argumentsprotected void handleWarnings(Statement stmt) throws SQLException
stmt
- the current JDBC statementSQLWarningException
- if not ignoring warningsSQLException
SQLWarningException
protected void handleWarnings(@Nullable SQLWarning warning) throws SQLWarningException
warning
- the warnings object from the current statement.
May be null
, in which case this method does nothing.SQLWarningException
- in case of an actual warning to be raisedprotected DataAccessException translateException(String task, @Nullable String sql, SQLException ex)
SQLException
into a generic DataAccessException
.task
- readable text describing the task being attemptedsql
- the SQL query or update that caused the problem (may be null
)ex
- the offending SQLException
SQLException
(never null
)JdbcAccessor.getExceptionTranslator()