Package java.sql

Interface CallableStatement

All Superinterfaces:
AutoCloseable, PreparedStatement, Statement, Wrapper
public interface CallableStatement
extends PreparedStatement
An interface used to call Stored Procedures.

The JDBC API provides an SQL escape syntax allowing Stored Procedures to be called in a standard way for all databases. The JDBC escape syntax has two forms. One form includes a result parameter. The second form does not include a result parameter. Where the result parameter is used, it must be declared as an OUT parameter. Other parameters can be declared as IN, OUT, or INOUT. Parameters are referenced either by name or by a numerical index starting at 1.

The correct syntax is:

{ ?= call <procedurename> [( [parameter1,parameter2,...] )] }
{ call <procedurename> [( [parameter1,parameter2,...] )] }
IN parameters are set before calling the procedure, using the setter methods which are inherited from PreparedStatement. For OUT parameters, their type must be registered before executing the stored procedure. The values are retrieved using the getter methods defined in the CallableStatement interface.

CallableStatements can return one or more ResultSets. In the event that multiple ResultSets are returned, they are accessed using the methods inherited from the Statement interface.

  • Method Details

    • getArray

      Array getArray​(int parameterIndex) throws SQLException
      Gets the value of a specified JDBC ARRAY parameter as a java.sql.Array.
      Parameters:
      parameterIndex - the parameter index, where the first parameter has index 1.
      Returns:
      a java.sql.Array containing the parameter value.
      Throws:
      SQLException - if a database error occurs.

    • getArray

      Array getArray​(String parameterName) throws SQLException
      Gets the value of a specified JDBC ARRAY parameter as a java.sql.Array.
      Parameters:
      parameterName - the desired parameter's name.
      Returns:
      a java.sql.Array containing the parameter's value.
      Throws:
      SQLException - if there is a problem accessing the database.

    • getBigDecimal

      BigDecimal getBigDecimal​(int parameterIndex) throws SQLException
      Returns a new BigDecimal representation of the JDBC NUMERIC parameter specified by the input index.
      Parameters:
      parameterIndex - the parameter number index where the first parameter has index 1.
      Returns:
      a java.math.BigDecimal representing the value of the specified parameter. The value null is returned if the parameter in question is an SQL NULL.
      Throws:
      SQLException - if a database error occurs.

    • getBigDecimal

      @Deprecated BigDecimal getBigDecimal​(int parameterIndex, int scale) throws SQLException
      Deprecated.
      Use getBigDecimal(int) or getBigDecimal(String) instead.
      Returns a new BigDecimal representation of the JDBC NUMERIC parameter specified by the input index. The number of digits after the decimal point is specified by scale.
      Parameters:
      parameterIndex - the parameter number index, where the first parameter has index 1.
      scale - the number of digits after the decimal point to get.
      Returns:
      a java.math.BigDecimal representing the value of the specified parameter. The value null is returned if the parameter in question is an SQL NULL.
      Throws:
      SQLException - if a database error occurs.

    • getBigDecimal

      BigDecimal getBigDecimal​(String parameterName) throws SQLException
      Returns a new BigDecimal representation of the JDBC NUMERIC parameter specified by the input name.
      Parameters:
      parameterName - the desired parameter's name.
      Returns:
      a java.math.BigDecimal representing the value of the specified parameter. The value null is returned if the parameter in question is an SQL NULL.
      Throws:
      SQLException - if a database error occurs.

    • getBlob

      Blob getBlob​(int parameterIndex) throws SQLException
      Gets the value of a specified JDBC BLOB parameter as a java.sql.Blob.
      Parameters:
      parameterIndex - the parameter number index, where the first parameter has index 1.
      Returns:
      a java.sql.Blob representing the value of the specified parameter. The value null is returned if the parameter in question is an SQL NULL.
      Throws:
      SQLException - if a database error occurs.

    • getBlob

      Blob getBlob​(String parameterName) throws SQLException
      Gets the value of a specified JDBC BLOB parameter as a java.sql.Blob.
      Parameters:
      parameterName - the desired parameter's name.
      Returns:
      a java.sql.Blob representing the value of the specified parameter. The value null is returned if the parameter in question is an SQL NULL.
      Throws:
      SQLException - if a database error occurs.

    • getBoolean

      boolean getBoolean​(int parameterIndex) throws SQLException
      Gets the value of a specified JDBC BIT parameter as a boolean.
      Parameters:
      parameterIndex - the parameter number index, where the first parameter has index 1.
      Returns:
      a boolean representing the parameter value. false is returned if the value is SQL NULL.
      Throws:
      SQLException - if a database error occurs.

    • getBoolean

      boolean getBoolean​(String parameterName) throws SQLException
      Gets the value of a specified JDBC BIT parameter as a boolean.
      Parameters:
      parameterName - the desired parameter's name.
      Returns:
      a boolean representation of the value of the parameter. false is returned if the SQL value is NULL.
      Throws:
      SQLException - if a database error occurs.

    • getByte

      byte getByte​(int parameterIndex) throws SQLException
      Gets the value of a specified JDBC TINYINT parameter as a byte.
      Parameters:
      parameterIndex - the parameter number index, where the first parameter has index 1.
      Returns:
      a byte representation of the value of the parameter. 0 is returned if the value is SQL NULL.
      Throws:
      SQLException - if a database error occurs.

    • getByte

      byte getByte​(String parameterName) throws SQLException
      Gets the value of a specified JDBC TINYINT parameter as a Java byte.
      Parameters:
      parameterName - the desired parameter's name.
      Returns:
      a byte representation of the value of the parameter. 0 is returned if the SQL value is NULL.
      Throws:
      SQLException - if a database error occurs.

    • getBytes

      byte[] getBytes​(int parameterIndex) throws SQLException
      Returns a byte array representation of the indexed JDBC BINARY or VARBINARY parameter.
      Parameters:
      parameterIndex - the parameter number index, where the first parameter has index 1.
      Returns:
      an array of bytes giving the value of the parameter. null is returned if the value is SQL NULL.
      Throws:
      SQLException - if a database error occurs.

    • getBytes

      byte[] getBytes​(String parameterName) throws SQLException
      Returns a byte array representation of the named JDBC BINARY or VARBINARY parameter.
      Parameters:
      parameterName - the name of the parameter.
      Returns:
      an array of bytes giving the value of the parameter. null is returned if the value is SQL NULL.
      Throws:
      SQLException - if a database error occurs.

    • getClob

      Clob getClob​(int parameterIndex) throws SQLException
      Gets the value of a specified JDBC CLOB parameter as a java.sql.Clob.
      Parameters:
      parameterIndex - the parameter number index, where the first parameter has index 1.
      Returns:
      a java.sql.Clob representing the value of the parameter. null is returned if the value is SQL NULL.
      Throws:
      SQLException - if a database error occurs.
      See Also:
      Clob

    • getClob

      Clob getClob​(String parameterName) throws SQLException
      Gets the value of a specified JDBC CLOB parameter as a java.sql.Clob.
      Parameters:
      parameterName - the name of the parameter.
      Returns:
      a java.sql.Clob with the value of the parameter. null is returned if the value is SQL NULL.
      Throws:
      SQLException - if a database error occurs.
      See Also:
      Clob

    • getDate

      Date getDate​(int parameterIndex) throws SQLException
      Gets the value of the specified JDBC DATE parameter as a java.sql.Date.
      Parameters:
      parameterIndex - the parameter number index, where the first parameter has index 1.
      Returns:
      the java.sql.Date representing the parameter's value. null is returned if the value is SQL NULL.
      Throws:
      SQLException - if a database error occurs.
      See Also:
      Date

    • getDate

      Date getDate​(int parameterIndex, Calendar cal) throws SQLException
      Gets the value of the specified JDBC DATE parameter as a java.sql.Date, using the specified Calendar to construct the date.

      The JDBC driver uses the calendar to create the Date using a particular timezone and locale. The default behavior of the driver is to use the VM defaults. See "Be wary of the default locale".

      Parameters:
      parameterIndex - the parameter number index, where the first parameter has index 1.
      cal - the Calendar to use to construct the date
      Returns:
      the java.sql.Date giving the parameter's value. null is returned if the value is SQL NULL.
      Throws:
      SQLException - if a database error occurs.
      See Also:
      Date

    • getDate

      Date getDate​(String parameterName) throws SQLException
      Gets the value of the specified JDBC DATE parameter as a java.sql.Date.
      Parameters:
      parameterName - the name of the desired parameter.
      Returns:
      the java.sql.Date giving the parameter's value. null is returned if the value is SQL NULL.
      Throws:
      SQLException - if a database error occurs.
      See Also:
      Date

    • getDate

      Date getDate​(String parameterName, Calendar cal) throws SQLException
      Gets the value of the specified JDBC DATE parameter as a java.sql.Date, using the specified Calendar to construct the date.

      The JDBC driver uses the calendar to create the date using a particular timezone and locale. The default behavior of the driver is to use the VM defaults. See "Be wary of the default locale".

      Parameters:
      parameterName - the name of the desired parameter.
      cal - used for creating the returned Date.
      Returns:
      the java.sql.Date giving the parameter's value. null is returned if the value is SQL NULL.
      Throws:
      SQLException - if a database error occurs.
      See Also:
      Date

    • getDouble

      double getDouble​(int parameterIndex) throws SQLException
      Gets the value of the specified JDBC DOUBLE parameter as a double.
      Parameters:
      parameterIndex - the parameter number index, where the first parameter has index 1.
      Returns:
      the parameter's value as a double. 0.0 is returned if the value is SQL NULL.
      Throws:
      SQLException - if a database error occurs.

    • getDouble

      double getDouble​(String parameterName) throws SQLException
      Gets the value of the specified JDBC DOUBLE parameter as a double.
      Parameters:
      parameterName - the name of the desired parameter.
      Returns:
      the parameter's value as a double. 0.0 is returned if the value is SQL NULL.
      Throws:
      SQLException - if there is a problem accessing the database.

    • getFloat

      float getFloat​(int parameterIndex) throws SQLException
      Gets the value of the specified JDBC FLOAT parameter as a float.
      Parameters:
      parameterIndex - the parameter number index, where the first parameter has index 1.
      Returns:
      the parameter's value as a float. 0.0 is returned if the value is SQL NULL.
      Throws:
      SQLException - if a database error occurs.

    • getFloat

      float getFloat​(String parameterName) throws SQLException
      Gets the value of the specified JDBC FLOAT parameter as a Java float.
      Parameters:
      parameterName - the name of the desired parameter.
      Returns:
      the parameter's value as a float. 0.0 is returned if the value is SQL NULL.
      Throws:
      SQLException - if there is a problem accessing the database.

    • getInt

      int getInt​(int parameterIndex) throws SQLException
      Gets the value of the specified JDBC INTEGER parameter as an int.
      Parameters:
      parameterIndex - the parameter number index, where the first parameter has index 1.
      Returns:
      the int giving the parameter's value. 0 is returned if the value is SQL NULL.
      Throws:
      SQLException - if a database error occurs.

    • getInt

      int getInt​(String parameterName) throws SQLException
      Gets the value of the specified JDBC INTEGER parameter as an int.
      Parameters:
      parameterName - the name of the desired parameter.
      Returns:
      the int giving the parameter's value. 0 is returned if the value is SQL NULL.
      Throws:
      SQLException - if a database error occurs.

    • getLong

      long getLong​(int parameterIndex) throws SQLException
      Gets the value of the specified JDBC BIGINT parameter as a long.
      Parameters:
      parameterIndex - the parameter number index, where the first parameter has index 1.
      Returns:
      the long giving the parameter's value. 0 is returned if the value is SQL NULL.
      Throws:
      SQLException - if a database error occurs.

    • getLong

      long getLong​(String parameterName) throws SQLException
      Gets the value of the specified JDBC BIGINT parameter as a long.
      Parameters:
      parameterName - the name of the desired parameter.
      Returns:
      the long giving the parameter's value. 0 is returned if the value is SQL NULL.
      Throws:
      SQLException - if a database error occurs.

    • getObject

      Object getObject​(int parameterIndex) throws SQLException
      Gets the value of the specified parameter as a Java Object.

      The object type returned is the JDBC type registered for the parameter with a registerOutParameter call. If a parameter was registered as a java.sql.Types.OTHER then it may hold abstract types that are particular to the connected database.

      Parameters:
      parameterIndex - the parameter number index, where the first parameter has index 1.
      Returns:
      an Object holding the value of the parameter.
      Throws:
      SQLException - if a database error occurs.

    • getObject

      Object getObject​(int parameterIndex, Map<String,​Class<?>> map) throws SQLException
      Gets the value of the specified parameter as an Object. The Map gives the correspondence between SQL types and Java classes.
      Parameters:
      parameterIndex - the parameter number index, where the first parameter has index 1.
      map - the Map giving the correspondence between SQL types and Java classes.
      Returns:
      an Object holding the value of the parameter.
      Throws:
      SQLException - if a database error occurs.

    • getObject

      Object getObject​(String parameterName) throws SQLException
      Gets the value of the specified parameter as an Object.

      The object type returned is the JDBC type that was registered for the parameter by an earlier call to registerOutParameter(int, int). If a parameter was registered as a java.sql.Types.OTHER then it may hold abstract types that are particular to the connected database.

      Parameters:
      parameterName - the parameter name.
      Returns:
      the Java Object representation of the value of the parameter.
      Throws:
      SQLException - if there is a problem accessing the database.

    • getObject

      Object getObject​(String parameterName, Map<String,​Class<?>> map) throws SQLException
      Gets the value of a specified parameter as an Object. The actual return type is determined by the Map parameter which gives the correspondence between SQL types and Java classes.
      Parameters:
      parameterName - the parameter name.
      map - the Map of SQL types to their Java counterparts
      Returns:
      an Object holding the value of the parameter.
      Throws:
      SQLException - if there is a problem accessing the database.

    • getRef

      Ref getRef​(int parameterIndex) throws SQLException
      Gets the value of a specified SQL REF(<structured type>) parameter as a java.sql.Ref.
      Parameters:
      parameterIndex - the parameter number index, where the first parameter has index 1.
      Returns:
      a java.sql.Ref with the parameter value. null is returned if the value is SQL NULL.
      Throws:
      SQLException - if a database error occurs.

    • getRef

      Ref getRef​(String parameterName) throws SQLException
      Gets the value of a specified SQL REF(<structured type>) parameter as a java.sql.Ref.
      Parameters:
      parameterName - the desired parameter's name.
      Returns:
      the parameter's value in the form of a java.sql.Ref. A null reference is returned if the parameter's value is SQL NULL.
      Throws:
      SQLException - if there is a problem accessing the database.
      See Also:
      Ref

    • getShort

      short getShort​(int parameterIndex) throws SQLException
      Gets the value of a specified JDBC SMALLINT parameter as a short.
      Parameters:
      parameterIndex - the parameter number index, where the first parameter has index 1.
      Returns:
      the parameter's value as a short. 0 is returned if the parameter's value is SQL NULL.
      Throws:
      SQLException - if a database error occurs.

    • getShort

      short getShort​(String parameterName) throws SQLException
      Gets the value of a specified JDBC SMALLINT parameter as a short.
      Parameters:
      parameterName - the desired parameter's name.
      Returns:
      the parameter's value as a short. 0 is returned if the parameter's value is SQL NULL.
      Throws:
      SQLException - if there is a problem accessing the database.

    • getString

      String getString​(int parameterIndex) throws SQLException
      Returns the indexed parameter's value as a String. The parameter value must be one of the JDBC types CHAR, VARCHAR or LONGVARCHAR.

      The String corresponding to a CHAR of fixed length will be of identical length to the value in the database inclusive of padding characters.

      Parameters:
      parameterIndex - the parameter number index, where the first parameter has index 1.
      Returns:
      the parameter's value as a String. null is returned if the value is SQL NULL.
      Throws:
      SQLException - if there is a problem accessing the database.

    • getString

      String getString​(String parameterName) throws SQLException
      Returns the named parameter's value as a string. The parameter value must be one of the JDBC types CHAR, VARCHAR or LONGVARCHAR.

      The string corresponding to a CHAR of fixed length will be of identical length to the value in the database inclusive of padding characters.

      Parameters:
      parameterName - the desired parameter's name.
      Returns:
      the parameter's value as a String. null is returned if the value is SQL NULL.
      Throws:
      SQLException - if there is a problem accessing the database.

    • getTime

      Time getTime​(int parameterIndex) throws SQLException
      Gets the value of a specified JDBC TIME parameter as a java.sql.Time.
      Parameters:
      parameterIndex - the parameter number index, where the first parameter has index 1.
      Returns:
      the parameter's value as a java.sql.Time. null is returned if the value is SQL NULL.
      Throws:
      SQLException - if a database error occurs.
      See Also:
      Time

    • getTime

      Time getTime​(int parameterIndex, Calendar cal) throws SQLException
      Gets the value of a specified JDBC TIME parameter as a java.sql.Time, using the supplied Calendar to construct the time. The JDBC driver uses the calendar to handle specific timezones and locales in order to determine Time.
      Parameters:
      parameterIndex - the parameter number index, where the first parameter has index 1.
      cal - the calendar to use in constructing Time.
      Returns:
      the parameter's value as a java.sql.Time. null is returned if the value is SQL NULL.
      Throws:
      SQLException - if a database error occurs.
      See Also:
      Time, Calendar

    • getTime

      Time getTime​(String parameterName) throws SQLException
      Gets the value of a specified JDBC TIME parameter as a java.sql.Time.
      Parameters:
      parameterName - the name of the desired parameter.
      Returns:
      a new java.sql.Time with the parameter's value. A null reference is returned for an SQL value of NULL.
      Throws:
      SQLException - if a database error occurs.
      See Also:
      Time

    • getTime

      Time getTime​(String parameterName, Calendar cal) throws SQLException
      Gets the value of a specified JDBC TIME parameter as a java.sql.Time, using the supplied Calendar to construct the time. The JDBC driver uses the calendar to handle specific timezones and locales when creating Time.
      Parameters:
      parameterName - the name of the desired parameter.
      cal - used for creating the returned Time
      Returns:
      a new java.sql.Time with the parameter's value. A null reference is returned for an SQL value of NULL.
      Throws:
      SQLException - if a database error occurs.
      See Also:
      Time, Calendar

    • getTimestamp

      Timestamp getTimestamp​(int parameterIndex) throws SQLException
      Returns the indexed parameter's TIMESTAMP value as a java.sql.Timestamp.
      Parameters:
      parameterIndex - the parameter number index, where the first parameter has index 1
      Returns:
      the parameter's value as a java.sql.Timestamp. A null reference is returned for an SQL value of NULL.
      Throws:
      SQLException - if a database error occurs.
      See Also:
      Timestamp

    • getTimestamp

      Timestamp getTimestamp​(int parameterIndex, Calendar cal) throws SQLException
      Returns the indexed parameter's TIMESTAMP value as a java.sql.Timestamp. The JDBC driver uses the supplied Calendar to handle specific timezones and locales when creating the result.
      Parameters:
      parameterIndex - the parameter number index, where the first parameter has index 1
      cal - used for creating the returned Timestamp
      Returns:
      the parameter's value as a java.sql.Timestamp. A null reference is returned for an SQL value of NULL.
      Throws:
      SQLException - if a database error occurs.
      See Also:
      Timestamp

    • getTimestamp

      Timestamp getTimestamp​(String parameterName) throws SQLException
      Returns the named parameter's TIMESTAMP value as a java.sql.Timestamp.
      Parameters:
      parameterName - the name of the desired parameter.
      Returns:
      the parameter's value as a java.sql.Timestamp. A null reference is returned for an SQL value of NULL.
      Throws:
      SQLException - if a database error occurs.
      See Also:
      Timestamp

    • getTimestamp

      Timestamp getTimestamp​(String parameterName, Calendar cal) throws SQLException
      Returns the indexed parameter's TIMESTAMP value as a java.sql.Timestamp. The JDBC driver uses the supplied Calendar to handle specific timezones and locales when creating the result.
      Parameters:
      parameterName - the name of the desired parameter.
      cal - used for creating the returned Timestamp
      Returns:
      the parameter's value as a java.sql.Timestamp. A null reference is returned for an SQL value of NULL.
      Throws:
      SQLException - if a database error occurs.
      See Also:
      Timestamp

    • getURL

      URL getURL​(int parameterIndex) throws SQLException
      Gets the value of a specified JDBC DATALINK parameter as a java.net.URL.
      Parameters:
      parameterIndex - the parameter number index, where the first parameter has index 1.
      Returns:
      a URL giving the parameter's value. null is returned if the value is SQL NULL.
      Throws:
      SQLException - if a database error occurs.
      See Also:
      URL

    • getURL

      URL getURL​(String parameterName) throws SQLException
      Returns the named parameter's JDBC DATALINK value in a new Java java.net.URL.
      Parameters:
      parameterName - the name of the desired parameter.
      Returns:
      a new java.net.URL encapsulating the parameter value. A null reference is returned for an SQL value of NULL.
      Throws:
      SQLException - if a database error occurs.
      See Also:
      URL

    • registerOutParameter

      void registerOutParameter​(int parameterIndex, int sqlType) throws SQLException
      Defines the type of a specified OUT parameter. All OUT parameters must have their type defined before a stored procedure is executed.

      The type supplied in the sqlType parameter fixes the type that will be returned by the getter methods of CallableStatement. If a database specific type is expected for a parameter, the Type java.sql.Types.OTHER should be used. Note that there is another variant of this method for User Defined Types or a REF type.

      Parameters:
      parameterIndex - the parameter number index, where the first parameter has index 1
      sqlType - the JDBC type as defined by java.sql.Types. The JDBC types NUMERIC and DECIMAL should be defined using registerOutParameter(int, int, int).
      Throws:
      SQLException - if a database error occurs.
      See Also:
      Types

    • registerOutParameter

      void registerOutParameter​(int parameterIndex, int sqlType, int scale) throws SQLException
      Defines the Type of a specified OUT parameter. All OUT parameters must have their type defined before a stored procedure is executed. This version of the registerOutParameter method, which has a scale parameter, should be used for the JDBC types NUMERIC and DECIMAL, where there is a need to specify the number of digits expected after the decimal point.

      The type supplied in the sqlType parameter fixes the type that will be returned by the getter methods of CallableStatement.

      Parameters:
      parameterIndex - the parameter number index, where the first parameter has index 1
      sqlType - the JDBC type as defined by java.sql.Types.
      scale - the number of digits after the decimal point. Must be greater than or equal to 0.
      Throws:
      SQLException - if a database error occurs.
      See Also:
      Types

    • registerOutParameter

      void registerOutParameter​(int paramIndex, int sqlType, String typeName) throws SQLException
      Defines the Type of a specified OUT parameter. This variant of the method is designed for use with parameters that are User Defined Types (UDT) or a REF type, although it can be used for any type.
      Parameters:
      paramIndex - the parameter number index, where the first parameter has index 1.
      sqlType - a JDBC type expressed as a constant from Types.
      typeName - an SQL type name. For a REF type, this name should be the fully qualified name of the referenced type.
      Throws:
      SQLException - if a database error occurs.
      See Also:
      Ref

    • registerOutParameter

      void registerOutParameter​(String parameterName, int sqlType) throws SQLException
      Defines the Type of a specified OUT parameter. All OUT parameters must have their Type defined before a stored procedure is executed.

      The type supplied in the sqlType parameter fixes the type that will be returned by the getter methods of CallableStatement. If a database-specific type is expected for a parameter, the Type java.sql.Types.OTHER should be used. Note that there is another variant of this method for User Defined Types or a REF type.

      Parameters:
      parameterName - the parameter name.
      sqlType - a JDBC type expressed as a constant from Types. Types NUMERIC and DECIMAL should be defined using the variant of this method that takes a scale parameter.
      Throws:
      SQLException - if a database error occurs.

    • registerOutParameter

      void registerOutParameter​(String parameterName, int sqlType, int scale) throws SQLException
      Defines the Type of a specified OUT parameter. All OUT parameters must have their Type defined before a stored procedure is executed. This version of the registerOutParameter method, which has a scale parameter, should be used for the JDBC types NUMERIC and DECIMAL, where there is a need to specify the number of digits expected after the decimal point.

      The type supplied in the sqlType parameter fixes the type that will be returned by the getter methods of CallableStatement.

      Parameters:
      parameterName - the parameter name.
      sqlType - a JDBC type expressed as a constant from Types.
      scale - the number of digits after the decimal point. Must be greater than or equal to 0.
      Throws:
      SQLException - if a database error occurs.

    • registerOutParameter

      void registerOutParameter​(String parameterName, int sqlType, String typeName) throws SQLException
      Defines the Type of a specified OUT parameter. This variant of the method is designed for use with parameters that are User Defined Types (UDT) or a REF type, although it can be used for any type.
      Parameters:
      parameterName - the parameter name
      sqlType - a JDBC type expressed as a constant from Types
      typeName - the fully qualified name of an SQL structured type. For a REF type, this name should be the fully qualified name of the referenced type.
      Throws:
      SQLException - if a database error occurs.

    • setAsciiStream

      void setAsciiStream​(String parameterName, InputStream theInputStream, int length) throws SQLException
      Sets the value of a specified parameter to the content of a supplied InputStream, which has a specified number of bytes.

      This is a good method for setting an SQL LONGVARCHAR parameter where the length of the data is large. Data is read from the InputStream until end-of-file is reached or the specified number of bytes is copied.

      Parameters:
      parameterName - the parameter name
      theInputStream - the ASCII input stream carrying the data to update the parameter with.
      length - the number of bytes in the InputStream to copy to the parameter.
      Throws:
      SQLException - if a database error occurs.

    • setBigDecimal

      void setBigDecimal​(String parameterName, BigDecimal theBigDecimal) throws SQLException
      Sets the value of a specified parameter to a supplied java.math.BigDecimal value.
      Parameters:
      parameterName - the name of the parameter.
      theBigDecimal - the java.math.BigInteger value to set.
      Throws:
      SQLException - if a database error occurs.

    • setBinaryStream

      void setBinaryStream​(String parameterName, InputStream theInputStream, int length) throws SQLException
      Sets the value of a specified parameter to the content of a supplied binary InputStream, which has a specified number of bytes.

      Use this method when a large amount of data needs to be set into a LONGVARBINARY parameter.

      Parameters:
      parameterName - the name of the parameter.
      theInputStream - the binary InputStream carrying the data to update the parameter.
      length - the number of bytes in the InputStream to copy to the parameter.
      Throws:
      SQLException - if a database error occurs.

    • setBoolean

      void setBoolean​(String parameterName, boolean theBoolean) throws SQLException
      Sets the value of a specified parameter to a supplied boolean value.
      Parameters:
      parameterName - the parameter name.
      theBoolean - the new value with which to update the parameter.
      Throws:
      SQLException - if a database error occurs.

    • setByte

      void setByte​(String parameterName, byte theByte) throws SQLException
      Sets the value of a specified parameter to a supplied byte value.
      Parameters:
      parameterName - the parameter name.
      theByte - the new value with which to update the parameter.
      Throws:
      SQLException - if a database error occurs.

    • setBytes

      void setBytes​(String parameterName, byte[] theBytes) throws SQLException
      Sets the value of a specified parameter to a supplied array of bytes. The array is mapped to VARBINARY or else LONGVARBINARY in the connected database.
      Parameters:
      parameterName - the parameter name.
      theBytes - the new value with which to update the parameter.
      Throws:
      SQLException - if a database error occurs.

    • setCharacterStream

      void setCharacterStream​(String parameterName, Reader reader, int length) throws SQLException
      Sets the value of a specified parameter to the character content of a Reader object, with the specified length of character data.
      Parameters:
      parameterName - the parameter name.
      reader - the new value with which to update the parameter.
      length - a count of the characters contained in reader.
      Throws:
      SQLException - if a database error occurs.

    • setDate

      void setDate​(String parameterName, Date theDate) throws SQLException
      Sets the value of a specified parameter to a supplied java.sql.Date value.
      Parameters:
      parameterName - the parameter name.
      theDate - the new value with which to update the parameter.
      Throws:
      SQLException - if a database error occurs.

    • setDate

      void setDate​(String parameterName, Date theDate, Calendar cal) throws SQLException
      Sets the value of a specified parameter to a supplied java.sql.Date value, using a supplied calendar to map the date. The calendar allows the application to control the timezone used to compute the SQL DATE in the database. In case that no calendar is supplied, the driver uses the default timezone of the Java virtual machine.
      Parameters:
      parameterName - the parameter name.
      theDate - the new value with which to update the parameter.
      cal - a Calendar to use to construct the SQL DATE value.
      Throws:
      SQLException - if a database error occurs.
      See Also:
      Calendar, Date

    • setDouble

      void setDouble​(String parameterName, double theDouble) throws SQLException
      Sets the value of a specified parameter to a supplied double value.
      Parameters:
      parameterName - the parameter name.
      theDouble - the new value with which to update the parameter.
      Throws:
      SQLException - if a database error occurs.

    • setFloat

      void setFloat​(String parameterName, float theFloat) throws SQLException
      Sets the value of a specified parameter to to a supplied float value.
      Parameters:
      parameterName - the parameter name.
      theFloat - the new value with which to update the parameter.
      Throws:
      SQLException - if a database error occurs.

    • setInt

      void setInt​(String parameterName, int theInt) throws SQLException
      Sets the value of a specified parameter to a supplied int value.
      Parameters:
      parameterName - the parameter name.
      theInt - the new value with which to update the parameter.
      Throws:
      SQLException - if a database error occurs.

    • setLong

      void setLong​(String parameterName, long theLong) throws SQLException
      Sets the value of a specified parameter to a supplied long value.
      Parameters:
      parameterName - the parameter name.
      theLong - the new value with which to update the parameter.
      Throws:
      SQLException - if a database error occurs.

    • setNull

      void setNull​(String parameterName, int sqlType) throws SQLException
      Sets the value of a specified parameter to SQL NULL. Don't use this version of setNull for User Defined Types (UDT) or for REF type parameters.
      Parameters:
      parameterName - the parameter name.
      sqlType - a JDBC type expressed as a constant from Types.
      Throws:
      SQLException - if a database error occurs.

    • setNull

      void setNull​(String parameterName, int sqlType, String typeName) throws SQLException
      Sets the value of a specified parameter to be SQL NULL where the parameter type is either REF or user defined (e.g. STRUCT , JAVA_OBJECT etc).

      For reasons of portability, the caller is expected to supply both the SQL type code and type name (which is just the parameter name if the type is user defined, referred to as a UDT, or the name of the referenced type in case of a REF type).

      Parameters:
      parameterName - the parameter name.
      sqlType - a JDBC type expressed as a constant from Types.
      typeName - if the target parameter is a user defined type then this should contain the full type name. The fully qualified name of a UDT or REF type is ignored if the parameter is not a UDT.
      Throws:
      SQLException - if a database error occurs.
      See Also:
      Types

    • setObject

      void setObject​(String parameterName, Object theObject) throws SQLException
      Sets the value of a specified parameter using a supplied object. Prior to issuing this request to the connected database theObject is transformed to the corresponding SQL type according to the standard Java to SQL mapping rules.

      If the object's class implements the interface SQLData, the JDBC driver calls SQLData.writeSQL to write it to the SQL data stream. If theObject implements any of the following interfaces then the driver is in charge of mapping the value to the appropriate SQL type.

      Parameters:
      parameterName - the parameter name
      theObject - the new value with which to update the parameter
      Throws:
      SQLException - if a database error occurs.
      See Also:
      SQLData

    • setObject

      void setObject​(String parameterName, Object theObject, int targetSqlType) throws SQLException
      Sets the value of a specified parameter using a supplied object.

      The parameter theObject is converted to the given targetSqlType before it is sent to the database. If the object has a custom mapping (its class implements the interface SQLData), the JDBC driver calls the method SQLData.writeSQL to write it to the SQL data stream. If theObject is an instance of one of the following types

      then the driver is in charge of mapping the value to the appropriate SQL type and deliver it to the database.
      Parameters:
      parameterName - the parameter name.
      theObject - the new value with which to update the parameter.
      targetSqlType - a JDBC type expressed as a constant from Types.
      Throws:
      SQLException - if a database error occurs.
      See Also:
      SQLData

    • setObject

      void setObject​(String parameterName, Object theObject, int targetSqlType, int scale) throws SQLException
      Sets the value of a specified parameter using a supplied object.

      The object is converted to the given targetSqlType before it is sent to the database. If the object has a custom mapping (its class implements the interface SQLData), the JDBC driver calls the method SQLData.writeSQL to write it to the SQL data stream. If theObject implements any of the following interfaces

      then the driver is charge of mapping the value to the appropriate SQL type.
      Parameters:
      parameterName - the parameter name.
      theObject - the new value with which to update the parameter.
      targetSqlType - a JDBC type expressed as a constant from Types.
      scale - where applicable, the number of digits after the decimal. point.
      Throws:
      SQLException - if a database error occurs.
      See Also:
      SQLData

    • setShort

      void setShort​(String parameterName, short theShort) throws SQLException
      Sets the value of a specified parameter to a supplied short value.
      Parameters:
      parameterName - the name of the parameter.
      theShort - a short value to update the parameter.
      Throws:
      SQLException - if a database error occurs.

    • setString

      void setString​(String parameterName, String theString) throws SQLException
      Sets the value of a specified parameter to a supplied String.
      Parameters:
      parameterName - the name of the parameter.
      theString - a String value to update the parameter.
      Throws:
      SQLException - if a database error occurs.

    • setTime

      void setTime​(String parameterName, Time theTime) throws SQLException
      Sets the value of the parameter named parameterName to the value of the supplied java.sql.Time.
      Parameters:
      parameterName - the parameter name.
      theTime - the new value with which to update the parameter.
      Throws:
      SQLException - if a database error occurs.
      See Also:
      Time

    • setTime

      void setTime​(String parameterName, Time theTime, Calendar cal) throws SQLException
      Sets the value of the parameter named parameterName to the value of the supplied java.sql.Time using the supplied calendar.

      The driver uses the supplied Calendar to create the SQL TIME value, which allows it to use a custom timezone - otherwise the driver uses the VM defaults. See "Be wary of the default locale".

      Parameters:
      parameterName - the parameter name.
      theTime - the new value with which to update the parameter.
      cal - used for creating the new SQL TIME value.
      Throws:
      SQLException - if a database error occurs.
      See Also:
      Time

    • setTimestamp

      void setTimestamp​(String parameterName, Timestamp theTimestamp) throws SQLException
      Sets the value of a specified parameter to a supplied java.sql.Timestamp value.
      Parameters:
      parameterName - the parameter name.
      theTimestamp - the new value with which to update the parameter.
      Throws:
      SQLException - if a database error occurs.
      See Also:
      Timestamp

    • setTimestamp

      void setTimestamp​(String parameterName, Timestamp theTimestamp, Calendar cal) throws SQLException
      Sets the value of a specified parameter to a supplied java.sql.Timestamp value, using the supplied calendar.

      The driver uses the supplied calendar to create the SQL TIMESTAMP value, which allows it to use a custom timezone - otherwise the driver uses the VM defaults. See "Be wary of the default locale".

      Parameters:
      parameterName - the parameter name.
      theTimestamp - the new value with which to update the parameter.
      cal - used for creating the new SQL TIME value.
      Throws:
      SQLException - if a database error occurs.
      See Also:
      Timestamp, Calendar

    • setURL

      void setURL​(String parameterName, URL theURL) throws SQLException
      Sets the value of a specified parameter to the supplied java.net.URL.
      Parameters:
      parameterName - the parameter name.
      theURL - the new value with which to update the parameter.
      Throws:
      SQLException - if a database error occurs.
      See Also:
      URL

    • wasNull

      boolean wasNull() throws SQLException
      Gets whether the value of the last OUT parameter read was SQL NULL.
      Returns:
      true if the last parameter was SQL NULL, false otherwise.
      Throws:
      SQLException - if a database error occurs.

    • getRowId

      RowId getRowId​(int parameterIndex) throws SQLException
      Gets the value of a specified ROWID parameter as a java.sql.RowId.
      Parameters:
      parameterIndex - the parameter number index, where the first parameter has index 1.
      Throws:
      SQLException - if a database error occurs.

    • getRowId

      RowId getRowId​(String parameterName) throws SQLException
      Returns the value of the specified SQL ROWID parameter as a java.sql.RowId.
      Parameters:
      parameterName - the parameter name
      Throws:
      SQLException - if a database error occurs

    • setRowId

      void setRowId​(String parameterName, RowId rowId) throws SQLException
      Sets the named parameter to the given rowId.
      Throws:
      SQLException - if a database error occurs

    • setNString

      void setNString​(String parameterName, String string) throws SQLException
      Sets the named parameter to the given string.
      Throws:
      SQLException - if a database error occurs

    • setNCharacterStream

      void setNCharacterStream​(String parameterName, Reader reader, long length) throws SQLException
      Sets the named parameter to the characters from the given reader.
      Throws:
      SQLException - if a database error occurs

    • setNClob

      void setNClob​(String parameterName, NClob nclob) throws SQLException
      Sets the named parameter to the given nclob.
      Throws:
      SQLException - if a database error occurs

    • setClob

      void setClob​(String parameterName, Reader reader, long length) throws SQLException
      Sets the named parameter to the next length characters from the given reader.
      Throws:
      SQLException - if a database error occurs

    • setBlob

      void setBlob​(String parameterName, InputStream inputStream, long length) throws SQLException
      Sets the named parameter to the next length bytes from the given inputStream.
      Throws:
      SQLException - if a database error occurs

    • setNClob

      void setNClob​(String parameterName, Reader reader, long length) throws SQLException
      Sets the named parameter to the next length characters from the given reader.
      Throws:
      SQLException - if a database error occurs

    • getNClob

      NClob getNClob​(int parameterIndex) throws SQLException
      Returns the value of the specified SQL NCLOB parameter as a java.sql.NClob.
      Parameters:
      parameterIndex - the parameter number index, where the first parameter has index 1.
      Throws:
      SQLException - if a database error occurs.

    • getNClob

      NClob getNClob​(String parameterName) throws SQLException
      Returns the value of the specified SQL NCLOB parameter as a java.sql.NClob.
      Parameters:
      parameterName - the parameter name
      Throws:
      SQLException - if a database error occurs

    • setSQLXML

      void setSQLXML​(String parameterName, SQLXML sqlXml) throws SQLException
      Sets the named parameter to the given sqlXml.
      Throws:
      SQLException - if a database error occurs

    • getSQLXML

      SQLXML getSQLXML​(int parameterIndex) throws SQLException
      Returns the value of the specified SQL XML parameter as a java.sql.SQLXML.
      Parameters:
      parameterIndex - the parameter number index, where the first parameter has index 1.
      Throws:
      SQLException - if a database error occurs.

    • getSQLXML

      SQLXML getSQLXML​(String parameterName) throws SQLException
      Returns the value of the specified SQL XML parameter as a java.sql.SQLXML.
      Parameters:
      parameterName - the parameter name
      Throws:
      SQLException - if a database error occurs

    • getNString

      String getNString​(int parameterIndex) throws SQLException
      Returns the value of the specified SQL NCHAR, NVARCHAR, or LONGNVARCHAR parameter as a java.lang.String.
      Parameters:
      parameterIndex - the parameter number index, where the first parameter has index 1.
      Throws:
      SQLException - if a database error occurs.

    • getNString

      String getNString​(String parameterName) throws SQLException
      Returns the value of the specified SQL NCHAR, NVARCHAR, or LONGNVARCHAR parameter as a java.lang.String.
      Parameters:
      parameterName - the parameter name
      Throws:
      SQLException - if a database error occurs

    • getNCharacterStream

      Reader getNCharacterStream​(int parameterIndex) throws SQLException
      Returns the value of the specified SQL NCHAR, NVARCHAR, or LONGNVARCHAR parameter as a Reader.
      Parameters:
      parameterIndex - the parameter number index, where the first parameter has index 1.
      Throws:
      SQLException - if a database error occurs.

    • getNCharacterStream

      Reader getNCharacterStream​(String parameterName) throws SQLException
      Returns the value of the specified SQL NCHAR, NVARCHAR, or LONGNVARCHAR parameter as a java.io.Reader.
      Parameters:
      parameterName - the parameter name
      Throws:
      SQLException - if a database error occurs

    • getCharacterStream

      Reader getCharacterStream​(int parameterIndex) throws SQLException
      Returns the value of the specified parameter as a java.io.Reader.
      Parameters:
      parameterIndex - the parameter number index, where the first parameter has index 1.
      Throws:
      SQLException - if a database error occurs.

    • getCharacterStream

      Reader getCharacterStream​(String parameterName) throws SQLException
      Returns the value of the specified parameter as a java.io.Reader.
      Parameters:
      parameterName - the parameter name
      Throws:
      SQLException - if a database error occurs

    • setBlob

      void setBlob​(String parameterName, Blob blob) throws SQLException
      Sets the named parameter to the given blob.
      Throws:
      SQLException - if a database error occurs

    • setClob

      void setClob​(String parameterName, Clob clob) throws SQLException
      Sets the named parameter to the given clob.
      Throws:
      SQLException - if a database error occurs

    • setAsciiStream

      void setAsciiStream​(String parameterName, InputStream x, long length) throws SQLException
      Sets the named parameter to the next length bytes from the given inputStream.
      Throws:
      SQLException - if a database error occurs

    • setAsciiStream

      void setAsciiStream​(String parameterName, InputStream x) throws SQLException
      Sets the named parameter to the bytes from the given reader.
      Throws:
      SQLException - if a database error occurs

    • setBinaryStream

      void setBinaryStream​(String parameterName, InputStream x, long length) throws SQLException
      Sets the named parameter to the next length bytes from the given inputStream.
      Throws:
      SQLException - if a database error occurs

    • setBinaryStream

      void setBinaryStream​(String parameterName, InputStream x) throws SQLException
      Sets the named parameter to the bytes from the given reader.
      Throws:
      SQLException - if a database error occurs

    • setCharacterStream

      void setCharacterStream​(String parameterName, Reader reader, long length) throws SQLException
      Sets the named parameter to the next length characters from the given reader.
      Throws:
      SQLException - if a database error occurs

    • setCharacterStream

      void setCharacterStream​(String parameterName, Reader reader) throws SQLException
      Sets the named parameter to the characters from the given reader.
      Throws:
      SQLException - if a database error occurs

    • setNCharacterStream

      void setNCharacterStream​(String parameterName, Reader value) throws SQLException
      Sets the named parameter to the characters from the given reader.
      Throws:
      SQLException - if a database error occurs

    • setClob

      void setClob​(String parameterName, Reader reader) throws SQLException
      Sets the named parameter to the characters from the given reader.
      Throws:
      SQLException - if a database error occurs

    • setBlob

      void setBlob​(String parameterName, InputStream inputStream) throws SQLException
      Sets the named parameter to the bytes from the given inputStream.
      Throws:
      SQLException - if a database error occurs

    • setNClob

      void setNClob​(String parameterName, Reader reader) throws SQLException
      Sets the named parameter to the characters from the given reader.
      Throws:
      SQLException - if a database error occurs