Class RdbmsOperation

java.lang.Object
org.springframework.jdbc.object.RdbmsOperation
All Implemented Interfaces:
InitializingBean
Direct Known Subclasses:
SqlCall, SqlOperation
public abstract class RdbmsOperation extends Object implements InitializingBean
An "RDBMS operation" is a multithreaded, reusable object representing a query, update, or stored procedure call. An RDBMS operation is not a command, as a command is not reusable. However, execute methods may take commands as arguments. Subclasses should be JavaBeans, allowing easy configuration.

This class and subclasses throw runtime exceptions, defined in the org.springframework.dao package (and as thrown by the org.springframework.jdbc.core package, which the classes in this package use under the hood to perform raw JDBC operations).

Subclasses should set SQL and add parameters before invoking the compile() method. The order in which parameters are added is significant. The appropriate execute or update method can then be invoked.

Author:
Rod Johnson, Juergen Hoeller
See Also:

  • Field Details

    • logger

      protected final org.apache.commons.logging.Log logger
      Logger available to subclasses.

  • Constructor Details

    • RdbmsOperation

      public RdbmsOperation()

  • Method Details

    • setJdbcTemplate

      public void setJdbcTemplate(JdbcTemplate jdbcTemplate)
      An alternative to the more commonly used setDataSource(DataSource) when you want to use the same JdbcTemplate in multiple RdbmsOperations. This is appropriate if the JdbcTemplate has special configuration such as a SQLExceptionTranslator to be reused.

    • getJdbcTemplate

      public JdbcTemplate getJdbcTemplate()
      Return the JdbcTemplate used by this operation object.

    • setDataSource

      public void setDataSource(DataSource dataSource)
      Set the JDBC DataSource to obtain connections from.
      See Also:

    • setFetchSize

      public void setFetchSize(int fetchSize)
      Set the fetch size for this RDBMS operation. 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 -1, indicating to use the driver's default.

      See Also:

    • setMaxRows

      public void setMaxRows(int maxRows)
      Set the maximum number of rows for this RDBMS operation. This is important for processing subsets of large result sets, in order to avoid reading and holding the entire result set in the database or in the JDBC driver.

      Default is -1, indicating to use the driver's default.

      See Also:

    • setQueryTimeout

      public void setQueryTimeout(int queryTimeout)
      Set the query timeout for statements that this RDBMS operation executes.

      Default is -1, 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.

    • setResultSetType

      public void setResultSetType(int resultSetType)
      Set whether to use statements that return a specific type of ResultSet.
      Parameters:
      resultSetType - the ResultSet type
      See Also:

    • getResultSetType

      public int getResultSetType()
      Return whether statements will return a specific type of ResultSet.

    • setUpdatableResults

      public void setUpdatableResults(boolean updatableResults)
      Set whether to use statements that are capable of returning updatable ResultSets.
      See Also:

    • isUpdatableResults

      public boolean isUpdatableResults()
      Return whether statements will return updatable ResultSets.

    • setReturnGeneratedKeys

      public void setReturnGeneratedKeys(boolean returnGeneratedKeys)
      Set whether prepared statements should be capable of returning auto-generated keys.
      See Also:

    • isReturnGeneratedKeys

      public boolean isReturnGeneratedKeys()
      Return whether statements should be capable of returning auto-generated keys.

    • setGeneratedKeysColumnNames

      public void setGeneratedKeysColumnNames(String @Nullable ... names)
      Set the column names of the auto-generated keys.
      See Also:

    • getGeneratedKeysColumnNames

      public String @Nullable [] getGeneratedKeysColumnNames()
      Return the column names of the auto generated keys.

    • setSql

      public void setSql(@Nullable String sql)
      Set the SQL executed by this operation.

    • getSql

      public @Nullable String getSql()
      Subclasses can override this to supply dynamic SQL if they wish, but SQL is normally set by calling the setSql(String) method or in a subclass constructor.

    • resolveSql

      protected String resolveSql()
      Resolve the configured SQL for actual use.
      Returns:
      the SQL (never null)
      Since:
      5.0

    • setTypes

      public void setTypes(int @Nullable [] types) throws InvalidDataAccessApiUsageException
      Add anonymous parameters, specifying only their SQL types as defined in the java.sql.Types class.

      Parameter ordering is significant. This method is an alternative to the declareParameter(SqlParameter) method, which should normally be preferred.

      Parameters:
      types - array of SQL types as defined in the java.sql.Types class
      Throws:
      InvalidDataAccessApiUsageException - if the operation is already compiled

    • declareParameter

      public void declareParameter(SqlParameter param) throws InvalidDataAccessApiUsageException
      Declare a parameter for this operation.

      The order in which this method is called is significant when using positional parameters. It is not significant when using named parameters with named SqlParameter objects here; it remains significant when using named parameters in combination with unnamed SqlParameter objects here.

      Parameters:
      param - the SqlParameter to add. This will specify SQL type and (optionally) the parameter's name. Note that you typically use the SqlParameter class itself here, not any of its subclasses.
      Throws:
      InvalidDataAccessApiUsageException - if the operation is already compiled, and hence cannot be configured further

    • setParameters

      public void setParameters(SqlParameter... parameters)
      Add one or more declared parameters. Used for configuring this operation when used in a bean factory. Each parameter will specify SQL type and (optionally) the parameter's name.
      Parameters:
      parameters - an array containing the declared SqlParameter objects
      See Also:
      • declaredParameters

    • getDeclaredParameters

      protected List<SqlParameter> getDeclaredParameters()
      Return a list of the declared SqlParameter objects.

    • afterPropertiesSet

      public void afterPropertiesSet()
      Ensures compilation if used in a bean factory.
      Specified by:
      afterPropertiesSet in interface InitializingBean

    • compile

      public final void compile() throws InvalidDataAccessApiUsageException
      Compile this query. Ignores subsequent attempts to compile.
      Throws:
      InvalidDataAccessApiUsageException - if the object hasn't been correctly initialized, for example if no DataSource has been provided

    • isCompiled

      public boolean isCompiled()
      Is this operation "compiled"? Compilation, as in JDO, means that the operation is fully configured, and ready to use. The exact meaning of compilation will vary between subclasses.
      Returns:
      whether this operation is compiled and ready to use

    • checkCompiled

      protected void checkCompiled()
      Check whether this operation has been compiled already; lazily compile it if not already compiled.

      Automatically called by validateParameters.

      See Also:

    • validateParameters

      protected void validateParameters(Object @Nullable [] parameters) throws InvalidDataAccessApiUsageException
      Validate the parameters passed to an execute method based on declared parameters. Subclasses should invoke this method before every executeQuery() or update() method.
      Parameters:
      parameters - the parameters supplied (may be null)
      Throws:
      InvalidDataAccessApiUsageException - if the parameters are invalid

    • validateNamedParameters

      protected void validateNamedParameters(@Nullable Map<String,?> parameters) throws InvalidDataAccessApiUsageException
      Validate the named parameters passed to an execute method based on declared parameters. Subclasses should invoke this method before every executeQuery() or update() method.
      Parameters:
      parameters - parameter Map supplied (may be null)
      Throws:
      InvalidDataAccessApiUsageException - if the parameters are invalid

    • compileInternal

      protected abstract void compileInternal() throws InvalidDataAccessApiUsageException
      Subclasses must implement this template method to perform their own compilation. Invoked after this base class's compilation is complete.

      Subclasses can assume that SQL and a DataSource have been supplied.

      Throws:
      InvalidDataAccessApiUsageException - if the subclass hasn't been properly configured

    • supportsLobParameters

      protected boolean supportsLobParameters()
      Return whether BLOB/CLOB parameters are supported for this kind of operation.

      The default is true.

    • allowsUnusedParameters

      protected boolean allowsUnusedParameters()
      Return whether this operation accepts additional parameters that are given but not actually used. Applies in particular to parameter Maps.

      The default is false.

      See Also: