Overview | Package | Class | Use | Tree | Deprecated | Index | Help
| The Spring Framework
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## org.springframework.jdbc.core
Class JdbcTemplate

    java.lang.Object
      org.springframework.jdbc.support.JdbcAccessor
          org.springframework.jdbc.core.JdbcTemplate

All Implemented Interfaces:
  InitializingBean, JdbcOperations

    public class JdbcTemplate

extends JdbcAccessor
implements JdbcOperations

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 SQL operations performed by this class are logged at debug level, using "org.springframework.jdbc.core.JdbcTemplate" as log category.

Since:
  May 3, 2001
Author:
  Rod Johnson, Juergen Hoeller, Thomas Risberg
See Also:
  `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 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.
`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.
`protected Map` | `createResultsMap()` Create a Map instance to be used as results map.
`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` | `extractReturnedResults(CallableStatement cs, List updateCountParameters, List resultSetParameters, 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.
`int` | `getQueryTimeout()` Return the query timeout for statements that this JdbcTemplate executes.
`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, else 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 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.
`void` | `query(PreparedStatementCreator psc, RowCallbackHandler rch)` Query using a prepared statement, reading the ResultSet on a per-row basis with a RowCallbackHandler.
`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.
`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.
`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.
`void` | `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.
`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.
`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.
`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.
`void` | `query(String sql, RowCallbackHandler rch)` Execute a query given static SQL, reading the ResultSet on a per-row basis with a RowCallbackHandler.
`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.
`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 undelared results should be skipped.
`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.

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

### JdbcTemplate

    public JdbcTemplate()

  Construct a new JdbcTemplate for bean usage.

  Note: The DataSource has to be set before using the instance.

  See Also:
    `JdbcAccessor.setDataSource(javax.sql.DataSource)`

### JdbcTemplate

    public JdbcTemplate(DataSource dataSource)

  Construct a new JdbcTemplate, given a DataSource to obtain connections from.

  Note: This will not trigger initialization of the exception translator.

  Parameters:
    `dataSource` - the JDBC DataSource to obtain connections from

### JdbcTemplate

    public JdbcTemplate(DataSource dataSource,
                        boolean lazyInit)

  Construct a new JdbcTemplate, given a DataSource to obtain connections from.

  Note: Depending on the "lazyInit" flag, initialization of the exception translator will be triggered.

  Parameters:
    `dataSource` - the JDBC DataSource to obtain connections from
    `lazyInit` - whether to lazily initialize the SQLExceptionTranslator

Method Detail

### setNativeJdbcExtractor

    public void setNativeJdbcExtractor(NativeJdbcExtractor extractor)

  Set a NativeJdbcExtractor to extract native JDBC objects from wrapped handles. Useful if native Statement and/or ResultSet handles are expected for casting to database-specific implementation classes, but a connection pool that wraps JDBC objects is used (note: any pool will return wrapped Connections).

### getNativeJdbcExtractor

    public NativeJdbcExtractor getNativeJdbcExtractor()

  Return the current NativeJdbcExtractor implementation.

### setIgnoreWarnings

    public void setIgnoreWarnings(boolean ignoreWarnings)

  Set whether or not we want to ignore SQLWarnings.

  Default is "true", swallowing and logging all warnings. Switch this flag to "false" to make the JdbcTemplate throw a SQLWarningException instead.

  See Also:
    `SQLWarning`, `SQLWarningException`, `handleWarnings(java.sql.SQLWarning)`

### isIgnoreWarnings

    public boolean isIgnoreWarnings()

  Return whether or not we ignore SQLWarnings.

### setFetchSize

    public void setFetchSize(int fetchSize)

  Set the fetch size for this JdbcTemplate. This is important for processing large result sets: Setting this higher than the default value will increase processing speed at the cost of memory consumption; setting this lower can avoid transferring row data that will never be read by the application.

  Default is 0, indicating to use the JDBC driver's default.

  See Also:
    `Statement.setFetchSize(int)`

### getFetchSize

    public int getFetchSize()

  Return the fetch size specified for this JdbcTemplate.

### setMaxRows

    public void setMaxRows(int maxRows)

  Set the maximum number of rows for this JdbcTemplate. This is important for processing subsets of large result sets, avoiding to read and hold the entire result set in the database or in the JDBC driver if we're never interested in the entire result in the first place (for example, when performing searches that might return a large number of matches).

  Default is 0, indicating to use the JDBC driver's default.

  See Also:
    `Statement.setMaxRows(int)`

### getMaxRows

    public int getMaxRows()

  Return the maximum number of rows specified for this JdbcTemplate.

### setQueryTimeout

    public void setQueryTimeout(int queryTimeout)

  Set the query timeout for statements that this JdbcTemplate executes.

  Default is 0, indicating to use the JDBC driver's default.

  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.

  See Also:
    `Statement.setQueryTimeout(int)`

### getQueryTimeout

    public int getQueryTimeout()

  Return the query timeout for statements that this JdbcTemplate executes.

### setSkipResultsProcessing

    public void setSkipResultsProcessing(boolean skipResultsProcessing)

  Set whether results processing should be skipped. Can be used to optimize callable statement processing when we know that no results are being passed back - the processing of out parameter will still take place. This can be used to avoid a bug in some older Oracle JDBC drivers like 10.1.0.2.

### isSkipResultsProcessing

    public boolean isSkipResultsProcessing()

  Return whether results processing should be skipped.

### setSkipUndeclaredResults

    public void setSkipUndeclaredResults(boolean skipUndeclaredResults)

  Set whether undelared results should be skipped.

### isSkipUndeclaredResults

    public boolean isSkipUndeclaredResults()

  Return whether undeclared results should be skipped.

### setResultsMapCaseInsensitive

    public 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.

### isResultsMapCaseInsensitive

    public boolean isResultsMapCaseInsensitive()

  Return whether execution of a CallableStatement will return the results in a Map that uses case insensitive names for the parameters.

### execute

    public Object execute(ConnectionCallback action)
                   throws DataAccessException

  Description copied from interface: `JdbcOperations`
  Execute a JDBC data access operation, implemented as callback action working on a JDBC Connection. This allows for implementing arbitrary data access operations, within Spring's managed JDBC environment: that is, participating in Spring-managed transactions and converting JDBC SQLExceptions into Spring's DataAccessException hierarchy.

  The callback action can return a result object, for example a domain object or a collection of domain objects.

  Specified by:
    `execute` in interface `JdbcOperations`
  Parameters:
    `action` - the callback object that specifies the action
  Returns:
    a result object returned by the action, or `null`
  Throws:
    `DataAccessException` - if there is any problem

### createConnectionProxy

    protected Connection createConnectionProxy(Connection con)

  Create a close-suppressing proxy for the given JDBC Connection. Called by the `execute` method.

  The proxy also prepares returned JDBC Statements, applying statement settings such as fetch size, max rows, and query timeout.

  Parameters:
    `con` - the JDBC Connection to create a proxy for
  Returns:
    the Connection proxy
  See Also:
    `Connection.close()`, `execute(ConnectionCallback)`, `applyStatementSettings(java.sql.Statement)`

### execute

    public Object execute(StatementCallback action)
                   throws DataAccessException

  Description copied from interface: `JdbcOperations`
  Execute a JDBC data access operation, implemented as callback action working on a JDBC Statement. This allows for implementing arbitrary data access operations on a single Statement, within Spring's managed JDBC environment: that is, participating in Spring-managed transactions and converting JDBC SQLExceptions into Spring's DataAccessException hierarchy.

  The callback action can return a result object, for example a domain object or a collection of domain objects.

  Specified by:
    `execute` in interface `JdbcOperations`
  Parameters:
    `action` - callback object that specifies the action
  Returns:
    a result object returned by the action, or `null`
  Throws:
    `DataAccessException` - if there is any problem

### execute

    public void execute(String sql)
                 throws DataAccessException

  Description copied from interface: `JdbcOperations`
  Issue a single SQL execute, typically a DDL statement.

  Specified by:
    `execute` in interface `JdbcOperations`
  Parameters:
    `sql` - static SQL to execute
  Throws:
    `DataAccessException` - if there is any problem

### query

    public Object query(String sql,
                        ResultSetExtractor rse)
                 throws DataAccessException

  Description copied from interface: `JdbcOperations`
  Execute a query given static SQL, reading the ResultSet with a ResultSetExtractor.

  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.

  Specified by:
    `query` in interface `JdbcOperations`
  Parameters:
    `sql` - SQL query to execute
    `rse` - object that will extract all rows of results
  Returns:
    an arbitrary result object, as returned by the ResultSetExtractor
  Throws:
    `DataAccessException` - if there is any problem executing the query
  See Also:
    `JdbcOperations.query(String, Object[], ResultSetExtractor)`

### query

    public void query(String sql,
                      RowCallbackHandler rch)
               throws DataAccessException

  Description copied from interface: `JdbcOperations`
  Execute a query given static SQL, reading the ResultSet on a per-row basis with a RowCallbackHandler.

  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.

  Specified by:
    `query` in interface `JdbcOperations`
  Parameters:
    `sql` - SQL query to execute
    `rch` - object that will extract results, one row at a time
  Throws:
    `DataAccessException` - if there is any problem executing the query
  See Also:
    `JdbcOperations.query(String, Object[], RowCallbackHandler)`

### query

    public List query(String sql,
                      RowMapper rowMapper)
               throws DataAccessException

  Description copied from interface: `JdbcOperations`
  Execute a query given static SQL, mapping each row to a Java object via a RowMapper.

  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.

  Specified by:
    `query` in interface `JdbcOperations`
  Parameters:
    `sql` - SQL query to execute
    `rowMapper` - object that will map one object per row
  Returns:
    the result List, containing mapped objects
  Throws:
    `DataAccessException` - if there is any problem executing the query
  See Also:
    `JdbcOperations.query(String, Object[], RowMapper)`

### queryForMap

    public Map queryForMap(String sql)
                    throws DataAccessException

  Description copied from interface: `JdbcOperations`
  Execute a query for a result Map, given static SQL.

  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).

  Specified by:
    `queryForMap` in interface `JdbcOperations`
  Parameters:
    `sql` - SQL query to execute
  Returns:
    the result Map (one entry for each column, using the column name as the key)
  Throws:
    `IncorrectResultSizeDataAccessException` - if the query does not return exactly one row
    `DataAccessException` - if there is any problem executing the query
  See Also:
    `JdbcOperations.queryForMap(String, Object[])`, `ColumnMapRowMapper`

### queryForObject

    public Object queryForObject(String sql,
                                 RowMapper rowMapper)
                          throws DataAccessException

  Description copied from interface: `JdbcOperations`
  Execute a query given static SQL, mapping a single result row to a Java object via a RowMapper.

  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.

  Specified by:
    `queryForObject` in interface `JdbcOperations`
  Parameters:
    `sql` - SQL query to execute
    `rowMapper` - object that will map one object per row
  Returns:
    the single mapped object
  Throws:
    `IncorrectResultSizeDataAccessException` - if the query does not return exactly one row
    `DataAccessException` - if there is any problem executing the query
  See Also:
    `JdbcOperations.queryForObject(String, Object[], RowMapper)`

### queryForObject

    public Object queryForObject(String sql,
                                 Class requiredType)
                          throws DataAccessException

  Description copied from interface: `JdbcOperations`
  Execute a query for a result object, given static SQL.

  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.

  Specified by:
    `queryForObject` in interface `JdbcOperations`
  Parameters:
    `sql` - SQL query to execute
    `requiredType` - the type that the result object is expected to match
  Returns:
    the result object of the required type, or `null` in case of SQL NULL
  Throws:
    `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 query
  See Also:
    `JdbcOperations.queryForObject(String, Object[], Class)`

### queryForLong

    public long queryForLong(String sql)
                      throws DataAccessException

  Description copied from interface: `JdbcOperations`
  Execute a query that results in a long value, given static SQL.

  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.

  Specified by:
    `queryForLong` in interface `JdbcOperations`
  Parameters:
    `sql` - SQL query to execute
  Returns:
    the long value, or 0 in case of SQL NULL
  Throws:
    `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 query
  See Also:
    `JdbcOperations.queryForLong(String, Object[])`

### queryForInt

    public int queryForInt(String sql)
                    throws DataAccessException

  Description copied from interface: `JdbcOperations`
  Execute a query that results in an int value, given static SQL.

  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.

  Specified by:
    `queryForInt` in interface `JdbcOperations`
  Parameters:
    `sql` - SQL query to execute
  Returns:
    the int value, or 0 in case of SQL NULL
  Throws:
    `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 query
  See Also:
    `JdbcOperations.queryForInt(String, Object[])`

### queryForList

    public List queryForList(String sql,
                             Class elementType)
                      throws DataAccessException

  Description copied from interface: `JdbcOperations`
  Execute a query for a result list, given static SQL.

  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.

  Specified by:
    `queryForList` in interface `JdbcOperations`
  Parameters:
    `sql` - SQL query to execute
    `elementType` - the required type of element in the result list (for example, `Integer.class`)
  Returns:
    a List of objects that match the specified element type
  Throws:
    `DataAccessException` - if there is any problem executing the query
  See Also:
    `JdbcOperations.queryForList(String, Object[], Class)`, `SingleColumnRowMapper`

### queryForList

    public List queryForList(String sql)
                      throws DataAccessException

  Description copied from interface: `JdbcOperations`
  Execute a query for a result list, given static SQL.

  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.

  Specified by:
    `queryForList` in interface `JdbcOperations`
  Parameters:
    `sql` - SQL query to execute
  Returns:
    an List that contains a Map per row
  Throws:
    `DataAccessException` - if there is any problem executing the query
  See Also:
    `JdbcOperations.queryForList(String, Object[])`

### queryForRowSet

    public SqlRowSet queryForRowSet(String sql)
                             throws DataAccessException

  Description copied from interface: `JdbcOperations`
  Execute a query for a SqlRowSet, given static SQL.

  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).

  Specified by:
    `queryForRowSet` in interface `JdbcOperations`
  Parameters:
    `sql` - SQL query to execute
  Returns:
    a SqlRowSet representation (possibly a wrapper around a `javax.sql.rowset.CachedRowSet`)
  Throws:
    `DataAccessException` - if there is any problem executing the query
  See Also:
    `JdbcOperations.queryForRowSet(String, Object[])`, `SqlRowSetResultSetExtractor`, `CachedRowSet`

### update

    public int update(String sql)
               throws DataAccessException

  Description copied from interface: `JdbcOperations`
  Issue a single SQL update operation (such as an insert, update or delete statement).

  Specified by:
    `update` in interface `JdbcOperations`
  Parameters:
    `sql` - static SQL to execute
  Returns:
    the number of rows affected
  Throws:
    `DataAccessException` - if there is any problem.

### batchUpdate

    public int[] batchUpdate(String[] sql)
                      throws DataAccessException

  Description copied from interface: `JdbcOperations`
  Issue multiple SQL updates on a single JDBC Statement using batching.

  Will fall back to separate updates on a single Statement if the JDBC driver does not support batch updates.

  Specified by:
    `batchUpdate` in interface `JdbcOperations`
  Parameters:
    `sql` - defining an array of SQL statements that will be executed.
  Returns:
    an array of the number of rows affected by each statement
  Throws:
    `DataAccessException` - if there is any problem executing the batch

### execute

    public Object execute(PreparedStatementCreator psc,
                          PreparedStatementCallback action)
                   throws DataAccessException

  Description copied from interface: `JdbcOperations`
  Execute a JDBC data access operation, implemented as callback action working on a JDBC PreparedStatement. This allows for implementing arbitrary data access operations on a single Statement, within Spring's managed JDBC environment: that is, participating in Spring-managed transactions and converting JDBC SQLExceptions into Spring's DataAccessException hierarchy.

  The callback action can return a result object, for example a domain object or a collection of domain objects.

  Specified by:
    `execute` in interface `JdbcOperations`
  Parameters:
    `psc` - object that can create a PreparedStatement given a Connection
    `action` - callback object that specifies the action
  Returns:
    a result object returned by the action, or `null`
  Throws:
    `DataAccessException` - if there is any problem

### execute

    public Object execute(String sql,
                          PreparedStatementCallback action)
                   throws DataAccessException

  Description copied from interface: `JdbcOperations`
  Execute a JDBC data access operation, implemented as callback action working on a JDBC PreparedStatement. This allows for implementing arbitrary data access operations on a single Statement, within Spring's managed JDBC environment: that is, participating in Spring-managed transactions and converting JDBC SQLExceptions into Spring's DataAccessException hierarchy.

  The callback action can return a result object, for example a domain object or a collection of domain objects.

  Specified by:
    `execute` in interface `JdbcOperations`
  Parameters:
    `sql` - SQL to execute
    `action` - callback object that specifies the action
  Returns:
    a result object returned by the action, or `null`
  Throws:
    `DataAccessException` - if there is any problem

### query

    public Object query(PreparedStatementCreator psc,
                        PreparedStatementSetter pss,
                        ResultSetExtractor rse)
                 throws DataAccessException

  Query using a prepared statement, allowing for a PreparedStatementCreator and a PreparedStatementSetter. Most other query methods use this method, but application code will always work with either a creator or a setter.

  Parameters:
    `psc` - Callback handler that can create a PreparedStatement given a Connection
    `pss` - 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.
  Returns:
    an arbitrary result object, as returned by the ResultSetExtractor
  Throws:
    `DataAccessException` - if there is any problem

### query

    public Object query(PreparedStatementCreator psc,
                        ResultSetExtractor rse)
                 throws DataAccessException

  Description copied from interface: `JdbcOperations`
  Query using a prepared statement, reading the ResultSet with a ResultSetExtractor.

  A PreparedStatementCreator can either be implemented directly or configured through a PreparedStatementCreatorFactory.

  Specified by:
    `query` in interface `JdbcOperations`
  Parameters:
    `psc` - object that can create a PreparedStatement given a Connection
    `rse` - object that will extract results
  Returns:
    an arbitrary result object, as returned by the ResultSetExtractor
  Throws:
    `DataAccessException` - if there is any problem
  See Also:
    `PreparedStatementCreatorFactory`

### query

    public Object query(String sql,
                        PreparedStatementSetter pss,
                        ResultSetExtractor rse)
                 throws DataAccessException

  Description copied from interface: `JdbcOperations`
  Query using a prepared statement, reading the ResultSet with a ResultSetExtractor.

  Specified by:
    `query` in interface `JdbcOperations`
  Parameters:
    `sql` - SQL query to execute
    `pss` - 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
  Returns:
    an arbitrary result object, as returned by the ResultSetExtractor
  Throws:
    `DataAccessException` - if there is any problem

### query

    public Object query(String sql,
                        Object[] args,
                        int[] argTypes,
                        ResultSetExtractor rse)
                 throws DataAccessException

  Description copied from interface: `JdbcOperations`
  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.

  Specified by:
    `query` in interface `JdbcOperations`
  Parameters:
    `sql` - SQL query to execute
    `args` - arguments to bind to the query
    `argTypes` - SQL types of the arguments (constants from `java.sql.Types`)
    `rse` - object that will extract results
  Returns:
    an arbitrary result object, as returned by the ResultSetExtractor
  Throws:
    `DataAccessException` - if the query fails
  See Also:
    `Types`

### query

    public Object query(String sql,
                        Object[] args,
                        ResultSetExtractor rse)
                 throws DataAccessException

  Description copied from interface: `JdbcOperations`
  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.

  Specified by:
    `query` in interface `JdbcOperations`
  Parameters:
    `sql` - SQL query to execute
    `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 scale
    `rse` - object that will extract results
  Returns:
    an arbitrary result object, as returned by the ResultSetExtractor
  Throws:
    `DataAccessException` - if the query fails

