public class

SqlUpdate

extends SqlOperation

java.lang.Object
↳	org.springframework.jdbc.object.RdbmsOperation
	↳	org.springframework.jdbc.object.SqlOperation
		↳	org.springframework.jdbc.object.SqlUpdate

Known Direct Subclasses

BatchSqlUpdate

Class Overview

Reusable operation object representing a SQL update.

This class provides a number of update methods, analogous to the execute methods of query objects.

This class is concrete. Although it can be subclassed (for example to add a custom update method) it can easily be parameterized by setting SQL and declaring parameters.

Like all RdbmsOperation classes that ship with the Spring Framework, SqlQuery instances are thread-safe after their initialization is complete. That is, after they are constructed and configured via their setter methods, they can be used safely from multiple threads.

Summary

[Expand]

Inherited Fields

From class org.springframework.jdbc.object.RdbmsOperation

Public Constructors
	SqlUpdate() Constructor to allow use as a JavaBean.
	SqlUpdate(DataSource ds, String sql) Constructs an update object with a given DataSource and SQL.
	SqlUpdate(DataSource ds, String sql, int[] types) Construct an update object with a given DataSource, SQL and anonymous parameters.
	SqlUpdate(DataSource ds, String sql, int[] types, int maxRowsAffected) Construct an update object with a given DataSource, SQL, anonymous parameters and specifying the maximum number of rows that may be affected.

Public Methods
void	setMaxRowsAffected(int maxRowsAffected) Set the maximum number of rows that may be affected by this update.
void	setRequiredRowsAffected(int requiredRowsAffected) Set the exact number of rows that must be affected by this update.
int	update(String p1, String p2) Convenient method to execute an update given two String args.
int	update(int p1, int p2) Convenient method to execute an update given two int args.
int	update(long p1, long p2) Convenient method to execute an update given two long args.
int	update(long p1) Convenient method to execute an update given one long arg.
int	update(Object[] params, KeyHolder generatedKeyHolder) Method to execute the update given arguments and retrieve the generated keys using a KeyHolder.
int	update(int p1) Convenient method to execute an update given one int arg.
int	update() Convenience method to execute an update with no parameters.
int	update(Object... params) Generic method to execute the update given parameters.
int	update(String p) Convenient method to execute an update given one String arg.
int	updateByNamedParam(Map<String, ?> paramMap, KeyHolder generatedKeyHolder) Method to execute the update given arguments and retrieve the generated keys using a KeyHolder.
int	updateByNamedParam(Map<String, ?> paramMap) Generic method to execute the update given named parameters.

Protected Methods
void	checkRowsAffected(int rowsAffected) Check the given number of affected rows against the specified maximum number or required number.

[Expand]

Inherited Methods

From class org.springframework.jdbc.object.SqlOperation

From class org.springframework.jdbc.object.RdbmsOperation

void	afterPropertiesSet() Ensures compilation if used in a bean factory.
boolean	allowsUnusedParameters() Return whether this operation accepts additional parameters that are given but not actually used.
void	checkCompiled() Check whether this operation has been compiled already; lazily compile it if not already compiled.
final void	compile() Compile this query.
abstract void	compileInternal() Subclasses must implement this template method to perform their own compilation.
void	declareParameter(SqlParameter param) Declare a parameter for this operation.
List<SqlParameter>	getDeclaredParameters() Return a list of the declared `SqlParameter` objects.
String[]	getGeneratedKeysColumnNames() Return the column names of the auto generated keys.
JdbcTemplate	getJdbcTemplate() Return the JdbcTemplate object used by this object.
int	getResultSetType() Return whether statements will return a specific type of ResultSet.
String	getSql() Subclasses can override this to supply dynamic SQL if they wish, but SQL is normally set by calling the setSql() method or in a subclass constructor.
boolean	isCompiled() Is this operation "compiled"? Compilation, as in JDO, means that the operation is fully configured, and ready to use.
boolean	isReturnGeneratedKeys() Return whether statements should be capable of returning auto-generated keys.
boolean	isUpdatableResults() Return whether statements will return updatable ResultSets.
void	setDataSource(DataSource dataSource) Set the JDBC DataSource to obtain connections from.
void	setFetchSize(int fetchSize) Set the fetch size for this RDBMS operation.
void	setGeneratedKeysColumnNames(String[] names) Set the column names of the auto-generated keys.
void	setJdbcTemplate(JdbcTemplate jdbcTemplate) An alternative to the more commonly used setDataSource() when you want to use the same JdbcTemplate in multiple RdbmsOperations.
void	setMaxRows(int maxRows) Set the maximum number of rows for this RDBMS operation.
void	setParameters(SqlParameter[] parameters) Add one or more declared parameters.
void	setQueryTimeout(int queryTimeout) Set the query timeout for statements that this RDBMS operation executes.
void	setResultSetType(int resultSetType) Set whether to use statements that return a specific type of ResultSet.
void	setReturnGeneratedKeys(boolean returnGeneratedKeys) Set whether prepared statements should be capable of returning auto-generated keys.
void	setSql(String sql) Set the SQL executed by this operation.
void	setTypes(int[] types) Add anonymous parameters, specifying only their SQL types as defined in the `java.sql.Types` class.
void	setUpdatableResults(boolean updatableResults) Set whether to use statements that are capable of returning updatable ResultSets.
boolean	supportsLobParameters() Return whether BLOB/CLOB parameters are supported for this kind of operation.
void	validateNamedParameters(Map<String, ?> parameters) Validate the named parameters passed to an execute method based on declared parameters.
void	validateParameters(Object[] parameters) Validate the parameters passed to an execute method based on declared parameters.

