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, InitializingBean

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 provided by this class, providing SQL and any necessary parameters. The RowCallbackHandler interface extracts values from each row of a ResultSet.

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.

The motivation and design of this class is discussed in detail in Expert One-On-One J2EE Design and Development by Rod Johnson (Wrox, 2002).

Because this class is parameterizable by the callback interfaces and the SQLExceptionTranslator interface, it isn't necessary to subclass it. All SQL issued by this class is logged.

Since:

May 3, 2001

Version:

$Id: JdbcTemplate.java,v 1.35 2004/03/18 02:46:08 trisberg Exp $

Author:

Rod Johnson, Juergen Hoeller, Yann Caroff, Thomas Risberg, Isabelle Muszynski

See Also:

org.springframework.dao, org.springframework.jdbc.datasource, org.springframework.jdbc.object

Nested Class Summary

protected static class	JdbcTemplate.ListResultSetExtractor ResultSetExtractor implementation that returns an ArrayList of HashMaps.
protected static class	JdbcTemplate.ObjectResultSetExtractor ResultSetExtractor implementation that returns single result object.
protected static class	JdbcTemplate.RowCallbackHandlerResultSetExtractor Adapter to enable use of a RowCallbackHandler inside a ResultSetExtractor.
protected static class	JdbcTemplate.SimpleCallableStatementCreator Simple adapter for CallableStatementCreator, allowing to use a plain SQL statement.
protected static class	JdbcTemplate.SimplePreparedStatementCreator Simple adapter for PreparedStatementCreator, allowing to use a plain SQL statement.

Field Summary

protected org.apache.commons.logging.Log

logger

Constructor Summary

JdbcTemplate()
Construct a new JdbcTemplate for bean usage.

JdbcTemplate(javax.sql.DataSource dataSource)
Construct a new JdbcTemplate, given a DataSource to obtain connections from.

Method Summary

int[]	batchUpdate(java.lang.String sql, BatchPreparedStatementSetter pss) Issue multiple updates on a single PreparedStatement, using JDBC 2.0 batch updates and a BatchPreparedStatementSetter to set values.
java.util.Map	call(CallableStatementCreator csc, java.util.List declaredParameters) Execute a SQL call using a CallableStatementCreator to provide SQL and any required parameters.
java.lang.Object	execute(CallableStatementCreator csc, CallableStatementCallback action) Execute the action specified by the given action object within a JDBC CallableStatement.
java.lang.Object	execute(PreparedStatementCreator psc, PreparedStatementCallback action) Execute the action specified by the given action object within a JDBC PreparedStatement.
java.lang.Object	execute(StatementCallback action) Execute the action specified by the given action object within a JDBC Statement.
void	execute(java.lang.String sql) Issue a single SQL execute, typically a DDL statement.
java.lang.Object	execute(java.lang.String callString, CallableStatementCallback action) Execute the action specified by the given action object within a JDBC CallableStatement.
java.lang.Object	execute(java.lang.String sql, PreparedStatementCallback action) Execute the action specified by the given action object within a JDBC PreparedStatement.
protected java.util.Map	extractOutputParameters(java.sql.CallableStatement cs, java.util.List parameters) Extract output parameters from the completed stored procedure.
protected java.util.Map	extractReturnedResultSets(java.sql.CallableStatement cs, java.util.List parameters) Extract returned resultsets from the completed stored procedure.
boolean	getIgnoreWarnings() Return whether or not we ignore SQLWarnings.
NativeJdbcExtractor	getNativeJdbcExtractor() Return the current NativeJdbcExtractor implementation.
protected java.lang.String	getSql(java.lang.Object sqlProvider) Determine SQL from potential provider object.
protected java.lang.Object	query(PreparedStatementCreator psc, PreparedStatementSetter pss, ResultSetExtractor rse) Query using a prepared statement, allowing for a PreparedStatementCreator and a PreparedStatementSetter.
java.lang.Object	query(PreparedStatementCreator psc, ResultSetExtractor rse) Query using a prepared statement.
java.util.List	query(PreparedStatementCreator psc, RowCallbackHandler rch) Query using a prepared statement, reading the ResultSet on a per-row basis with a RowCallbackHandler (potentially implementing the ResultReader sub-interface that provides a result List).
java.util.List	query(java.lang.String sql, java.lang.Object[] args, int[] argTypes, RowCallbackHandler rch) Query given SQL to create a prepared statement from SQL and a list of arguments to bind to the query, reading the ResultSet on a per-row basis with a RowCallbackHandler (potentially implementing the ResultReader sub-interface that provides a result List).
java.util.List	query(java.lang.String sql, java.lang.Object[] args, RowCallbackHandler rch) Query given SQL to create a prepared statement from SQL and a list of arguments to bind to the query, reading the ResultSet on a per-row basis with a RowCallbackHandler (potentially implementing the ResultReader sub-interface that provides a result List).
java.lang.Object	query(java.lang.String sql, PreparedStatementSetter pss, ResultSetExtractor rse) Query using a prepared statement, reading the ResultSet with a ResultSetExtractor.
java.util.List	query(java.lang.String sql, PreparedStatementSetter pss, RowCallbackHandler rch) Query given SQL to create a prepared statement from SQL and a PreparedStatementSetter implementation that knows how to bind values to the query, reading the ResultSet on a per-row basis with a RowCallbackHandler (potentially implementing the ResultReader sub-interface that provides a result List).
java.lang.Object	query(java.lang.String sql, ResultSetExtractor rse) Execute a query given static SQL, reading the ResultSet with a ResultSetExtractor.
java.util.List	query(java.lang.String sql, RowCallbackHandler rch) Execute a query given static SQL, reading the ResultSet on a per-row basis with a RowCallbackHandler (potentially implementing the ResultReader sub-interface that provides a result List).
int	queryForInt(java.lang.String sql) Execute a query that results in an int value, given static SQL.
int	queryForInt(java.lang.String sql, java.lang.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.
java.util.List	queryForList(java.lang.String sql) Execute a query for a result list, given static SQL.
java.util.List	queryForList(java.lang.String sql, java.lang.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.
long	queryForLong(java.lang.String sql) Execute a query that results in a long value, given static SQL.
long	queryForLong(java.lang.String sql, java.lang.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.
java.lang.Object	queryForObject(java.lang.String sql, java.lang.Class requiredType) Execute a query for a result object, given static SQL.
java.lang.Object	queryForObject(java.lang.String sql, java.lang.Object[] args, java.lang.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.
void	setIgnoreWarnings(boolean ignoreWarnings) Set whether or not we want to ignore SQLWarnings.
void	setNativeJdbcExtractor(NativeJdbcExtractor extractor) Set a NativeJdbcExtractor to extract native JDBC objects from wrapped handles.
protected void	throwExceptionOnWarningIfNotIgnoringWarnings(java.sql.SQLWarning warning) Throw an SQLWarningException if we're not ignoring warnings.
int	update(PreparedStatementCreator psc) Issue an update using a PreparedStatementCreator to provide SQL and any required parameters.
protected int	update(PreparedStatementCreator psc, PreparedStatementSetter pss)
int	update(java.lang.String sql) Issue a single SQL update.
int	update(java.lang.String sql, java.lang.Object[] args) Issue an update via a prepared statement, binding the given arguments.
int	update(java.lang.String sql, java.lang.Object[] args, int[] argTypes) Issue an update via a prepared statement, binding the given arguments.
int	update(java.lang.String sql, PreparedStatementSetter pss) Issue an update using a PreparedStatementSetter to set bind parameters, with given SQL.

Methods inherited from class org.springframework.jdbc.support.JdbcAccessor

afterPropertiesSet, getDataSource, getExceptionTranslator, setDataSource, setExceptionTranslator

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.springframework.beans.factory.InitializingBean

afterPropertiesSet

Field Detail

logger

protected final org.apache.commons.logging.Log logger

Constructor Detail

JdbcTemplate

public JdbcTemplate()

Construct a new JdbcTemplate for bean usage. Note: The DataSource has to be set before using the instance. This constructor can be used to prepare a JdbcTemplate via a BeanFactory, typically setting the DataSource via setDataSource.

See Also:

JdbcAccessor.setDataSource(javax.sql.DataSource)

JdbcTemplate

public JdbcTemplate(javax.sql.DataSource dataSource)

Construct a new JdbcTemplate, given a DataSource to obtain connections from. Note: This will trigger eager initialization of the exception translator.

Parameters:

dataSource - JDBC DataSource to obtain connections from

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.

getIgnoreWarnings

public boolean getIgnoreWarnings()

Return whether or not we ignore SQLWarnings. Default is true.

execute

public java.lang.Object execute(StatementCallback action)

Description copied from interface: JdbcOperations

Execute the action specified by the given action object within a JDBC Statement. Allows for returning a result object, i.e. 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

execute

public void execute(java.lang.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 java.lang.Object query(java.lang.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 a null PreparedStatementSetter as a parameter.

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, PreparedStatementSetter, ResultSetExtractor)

query

public java.util.List query(java.lang.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 (potentially implementing the ResultReader sub-interface that provides a result List).

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 PreparedStatementSetter argument.

Specified by:

query in interface JdbcOperations

Parameters:

sql - SQL query to execute

rch - object that will extract results

Returns:

the result List in case of a ResultReader, or null else

Throws:

DataAccessException - if there is any problem executing the query

See Also:

JdbcOperations.query(String, PreparedStatementSetter, RowCallbackHandler)

queryForList

public java.util.List queryForList(java.lang.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.

This method is useful for running static SQL with a known outcome. The results will be mapped to an ArrayList (one entry for each row) of HashMaps (one entry for each column using the column name as the key).

Specified by:

queryForList in interface JdbcOperations

Parameters:

sql - SQL query to execute

Returns:

an ArrayList that contains a HashMap per row

Throws:

DataAccessException - if there is any problem executing the query

See Also:

JdbcOperations.queryForList(String, Object[])

queryForObject

public java.lang.Object queryForObject(java.lang.String sql,
                                       java.lang.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

Throws:

DataAccessException - if there is any problem executing the query

See Also:

JdbcOperations.queryForObject(String, Object[], Class)

queryForLong

public long queryForLong(java.lang.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

Throws:

DataAccessException - if there is any problem executing the query

See Also:

JdbcOperations.queryForLong(String, Object[])

queryForInt

public int queryForInt(java.lang.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

Throws:

DataAccessException - if there is any problem executing the query

See Also:

JdbcOperations.queryForInt(String, Object[])

update

public int update(java.lang.String sql)
           throws DataAccessException

Description copied from interface: JdbcOperations

Issue a single SQL update.

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.

execute

public java.lang.Object execute(PreparedStatementCreator psc,
                                PreparedStatementCallback action)

Description copied from interface: JdbcOperations

Execute the action specified by the given action object within a JDBC PreparedStatement. Allows for returning a result object, i.e. 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

execute

public java.lang.Object execute(java.lang.String sql,
                                PreparedStatementCallback action)

Description copied from interface: JdbcOperations

Execute the action specified by the given action object within a JDBC PreparedStatement. Allows for returning a result object, i.e. 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

query

protected java.lang.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 java.lang.Object query(PreparedStatementCreator psc,
                              ResultSetExtractor rse)

Description copied from interface: JdbcOperations

Query using a prepared statement.

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

query

public java.lang.Object query(java.lang.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 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 java.util.List 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 (potentially implementing the ResultReader sub-interface that provides a result List).

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

Returns:

the result List in case of a ResultReader, or null else

Throws:

DataAccessException - if there is any problem

query

public java.util.List query(java.lang.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 (potentially implementing the ResultReader sub-interface that provides a result List).

Specified by:

query in interface JdbcOperations

Parameters:

sql - SQL 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

Returns:

the result List in case of a ResultReader, or null else

Throws:

DataAccessException - if the query fails

query

public java.util.List query(java.lang.String sql,
                            java.lang.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 (potentially implementing the ResultReader sub-interface that provides a result List).

Specified by:

query in interface JdbcOperations

Parameters:

sql - SQL 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

Returns:

the result List in case of a ResultReader, or null else

Throws:

DataAccessException - if the query fails

See Also:

Types

query

public java.util.List query(java.lang.String sql,
                            java.lang.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 (potentially implementing the ResultReader sub-interface that provides a result List).

Specified by:

query in interface JdbcOperations

Parameters:

sql - SQL to execute

args - arguments to bind to the query (leaving it to the PreparedStatement to guess the respective SQL type)

rch - object that will extract results

Returns:

the result List in case of a ResultReader, or null else

Throws:

DataAccessException - if the query fails

queryForList

public java.util.List queryForList(java.lang.String sql,
                                   java.lang.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.

This method is useful for running static SQL with a known outcome. The results will be mapped to an ArrayList (one entry for each row) of HashMaps (one entry for each column using the column name as the key).

Specified by:

queryForList in interface JdbcOperations

Parameters:

sql - SQL to execute

args - arguments to bind to the query (leaving it to the PreparedStatement to guess the respective SQL type)

Returns:

an ArrayList that contains a HashMap per row

Throws:

DataAccessException - if the query fails

See Also:

JdbcOperations.queryForList(String)

queryForObject

public java.lang.Object queryForObject(java.lang.String sql,
                                       java.lang.Object[] args,
                                       java.lang.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.

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 to execute

args - arguments to bind to the query (leaving it to the PreparedStatement to guess the respective SQL type)

requiredType - the type that the result object is expected to match

Returns:

the result object of the required type

Throws:

DataAccessException - if the query fails

See Also:

JdbcOperations.queryForObject(String, Class)

queryForLong

public long queryForLong(java.lang.String sql,
                         java.lang.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.

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 to execute

args - arguments to bind to the query (leaving it to the PreparedStatement to guess the respective SQL type)

Returns:

the long value

Throws:

DataAccessException - if the query fails

See Also:

JdbcOperations.queryForLong(String)

queryForInt

public int queryForInt(java.lang.String sql,
                       java.lang.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.

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 to execute

args - arguments to bind to the query (leaving it to the PreparedStatement to guess the respective SQL type)

Returns:

the int value

Throws:

DataAccessException - if the query fails

See Also:

JdbcOperations.queryForInt(String)

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 an update using a PreparedStatementCreator to provide SQL and any required parameters.

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

update

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

Description copied from interface: JdbcOperations

Issue an update 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(java.lang.String sql,
                  java.lang.Object[] args,
                  int[] argTypes)
           throws DataAccessException

Description copied from interface: JdbcOperations

Issue an update 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

update

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

Description copied from interface: JdbcOperations

Issue an update 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 respective SQL type)

Returns:

the number of rows affected

Throws:

DataAccessException - if there is any problem issuing the update

batchUpdate

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

Description copied from interface: JdbcOperations

Issue multiple updates on a single PreparedStatement, using JDBC 2.0 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 java.lang.Object execute(CallableStatementCreator csc,
                                CallableStatementCallback action)

Description copied from interface: JdbcOperations

Execute the action specified by the given action object within a JDBC CallableStatement. Allows for returning a result object, i.e. 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

execute

public java.lang.Object execute(java.lang.String callString,
                                CallableStatementCallback action)

Description copied from interface: JdbcOperations

Execute the action specified by the given action object within a JDBC CallableStatement. Allows for returning a result object, i.e. 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

call

public java.util.Map call(CallableStatementCreator csc,
                          java.util.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

Returns:

Map of extracted out parameters

Throws:

DataAccessException - if there is any problem issuing the update

extractOutputParameters

protected java.util.Map extractOutputParameters(java.sql.CallableStatement cs,
                                                java.util.List parameters)
                                         throws java.sql.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:

parameters to the stored procedure

Throws:

java.sql.SQLException

extractReturnedResultSets

protected java.util.Map extractReturnedResultSets(java.sql.CallableStatement cs,
                                                  java.util.List parameters)
                                           throws java.sql.SQLException

Extract returned resultsets from the completed stored procedure.

Parameters:

cs - JDBC wrapper for the stored procedure

parameters - Parameter list for the stored procedure

Throws:

java.sql.SQLException

throwExceptionOnWarningIfNotIgnoringWarnings

protected void throwExceptionOnWarningIfNotIgnoringWarnings(java.sql.SQLWarning warning)
                                                     throws SQLWarningException

Throw an SQLWarningException if we're not ignoring warnings.

Parameters:

warning - warning from current statement. May be null, in which case this method does nothing.

Throws:

SQLWarningException

getSql

protected java.lang.String getSql(java.lang.Object sqlProvider)

Determine SQL from potential provider object.

Parameters:

sqlProvider - object that's potentially a SqlProvider

Returns:

the SQL string, or null

See Also:

SqlProvider