### query

    public void query(PreparedStatementCreator psc,
                      RowCallbackHandler rch)
               throws DataAccessException

  Description copied from interface: `JdbcOperations`
  Query using a prepared statement, reading the ResultSet on a per-row basis with a RowCallbackHandler.

  A PreparedStatementCreator can either be implemented directly or configured through a PreparedStatementCreatorFactory.

  Specified by:
    `query` in interface `JdbcOperations`
  Parameters:
    `psc` - object that can create a PreparedStatement given a Connection
    `rch` - object that will extract results, one row at a time
  Throws:
    `DataAccessException` - if there is any problem
  See Also:
    `PreparedStatementCreatorFactory`

### query

    public void query(String sql,
                      PreparedStatementSetter pss,
                      RowCallbackHandler rch)
               throws DataAccessException

  Description copied from interface: `JdbcOperations`
  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.

  Specified by:
    `query` in interface `JdbcOperations`
  Parameters:
    `sql` - SQL query to execute
    `pss` - 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, one row at a time
  Throws:
    `DataAccessException` - if the query fails

### query

    public void query(String sql,
                      Object[] args,
                      int[] argTypes,
                      RowCallbackHandler rch)
               throws DataAccessException

  Description copied from interface: `JdbcOperations`
  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.

  Specified by:
    `query` in interface `JdbcOperations`
  Parameters:
    `sql` - SQL query to execute
    `args` - arguments to bind to the query
    `argTypes` - SQL types of the arguments (constants from `java.sql.Types`)
    `rch` - object that will extract results, one row at a time
  Throws:
    `DataAccessException` - if the query fails
  See Also:
    `Types`

### query

    public void query(String sql,
                      Object[] args,
                      RowCallbackHandler rch)
               throws DataAccessException

  Description copied from interface: `JdbcOperations`
  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.

  Specified by:
    `query` in interface `JdbcOperations`
  Parameters:
    `sql` - SQL query to execute
    `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 scale
    `rch` - object that will extract results, one row at a time
  Throws:
    `DataAccessException` - if the query fails

### query

    public List query(PreparedStatementCreator psc,
                      RowMapper rowMapper)
               throws DataAccessException

  Description copied from interface: `JdbcOperations`
  Query using a prepared statement, mapping each row to a Java object via a RowMapper.

  A PreparedStatementCreator can either be implemented directly or configured through a PreparedStatementCreatorFactory.

  Specified by:
    `query` in interface `JdbcOperations`
  Parameters:
    `psc` - object that can create a PreparedStatement given a Connection
    `rowMapper` - object that will map one object per row
  Returns:
    the result List, containing mapped objects
  Throws:
    `DataAccessException` - if there is any problem
  See Also:
    `PreparedStatementCreatorFactory`

### query

    public List query(String sql,
                      PreparedStatementSetter pss,
                      RowMapper rowMapper)
               throws DataAccessException

  Description copied from interface: `JdbcOperations`
  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.

  Specified by:
    `query` in interface `JdbcOperations`
  Parameters:
    `sql` - SQL query to execute
    `pss` - 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
  Returns:
    the result List, containing mapped objects
  Throws:
    `DataAccessException` - if the query fails

### query

    public List query(String sql,
                      Object[] args,
                      int[] argTypes,
                      RowMapper rowMapper)
               throws DataAccessException

  Description copied from interface: `JdbcOperations`
  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.

  Specified by:
    `query` in interface `JdbcOperations`
  Parameters:
    `sql` - SQL query to execute
    `args` - arguments to bind to the query
    `argTypes` - SQL types of the arguments (constants from `java.sql.Types`)
    `rowMapper` - object that will map one object per row
  Returns:
    the result List, containing mapped objects
  Throws:
    `DataAccessException` - if the query fails
  See Also:
    `Types`

### query

    public List query(String sql,
                      Object[] args,
                      RowMapper rowMapper)
               throws DataAccessException

  Description copied from interface: `JdbcOperations`
  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.

  Specified by:
    `query` in interface `JdbcOperations`
  Parameters:
    `sql` - SQL query to execute
    `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 scale
    `rowMapper` - object that will map one object per row
  Returns:
    the result List, containing mapped objects
  Throws:
    `DataAccessException` - if the query fails

### queryForObject

    public Object queryForObject(String sql,
                                 Object[] args,
                                 int[] argTypes,
                                 RowMapper rowMapper)
                          throws DataAccessException

  Description copied from interface: `JdbcOperations`
  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.

  Specified by:
    `queryForObject` in interface `JdbcOperations`
  Parameters:
    `sql` - SQL query to execute
    `args` - 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
  Returns:
    the single mapped object
  Throws:
    `IncorrectResultSizeDataAccessException` - if the query does not return exactly one row
    `DataAccessException` - if the query fails

### queryForObject

    public Object queryForObject(String sql,
                                 Object[] args,
                                 RowMapper rowMapper)
                          throws DataAccessException

  Description copied from interface: `JdbcOperations`
  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.

  Specified by:
    `queryForObject` in interface `JdbcOperations`
  Parameters:
    `sql` - SQL query to execute
    `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 scale
    `rowMapper` - object that will map one object per row
  Returns:
    the single mapped object
  Throws:
    `IncorrectResultSizeDataAccessException` - if the query does not return exactly one row
    `DataAccessException` - if the query fails

### queryForObject

    public Object queryForObject(String sql,
                                 Object[] args,
                                 int[] argTypes,
                                 Class requiredType)
                          throws DataAccessException

  Description copied from interface: `JdbcOperations`
  Query given SQL to create a prepared statement from SQL and a list of arguments to bind to the query, expecting a result object.

  The query is expected to be a single row/single column query; the returned result will be directly mapped to the corresponding object type.

  Specified by:
    `queryForObject` in interface `JdbcOperations`
  Parameters:
    `sql` - SQL query to execute
    `args` - arguments to bind to the query
    `argTypes` - SQL types of the arguments (constants from `java.sql.Types`)
    `requiredType` - the type that the result object is expected to match
  Returns:
    the result object of the required type, or `null` in case of SQL NULL
  Throws:
    `IncorrectResultSizeDataAccessException` - if the query does not return exactly one row, or does not return exactly one column in that row
    `DataAccessException` - if the query fails
  See Also:
    `JdbcOperations.queryForObject(String, Class)`, `Types`

### queryForObject

    public Object queryForObject(String sql,
                                 Object[] args,
                                 Class requiredType)
                          throws DataAccessException

  Description copied from interface: `JdbcOperations`
  Query given SQL to create a prepared statement from SQL and a list of arguments to bind to the query, expecting a result object.

  The query is expected to be a single row/single column query; the returned result will be directly mapped to the corresponding object type.

  Specified by:
    `queryForObject` in interface `JdbcOperations`
  Parameters:
    `sql` - SQL query to execute
    `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 scale
    `requiredType` - the type that the result object is expected to match
  Returns:
    the result object of the required type, or `null` in case of SQL NULL
  Throws:
    `IncorrectResultSizeDataAccessException` - if the query does not return exactly one row, or does not return exactly one column in that row
    `DataAccessException` - if the query fails
  See Also:
    `JdbcOperations.queryForObject(String, Class)`

### queryForMap

    public Map queryForMap(String sql,
                           Object[] args,
                           int[] argTypes)
                    throws DataAccessException

  Description copied from interface: `JdbcOperations`
  Query given SQL to create a prepared statement from SQL and a list of arguments to bind to the query, expecting a result Map.

  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).

  Specified by:
    `queryForMap` in interface `JdbcOperations`
  Parameters:
    `sql` - SQL query to execute
    `args` - arguments to bind to the query
    `argTypes` - SQL types of the arguments (constants from `java.sql.Types`)
  Returns:
    the result Map (one entry for each column, using the column name as the key)
  Throws:
    `IncorrectResultSizeDataAccessException` - if the query does not return exactly one row
    `DataAccessException` - if the query fails
  See Also:
    `JdbcOperations.queryForMap(String)`, `ColumnMapRowMapper`, `Types`