From class java.lang.Object

From interface org.springframework.beans.factory.InitializingBean

Public Constructors

public SqlUpdate ()

Constructor to allow use as a JavaBean. DataSource and SQL must be supplied before compilation and use.

public SqlUpdate (DataSource ds, String sql)

Constructs an update object with a given DataSource and SQL.

Parameters

ds	DataSource to use to obtain connections
sql	SQL statement to execute

public SqlUpdate (DataSource ds, String sql, int[] types)

Construct an update object with a given DataSource, SQL and anonymous parameters.

Parameters

ds	DataSource to use to obtain connections
sql	SQL statement to execute
types	SQL types of the parameters, as defined in the `java.sql.Types` class

public SqlUpdate (DataSource ds, String sql, int[] types, int maxRowsAffected)

Construct an update object with a given DataSource, SQL, anonymous parameters and specifying the maximum number of rows that may be affected.

Parameters

ds	DataSource to use to obtain connections
sql	SQL statement to execute
types	SQL types of the parameters, as defined in the `java.sql.Types` class
maxRowsAffected	the maximum number of rows that may be affected by the update

Public Methods

public void setMaxRowsAffected (int maxRowsAffected)

Set the maximum number of rows that may be affected by this update. The default value is 0, which does not limit the number of rows affected.

Parameters

maxRowsAffected	the maximum number of rows that can be affected by this update without this class's update method considering it an error

public void setRequiredRowsAffected (int requiredRowsAffected)

Set the exact number of rows that must be affected by this update. The default value is 0, which allows any number of rows to be affected.

This is an alternative to setting the maximum number of rows that may be affected.

Parameters

requiredRowsAffected	the exact number of rows that must be affected by this update without this class's update method considering it an error

public int update (String p1, String p2)

Convenient method to execute an update given two String args.

Throws

DataAccessException

public int update (int p1, int p2)

Convenient method to execute an update given two int args.

Throws

DataAccessException

public int update (long p1, long p2)

Convenient method to execute an update given two long args.

Throws

DataAccessException

public int update (long p1)

Convenient method to execute an update given one long arg.

Throws

DataAccessException

public int update (Object[] params, KeyHolder generatedKeyHolder)

Method to execute the update given arguments and retrieve the generated keys using a KeyHolder.

Parameters

params	array of parameter objects
generatedKeyHolder	KeyHolder that will hold the generated keys

Returns

the number of rows affected by the update

Throws

DataAccessException

public int update (int p1)

Convenient method to execute an update given one int arg.

Throws

DataAccessException

public int update ()

Convenience method to execute an update with no parameters.

Throws

DataAccessException

public int update (Object... params)

Generic method to execute the update given parameters. All other update methods invoke this method.

Parameters

params	array of parameters objects

Returns

the number of rows affected by the update

Throws

DataAccessException

public int update (String p)

Convenient method to execute an update given one String arg.

Throws

DataAccessException

public int updateByNamedParam (Map<String, ?> paramMap, KeyHolder generatedKeyHolder)

Method to execute the update given arguments and retrieve the generated keys using a KeyHolder.

Parameters

paramMap	Map of parameter name to parameter object, matching named parameters specified in the SQL statement
generatedKeyHolder	KeyHolder that will hold the generated keys

Returns

the number of rows affected by the update

Throws

DataAccessException

public int updateByNamedParam (Map<String, ?> paramMap)

Generic method to execute the update given named parameters. All other update methods invoke this method.

Parameters

paramMap	Map of parameter name to parameter object, matching named parameters specified in the SQL statement

Returns

the number of rows affected by the update

Throws

DataAccessException

Protected Methods

protected void checkRowsAffected (int rowsAffected)

Check the given number of affected rows against the specified maximum number or required number.

Parameters

rowsAffected	the number of affected rows

Throws

JdbcUpdateAffectedIncorrectNumberOfRowsException	if the actually affected rows are out of bounds

Classes

SqlUpdate

Class Overview

See Also

Summary

Public Constructors

public SqlUpdate ()

See Also

public SqlUpdate (DataSource ds, String sql)

Parameters

public SqlUpdate (DataSource ds, String sql, int[] types)

Parameters

See Also

public SqlUpdate (DataSource ds, String sql, int[] types, int maxRowsAffected)

Parameters

See Also

Public Methods

public void setMaxRowsAffected (int maxRowsAffected)

Parameters

public void setRequiredRowsAffected (int requiredRowsAffected)

Parameters

public int update (String p1, String p2)

Throws

public int update (int p1, int p2)

Throws

public int update (long p1, long p2)

Throws

public int update (long p1)

Throws

public int update (Object[] params, KeyHolder generatedKeyHolder)

Parameters

Returns

Throws

public int update (int p1)

Throws

public int update ()

Throws

public int update (Object... params)

Parameters

Returns

Throws

public int update (String p)

Throws

public int updateByNamedParam (Map<String, ?> paramMap, KeyHolder generatedKeyHolder)

Parameters

Returns

Throws

public int updateByNamedParam (Map<String, ?> paramMap)

Parameters

Returns

Throws

Protected Methods

protected void checkRowsAffected (int rowsAffected)

Parameters

Throws

See Also