### queryForMap

    public Map queryForMap(String sql,
                           Object[] args)
                    throws DataAccessException

  Description copied from interface: `JdbcOperations`
  Query given SQL to create a prepared statement from SQL and a list of arguments to bind to the query, expecting a result Map. 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).

  Specified by:
    `queryForMap` in interface `JdbcOperations`
  Parameters:
    `sql` - SQL query to execute
    `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 scale
  Returns:
    the result Map (one entry for each column, using the column name as the key)
  Throws:
    `IncorrectResultSizeDataAccessException` - if the query does not return exactly one row
    `DataAccessException` - if the query fails
  See Also:
    `JdbcOperations.queryForMap(String)`, `ColumnMapRowMapper`

### queryForLong

    public long queryForLong(String sql,
                             Object[] args,
                             int[] argTypes)
                      throws DataAccessException

  Description copied from interface: `JdbcOperations`
  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.

  The query is expected to be a single row/single column query that results in a long value.

  Specified by:
    `queryForLong` in interface `JdbcOperations`
  Parameters:
    `sql` - SQL query to execute
    `args` - arguments to bind to the query
    `argTypes` - SQL types of the arguments (constants from `java.sql.Types`)
  Returns:
    the long value, or 0 in case of SQL NULL
  Throws:
    `IncorrectResultSizeDataAccessException` - if the query does not return exactly one row, or does not return exactly one column in that row
    `DataAccessException` - if the query fails
  See Also:
    `JdbcOperations.queryForLong(String)`, `Types`

### queryForLong

    public long queryForLong(String sql,
                             Object[] args)
                      throws DataAccessException

  Description copied from interface: `JdbcOperations`
  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.

  The query is expected to be a single row/single column query that results in a long value.

  Specified by:
    `queryForLong` in interface `JdbcOperations`
  Parameters:
    `sql` - SQL query to execute
    `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 scale
  Returns:
    the long value, or 0 in case of SQL NULL
  Throws:
    `IncorrectResultSizeDataAccessException` - if the query does not return exactly one row, or does not return exactly one column in that row
    `DataAccessException` - if the query fails
  See Also:
    `JdbcOperations.queryForLong(String)`

### queryForInt

    public int queryForInt(String sql,
                           Object[] args,
                           int[] argTypes)
                    throws DataAccessException

  Description copied from interface: `JdbcOperations`
  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.

  The query is expected to be a single row/single column query that results in an int value.

  Specified by:
    `queryForInt` in interface `JdbcOperations`
  Parameters:
    `sql` - SQL query to execute
    `args` - arguments to bind to the query
    `argTypes` - SQL types of the arguments (constants from `java.sql.Types`)
  Returns:
    the int value, or 0 in case of SQL NULL
  Throws:
    `IncorrectResultSizeDataAccessException` - if the query does not return exactly one row, or does not return exactly one column in that row
    `DataAccessException` - if the query fails
  See Also:
    `JdbcOperations.queryForInt(String)`, `Types`

### queryForInt

    public int queryForInt(String sql,
                           Object[] args)
                    throws DataAccessException

  Description copied from interface: `JdbcOperations`
  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.

  The query is expected to be a single row/single column query that results in an int value.

  Specified by:
    `queryForInt` in interface `JdbcOperations`
  Parameters:
    `sql` - SQL query to execute
    `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 scale
  Returns:
    the int value, or 0 in case of SQL NULL
  Throws:
    `IncorrectResultSizeDataAccessException` - if the query does not return exactly one row, or does not return exactly one column in that row
    `DataAccessException` - if the query fails
  See Also:
    `JdbcOperations.queryForInt(String)`

### queryForList

    public List queryForList(String sql,
                             Object[] args,
                             int[] argTypes,
                             Class elementType)
                      throws DataAccessException

  Description copied from interface: `JdbcOperations`
  Query given SQL to create a prepared statement from SQL and a list of arguments to bind to the query, expecting a result list.

  The results will be mapped to a List (one entry for each row) of result objects, each of them matching the specified element type.

  Specified by:
    `queryForList` in interface `JdbcOperations`
  Parameters:
    `sql` - SQL query to execute
    `args` - arguments to bind to the query
    `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`)
  Returns:
    a List of objects that match the specified element type
  Throws:
    `DataAccessException` - if the query fails
  See Also:
    `JdbcOperations.queryForList(String, Class)`, `SingleColumnRowMapper`

### queryForList

    public List queryForList(String sql,
                             Object[] args,
                             Class elementType)
                      throws DataAccessException

  Description copied from interface: `JdbcOperations`
  Query given SQL to create a prepared statement from SQL and a list of arguments to bind to the query, expecting a result list.

  The results will be mapped to a List (one entry for each row) of result objects, each of them matching the specified element type.

  Specified by:
    `queryForList` in interface `JdbcOperations`
  Parameters:
    `sql` - SQL query to execute
    `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 scale
    `elementType` - the required type of element in the result list (for example, `Integer.class`)
  Returns:
    a List of objects that match the specified element type
  Throws:
    `DataAccessException` - if the query fails
  See Also:
    `JdbcOperations.queryForList(String, Class)`, `SingleColumnRowMapper`

### queryForList

    public List queryForList(String sql,
                             Object[] args,
                             int[] argTypes)
                      throws DataAccessException

  Description copied from interface: `JdbcOperations`
  Query given SQL to create a prepared statement from SQL and a list of arguments to bind to the query, expecting a result list.

  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.

  Specified by:
    `queryForList` in interface `JdbcOperations`
  Parameters:
    `sql` - SQL query to execute
    `args` - arguments to bind to the query
    `argTypes` - SQL types of the arguments (constants from `java.sql.Types`)
  Returns:
    a List that contains a Map per row
  Throws:
    `DataAccessException` - if the query fails
  See Also:
    `JdbcOperations.queryForList(String)`, `Types`

### queryForList

    public List queryForList(String sql,
                             Object[] args)
                      throws DataAccessException

  Description copied from interface: `JdbcOperations`
  Query given SQL to create a prepared statement from SQL and a list of arguments to bind to the query, expecting a result list.

  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.

  Specified by:
    `queryForList` in interface `JdbcOperations`
  Parameters:
    `sql` - SQL query to execute
    `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 scale
  Returns:
    a List that contains a Map per row
  Throws:
    `DataAccessException` - if the query fails
  See Also:
    `JdbcOperations.queryForList(String)`

### queryForRowSet

    public SqlRowSet queryForRowSet(String sql,
                                    Object[] args,
                                    int[] argTypes)
                             throws DataAccessException

  Description copied from interface: `JdbcOperations`
  Query given SQL to create a prepared statement from SQL and a list of arguments to bind to the query, expecting a SqlRowSet.

  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).

  Specified by:
    `queryForRowSet` in interface `JdbcOperations`
  Parameters:
    `sql` - SQL query to execute
    `args` - arguments to bind to the query
    `argTypes` - SQL types of the arguments (constants from `java.sql.Types`)
  Returns:
    a SqlRowSet representation (possibly a wrapper around a `javax.sql.rowset.CachedRowSet`)
  Throws:
    `DataAccessException` - if there is any problem executing the query
  See Also:
    `JdbcOperations.queryForRowSet(String)`, `SqlRowSetResultSetExtractor`, `CachedRowSet`, `Types`

### queryForRowSet

    public SqlRowSet queryForRowSet(String sql,
                                    Object[] args)
                             throws DataAccessException

  Description copied from interface: `JdbcOperations`
  Query given SQL to create a prepared statement from SQL and a list of arguments to bind to the query, expecting a SqlRowSet.

  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).

  Specified by:
    `queryForRowSet` in interface `JdbcOperations`
  Parameters:
    `sql` - SQL query to execute
    `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 scale
  Returns:
    a SqlRowSet representation (possibly a wrapper around a `javax.sql.rowset.CachedRowSet`)
  Throws:
    `DataAccessException` - if there is any problem executing the query
  See Also:
    `JdbcOperations.queryForRowSet(String)`, `SqlRowSetResultSetExtractor`, `CachedRowSet`

### update

    protected int update(PreparedStatementCreator psc,
                         PreparedStatementSetter pss)
                  throws DataAccessException

  Throws:
    `DataAccessException`

### update

    public int update(PreparedStatementCreator psc)
               throws DataAccessException

  Description copied from interface: `JdbcOperations`
  Issue a single SQL update operation (such as an insert, update or delete statement) using a PreparedStatementCreator to provide SQL and any required parameters.

  A PreparedStatementCreator can either be implemented directly or configured through a PreparedStatementCreatorFactory.

  Specified by:
    `update` in interface `JdbcOperations`
  Parameters:
    `psc` - object that provides SQL and any necessary parameters
  Returns:
    the number of rows affected
  Throws:
    `DataAccessException` - if there is any problem issuing the update
  See Also:
    `PreparedStatementCreatorFactory`

### update

    public int update(PreparedStatementCreator psc,
                      KeyHolder generatedKeyHolder)
               throws DataAccessException

  Description copied from interface: `JdbcOperations`
  Issue an update statement using a PreparedStatementCreator to provide SQL and any required parameters. Generated keys will be put into the given KeyHolder.

  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.

  Specified by:
    `update` in interface `JdbcOperations`
  Parameters:
    `psc` - object that provides SQL and any necessary parameters
    `generatedKeyHolder` - KeyHolder that will hold the generated keys
  Returns:
    the number of rows affected
  Throws:
    `DataAccessException` - if there is any problem issuing the update
  See Also:
    `PreparedStatementCreatorFactory`, `GeneratedKeyHolder`

### update

    public int update(String sql,
                      PreparedStatementSetter pss)
               throws DataAccessException

  Description copied from interface: `JdbcOperations`
  Issue an update statement using a PreparedStatementSetter to set bind parameters, with given SQL. Simpler than using a PreparedStatementCreator as this method will create the PreparedStatement: The PreparedStatementSetter just needs to set parameters.

  Specified by:
    `update` in interface `JdbcOperations`
  Parameters:
    `sql` - SQL containing bind parameters
    `pss` - helper that sets bind parameters. If this is `null` we run an update with static SQL.
  Returns:
    the number of rows affected
  Throws:
    `DataAccessException` - if there is any problem issuing the update

### update

    public int update(String sql,
                      Object[] args,
                      int[] argTypes)
               throws DataAccessException

  Description copied from interface: `JdbcOperations`
  Issue a single SQL update operation (such as an insert, update or delete statement) via a prepared statement, binding the given arguments.

  Specified by:
    `update` in interface `JdbcOperations`
  Parameters:
    `sql` - SQL containing bind parameters
    `args` - arguments to bind to the query
    `argTypes` - SQL types of the arguments (constants from `java.sql.Types`)
  Returns:
    the number of rows affected
  Throws:
    `DataAccessException` - if there is any problem issuing the update
  See Also:
    `Types`

### update

    public int update(String sql,
                      Object[] args)
               throws DataAccessException

  Description copied from interface: `JdbcOperations`
  Issue a single SQL update operation (such as an insert, update or delete statement) via a prepared statement, binding the given arguments.

  Specified by:
    `update` in interface `JdbcOperations`
  Parameters:
    `sql` - SQL containing bind parameters
    `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 scale
  Returns:
    the number of rows affected
  Throws:
    `DataAccessException` - if there is any problem issuing the update

### batchUpdate

    public int[] batchUpdate(String sql,
                             BatchPreparedStatementSetter pss)
                      throws DataAccessException

  Description copied from interface: `JdbcOperations`
  Issue multiple update statements on a single PreparedStatement, using batch updates and a BatchPreparedStatementSetter to set values.

  Will fall back to separate updates on a single PreparedStatement if the JDBC driver does not support batch updates.

  Specified by:
    `batchUpdate` in interface `JdbcOperations`
  Parameters:
    `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
  Returns:
    an array of the number of rows affected by each statement
  Throws:
    `DataAccessException` - if there is any problem issuing the update

### execute

    public Object execute(CallableStatementCreator csc,
                          CallableStatementCallback action)
                   throws DataAccessException

  Description copied from interface: `JdbcOperations`
  Execute a JDBC data access operation, implemented as callback action working on a JDBC CallableStatement. This allows for implementing arbitrary data access operations on a single Statement, within Spring's managed JDBC environment: that is, participating in Spring-managed transactions and converting JDBC SQLExceptions into Spring's DataAccessException hierarchy.

  The callback action can return a result object, for example a domain object or a collection of domain objects.

  Specified by:
    `execute` in interface `JdbcOperations`
  Parameters:
    `csc` - object that can create a CallableStatement given a Connection
    `action` - callback object that specifies the action
  Returns:
    a result object returned by the action, or `null`
  Throws:
    `DataAccessException` - if there is any problem

### execute

    public Object execute(String callString,
                          CallableStatementCallback action)
                   throws DataAccessException

  Description copied from interface: `JdbcOperations`
  Execute a JDBC data access operation, implemented as callback action working on a JDBC CallableStatement. This allows for implementing arbitrary data access operations on a single Statement, within Spring's managed JDBC environment: that is, participating in Spring-managed transactions and converting JDBC SQLExceptions into Spring's DataAccessException hierarchy.

  The callback action can return a result object, for example a domain object or a collection of domain objects.

  Specified by:
    `execute` in interface `JdbcOperations`
  Parameters:
    `callString` - the SQL call string to execute
    `action` - callback object that specifies the action
  Returns:
    a result object returned by the action, or `null`
  Throws:
    `DataAccessException` - if there is any problem

### call

    public Map call(CallableStatementCreator csc,
                    List declaredParameters)
             throws DataAccessException

  Description copied from interface: `JdbcOperations`
  Execute a SQL call using a CallableStatementCreator to provide SQL and any required parameters.

  Specified by:
    `call` in interface `JdbcOperations`
  Parameters:
    `csc` - object that provides SQL and any necessary parameters
    `declaredParameters` - list of declared SqlParameter objects
  Returns:
    Map of extracted out parameters
  Throws:
    `DataAccessException` - if there is any problem issuing the update

### extractReturnedResults

    protected Map extractReturnedResults(CallableStatement cs,
                                         List updateCountParameters,
                                         List resultSetParameters,
                                         int updateCount)
                                  throws SQLException

  Extract returned ResultSets from the completed stored procedure.

  Parameters:
    `cs` - JDBC wrapper for the stored procedure
    `updateCountParameters` - Parameter list of declared update count parameters for the stored procedure
    `resultSetParameters` - Parameter list of declared resturn resultSet parameters for the stored procedure
  Returns:
    Map that contains returned results
  Throws:
    `SQLException`

### extractOutputParameters

    protected Map extractOutputParameters(CallableStatement cs,
                                          List parameters)
                                   throws SQLException

  Extract output parameters from the completed stored procedure.

  Parameters:
    `cs` - JDBC wrapper for the stored procedure
    `parameters` - parameter list for the stored procedure
  Returns:
    Map that contains returned results
  Throws:
    `SQLException`

### processResultSet

    protected Map processResultSet(ResultSet rs,
                                   ResultSetSupportingSqlParameter param)
                            throws SQLException

  Process the given ResultSet from a stored procedure.

  Parameters:
    `rs` - the ResultSet to process
    `param` - the corresponding stored procedure parameter
  Returns:
    Map that contains returned results
  Throws:
    `SQLException`

### getColumnMapRowMapper

    protected RowMapper getColumnMapRowMapper()

  Create a new RowMapper for reading columns as key-value pairs.

  Returns:
    the RowMapper to use
  See Also:
    `ColumnMapRowMapper`

### getSingleColumnRowMapper

    protected RowMapper getSingleColumnRowMapper(Class requiredType)

  Create a new RowMapper for reading result objects from a single column.

  Parameters:
    `requiredType` - the type that each result object is expected to match
  Returns:
    the RowMapper to use
  See Also:
    `SingleColumnRowMapper`

### createResultsMap

    protected Map createResultsMap()

  Create a Map instance to be used as results map.

  If "isResultsMapCaseInsensitive" has been set to true, a linked case-insensitive Map will be created if possible, else a plain HashMap (see Spring's CollectionFactory).

  Returns:
    the results Map instance
  See Also:
    `setResultsMapCaseInsensitive(boolean)`, `CollectionFactory.createLinkedCaseInsensitiveMapIfPossible(int)`

### applyStatementSettings

    protected void applyStatementSettings(Statement stmt)
                                   throws SQLException

  Prepare the given JDBC Statement (or PreparedStatement or CallableStatement), applying statement settings such as fetch size, max rows, and query timeout.

  Parameters:
    `stmt` - the JDBC Statement to prepare
  Throws:
    `SQLException` - if thrown by JDBC API
  See Also:
    `setFetchSize(int)`, `setMaxRows(int)`, `setQueryTimeout(int)`, `DataSourceUtils.applyTransactionTimeout(java.sql.Statement, javax.sql.DataSource)`

### handleWarnings

    protected void handleWarnings(SQLWarning warning)
                           throws SQLWarningException

  Throw an SQLWarningException if we're not ignoring warnings, else log the warnings (at debug level).

  Parameters:
    `warning` - the warnings object from the current statement. May be `null`, in which case this method does nothing.
  Throws:
    `SQLWarningException` - if not ignoring warnings
  See Also:
    `SQLWarningException`

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
| The Spring Framework
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Copyright © 2002-2008 The Spring Framework.