Package oracle.jdbc

Interface OraclePreparedStatement

  • All Superinterfaces:
    AutoCloseable, OracleStatement, PreparedStatement, Statement, Wrapper
    All Known Subinterfaces:
    OracleCallableStatement
    public interface OraclePreparedStatement
extends PreparedStatement, OracleStatement
    This interface defines the Oracle extensions to the standard JDBC interface java.sql.PreparedStatement. You can use java.sql.PreparedStatement in your application where you do not make use of the Oracle extensions. However, when your application uses the Oracle extensions to java.sql.PreparedStatement you must cast your prepared statement object to the type oracle.jdbc.OraclePreparedStatement. Although the type by which the java compiler will identify the statement object is changed, the object itself is unchanged.

    Extended functionality consists of setXXX() methods for binding oracle.sql. types and objects into prepared statements, and methods to support Oracle performance extensions on a statement-by-statements basis.

    About prepared statements : To write changes to the database, such as for INSERT or UPDATE operations, you will typically create a PreparedStatement object. This allows you to execute a statement with varying sets of input parameters. The prepareStatement() method of your JDBC Connection object allows you to define a statement that takes variable bind parameters, and returns a JDBC PreparedStatement object with your statement definition.

    Bind your data : Use setXXX() methods on the PreparedStatement object to bind data into the prepared statement to be sent to the database. Again, some of these methods are Oracle specific and require that you cast your PreparedStatement object to the OraclePreparedStatement type.

    For example, if you have a Connection object named conn and a RAW named my_raw, then write the RAW to the database as follows:

      PreparedStatement ps = conn.prepareStatement
  ("INSERT INTO raw_table VALUES(?)");
  ((OraclePreparedStatement)ps).setRAW(1, my_raw);
  ps.execute();
    Since:
    8.1.7
    See Also:
    Connection.prepareStatement

    • Field Detail

      • FORM_NCHAR

        static final short FORM_NCHAR
        Specifies the "form of use" for SQL NCHAR datatypes (NCHAR, NVARCHAR2 and NCLOB). It is used only in the argument to setFormOfUse().
        See Also:
        Constant Field Values

      • FORM_CHAR

        static final short FORM_CHAR
        Specifies the "form of use" for SQL CHAR datatypes (CHAR, VARCHAR2 and CLOB). It is used only in the argument to setFormOfUse().
        See Also:
        Constant Field Values

    • Method Detail

      • defineParameterTypeBytes

        void defineParameterTypeBytes​(int param_index,
                              int type,
                              int max_size)
                       throws SQLException
        Define the type under which you will bind the parameter and the maximum size (in bytes) of data you will bind in binds.

        Similarly to defineColumnType(). Before executing a Query you may choose to inform JDBC of the type and maximum length of the bind parameter. If not, based on the setXXX call, the maximum length of the type is taken, i.e., for a setString a 4k buffer is allocated. This API does not reduce the network round trip. It is purely a memory optimization API.

        Note: You should use OracleTypes.CHAR as the type value if you are going bind later as setCHAR and use OracleTypes.VARCHAR if you are going to bind as setString for effective results.

        Parameters:
        param_index - Index of bind parameter (should be >=0)
        type - Type to be assigned to bind parameter. This type could be different from the native type of the column. Appropriate conversions will be done.
        max_size - Maximum length of bind data in bytes (should be >=0)
        Throws:
        SQLException - if the type you specify is not available

      • defineParameterTypeChars

        void defineParameterTypeChars​(int param_index,
                              int type,
                              int max_size)
                       throws SQLException
        Define the type under which you will bind the parameter and the maximum size (in characters) of data you will bind in binds.

        Similarly to defineColumnType(). Before executing a Query you may choose to inform JDBC of the type and maximum length of the bind parameter. If not, based on the setXXX call, the maximum length of the type is taken, i.e., for a setString a 4k buffer is allocated. This API does not reduce the network round trip. It is purely a memory optimization API.

        Note: You should use OracleTypes.CHAR as the type value if you are going bind later as setCHAR and use OracleTypes.VARCHAR if you are going to bind as setString for effective results.

        Parameters:
        param_index - Index of bind parameter (should be >=0)
        type - Type to be assigned to bind parameter. This type could be different from the native type of the column. Appropriate conversions will be done.
        max_size - Maximum length of bind data in bytes (should be >=0)
        Throws:
        SQLException - if the type you specify is not available

      • defineParameterType

        void defineParameterType​(int param_index,
                         int type,
                         int max_size)
                  throws SQLException
        Define the type under which you will bind the parameter and the maximum size (in characters) of data you will bind in binds. Depending on the value of the dataSizeUnits connection property, max_size will be measured in bytes or characters.
        Parameters:
        param_index -
        type -
        max_size -
        Throws:
        SQLException

      • getExecuteBatch

        int getExecuteBatch()
        Deprecated.
        As of 12.1 all APIs related to oracle-style statement batching are deprecated in favor of standard JDBC batching. We recommend using the standard model going forward as it is spec compliant and provides more information and control to the application.
        Executions are not batched but sent immediately. Oracle style of batching has been deprecated in 12.1 and made a no-op in 12.2. We recommend using the standard model of batching.
        Returns:
        the batch value (always 1).
        See Also:
        OracleConnection.setDefaultExecuteBatch, setExecuteBatch

      • sendBatch

        int sendBatch()
       throws SQLException
        Deprecated.
        As of 12.1 all APIs related to oracle-style statement batching are deprecated in favor of standard JDBC batching. We recommend using the standard model going forward as it is spec compliant and provides more information and control to the application.
        Executions are not batched but sent immediately. Oracle style of batching has been deprecated in 12.1 and made a no-op in 12.2. We recommend using the standard model of batching.
        Returns:
        the update count (always 0).
        Throws:
        SQLException - never thrown.

      • setARRAY

        void setARRAY​(int parameterIndex,
              ARRAY arr)
       throws SQLException
        Binds the designated parameter to a oracle.sql.ARRAY.
        Parameters:
        parameterIndex - the first parameter is 1, the second is 2, ...
        arr - the parameter value
        Throws:
        SQLException - if a database access error occurs

      • setBfile

        void setBfile​(int parameterIndex,
              BFILE file)
       throws SQLException
        Binds the designated parameter to a oracle.sql.BFILE value.

        Note: This is the same as setBFILE.

        Parameters:
        parameterIndex - the first parameter is 1, the second is 2, ...
        file - the parameter value
        Throws:
        SQLException - if a database access error occurs
        See Also:
        setBFILE

      • setBFILE

        void setBFILE​(int parameterIndex,
              BFILE file)
       throws SQLException
        Binds the designated parameter to a oracle.sql.BFILE value.

        Note: An instance of the oracle.sql.BFILE class contains only the locator of the BFILE, not the data. Thus, this method binds the designated parameter to a BFILE locator not to the data.

        For example, assume you want to insert a BFILE locator into a table, and you have an OraclePreparedStatement object ops to insert data into a table. The first column is a string (to designate a row number), the second column is a BFILE, and you have a valid oracle.sql.BFILE object (bfile). Write the BFILE to the database as follows:

            OraclePreparedStatement ops = (OraclePreparedStatement)conn.prepareStatement
    ("INSERT INTO my_bfile_table VALUES(?,?)");
    ops.setString(1, "one");
    ops.setBFILE(2, bfile);
    ops.execute();

        This stores only the locator of the BFILE in the my_bfile_table. See the BFILE class to get more details about how to deal with the data.

        Parameters:
        parameterIndex - the first parameter is 1, the second is 2, ...
        file - the parameter value
        Throws:
        SQLException - if a database access error occurs

      • setBLOB

        void setBLOB​(int parameterIndex,
             BLOB lob)
      throws SQLException
        Binds the designated parameter to a oracle.sql.BLOB value.

        Note: An instance of the oracle.sql.BLOB class contains only the locator of the BLOB, not the data. Thus, this method binds the designated parameter to a BLOB locator not to the data.

        For example, if you have an OraclePreparedStatement object ops and a BLOB named my_blob, then write the BLOB to the database as follows:

            OraclePreparedStatement ops = (OraclePreparedStatement)conn.prepareStatement
    ("INSERT INTO blob_table VALUES(?)");
    ops.setBLOB(1, my_blob);
    ops.execute();

        This stores only the locator of the BLOB in the clob_table. Use the method BLOB.getBinaryOutputStream to write data to a BLOB.

        Parameters:
        parameterIndex - the first parameter is 1, the second is 2, ...
        lob - the parameter value
        Throws:
        SQLException - if a database access error occurs

      • setCHAR

        void setCHAR​(int parameterIndex,
             CHAR ch)
      throws SQLException
        Binds the designated parameter to a oracle.sql.CHAR value.

        setCHAR checks the character set of the argument. If it is not the same as the network character set, then the bytes of the argument are converted to the network character set and those bytes are sent to the database. The conversion between the argument character set and the network character set is via the Universal Character Set (UCS2). That is, the argument is converted to UCS2, then the UCS2 bytes are converted to the network character set.

        Note: If an input character does not have a representation in UCS2, or if the UCS2 does not have a representation of the network character set, setCHAR will throw an exception.

        Parameters:
        parameterIndex - the first parameter is 1, the second is 2, ...
        ch - the parameter value
        Throws:
        SQLException - if a database access error occurs
        See Also:
        setFixedChar

      • setCLOB

        void setCLOB​(int parameterIndex,
             CLOB lob)
      throws SQLException
        Binds the designated parameter to a oracle.sql.CLOB value.

        Note: An instance of the oracle.sql.CLOB class contains only the locator of the CLOB, not the data. Thus, this method binds the designated parameter to a CLOB locator not to the data.

        For example, if you have an OraclePreparedStatement object ops and a CLOB named my_clob, then write the CLOB to the database as follows:

            OraclePreparedStatement ops = (OraclePreparedStatement)conn.prepareStatement
    ("INSERT INTO clob_table VALUES(?)");
    ops.setCLOB(1, my_clob);
    ops.execute();

        This stores only the locator of the CLOB in the clob_table. Use the methods CLOB.getCharacterOutputStream or CLOB.getAsciiOutputStream to write data to a CLOB.

        Parameters:
        parameterIndex - the first parameter is 1, the second is 2, ...
        lob - the parameter value
        Throws:
        SQLException - if a database access error occurs

      • setCursor

        void setCursor​(int parameterIndex,
               ResultSet rs)
        throws SQLException
        Deprecated.
        Binds the designated parameter to a java.sql.ResultSet. This is used for RefCursor parameter only.

        NOTE: The method is a misnomer. You should use CURSOR only in callable statements.

        Parameters:
        parameterIndex - the first parameter is 1, the second is 2, ...
        rs - the parameter value
        Throws:
        SQLException - if a database access error occurs
        See Also:
        OracleCallableStatement.getCursor

      • setCustomDatum

        void setCustomDatum​(int parameterIndex,
                    CustomDatum x)
             throws SQLException
        Deprecated.
        Binds the designated parameter to a oracle.sql.CustomDatum value.

        In the 9i release the oracle.sql.CustomDatum has been deprecated and replaced by the oracle.sql.ORAData interface. For this reason, this method is also deprecated. It is recommended to use setORAData() instead.

        Parameters:
        parameterIndex - the first parameter is 1, the second is 2, ...
        x - the parameter value, should not be null.
        Throws:
        SQLException - if a database access error occurs, or if null value is passed as x.

      • setORAData

        void setORAData​(int parameterIndex,
                ORAData x)
         throws SQLException
        Binds the designated parameter to a oracle.sql.ORAData value.
        Parameters:
        parameterIndex - the first parameter is 1, the second is 2, ...
        x - the parameter value, should not be null.
        Throws:
        SQLException - if a database access error occurs, or if null value is passed as x.

      • setDATE

        void setDATE​(int parameterIndex,
             DATE date)
      throws SQLException
        Binds the designated parameter to a oracle.sql.DATE value.
        Parameters:
        parameterIndex - the first parameter is 1, the second is 2, ...
        date - the parameter value
        Throws:
        SQLException - if a database access error occurs

      • setExecuteBatch

        void setExecuteBatch​(int batchValue)
              throws SQLException
        Deprecated.
        As of 12.1 all APIs related to oracle-style statement batching are deprecated in favor of standard JDBC batching. We recommend using the standard model going forward as it is spec compliant and provides more information and control to the application.
        Executions are not batched but sent immediately. Oracle style of batching has been deprecated in 12.1 and made a no-op in 12.2. We recommend using the standard model of batching.
        Parameters:
        batchValue - batch value to be set, this is discarded.
        Throws:
        SQLException - if batchValue is less than 1 (never thrown).
        See Also:
        getExecuteBatch, OracleConnection.setDefaultExecuteBatch

      • setFixedCHAR

        void setFixedCHAR​(int parameterIndex,
                  String x)
           throws SQLException
        Sets the disignated parameter to a String and executes a non-padded comparison with a SQL CHAR.

        CHAR data in the database is padded to the column width. This leads to a limitation in using the setCHAR() method to bind character data into the WHERE clause of a SELECT statement--the character data in the WHERE clause must also be padded to the column width to produce a match in the SELECT statement. This is especially troublesome if you do not know the column width.

        setFixedCHAR() remedies this. This method executes a non-padded comparison.

        Notes:

        • Remember to cast your prepared statement object to OraclePreparedStatement to use the setFixedCHAR() method.
        • There is no need to use setFixedCHAR() for an INSERT statement. The database always automatically pads the data to the column width as it inserts it.

        The following example demonstrates the difference between the setString(), setCHAR() and setFixedCHAR() methods.

            // Schema is : create table my_table (col1 char(10));
    //             insert into my_table values ('JDBC');
    PreparedStatement pstmt = conn.prepareStatement
    ("select count() from my_table where col1 = ?");
    ResultSet rs;
    
    pstmt.setString (1, "JDBC");  // Set the Bind Value
    rs = pstmt.executeQuery();    // This does not match any row
    // ... do something with rs
    CHAR ch = new CHAR("JDBC      ", null);
    ((OraclePreparedStatement)pstmt).setCHAR(1, ch); // Pad it to 10 bytes
    rs = pstmt.executeQuery();     // This matches one row
    // ... do something with rs
    ((OraclePreparedStatement)pstmt).setFixedCHAR(1, "JDBC");
    rs = pstmt.executeQuery();     // This matches one row
    // ... do something with rs
        Parameters:
        parameterIndex - index of the bind variable (first is 1)
        x - the literal/variable to be bound.
        Throws:
        SQLException - if an error occurs while binding
        See Also:
        setCHAR

      • setNUMBER

        void setNUMBER​(int parameterIndex,
               NUMBER num)
        throws SQLException
        Binds the designated parameter to a oracle.sql.NUMBER value.
        Parameters:
        parameterIndex - the first parameter is 1, the second is 2, ...
        num - the parameter value
        Throws:
        SQLException - if a database access error occurs

      • setBinaryFloat

        void setBinaryFloat​(int parameterIndex,
                    float value)
             throws SQLException
        Sets the designated parameter to a Java float value. The float data is converted to the server internal BINARY_FLOAT format before being sent to the server.

        Note that with the JDBC standard setFloat API the float data is converted to server internal NUMBER format before being sent to the server. In Oracle the SQL REAL, FLOAT, and DOUBLE PRECISION datatypes are NUMBER types.

        The connection property SetFloatAndDoubleUseBinary causes the setFloat API to use binary conversion.

        Binary conversion sent to a BINARY_FLOAT parameter is fast and bit exact. Binary conversion sent to a NUMBER parameter moves CPU load to the server but the data will be the same as NUMBER conversion on the client.

        NUMBER conversion sent to a NUMBER parameter is correct and keeps the CPU load on the client. NUMBER conversion sent to a BINARY_FLOAT parameter is not bit exact and has extra CPU load on both client and server

        Parameters:
        parameterIndex - the first parameter is 1, the second is 2, ...
        value - the parameter value
        Throws:
        SQLException - if a database access error occurs
        Since:
        10gR1

      • setBinaryFloat

        void setBinaryFloat​(int parameterIndex,
                    BINARY_FLOAT value)
             throws SQLException
        Sets the designated parameter to an oracle.sql.BINARY_FLOAT value. See setBinaryFloat for additional information.
        Parameters:
        parameterIndex - the first parameter is 1, the second is 2, ...
        value - the parameter value
        Throws:
        SQLException - if a database access error occurs

      • setBinaryDouble

        void setBinaryDouble​(int parameterIndex,
                     double value)
              throws SQLException
        Sets the designated parameter to a Java double value. The double data is converted to the server internal BINARY_DOUBLE format before being sent to the server.

        Note that with the JDBC standard setDouble API the float data is converted to server internal NUMBER format before being sent to the server. In Oracle the SQL REAL, FLOAT, and DOUBLE PRECISION datatypes are NUMBER types.

        The connection property SetFloatAndDoubleUseBinary causes the setDouble API to use binary conversion.

        Binary conversion sent to a BINARY_DOUBLE parameter is fast and bit exact. Binary conversion sent to a NUMBER parameter moves CPU load to the server but the data will be the same as NUMBER conversion on the client.

        NUMBER conversion sent to a NUMBER parameter is correct and keeps the CPU load on the client. NUMBER conversion sent to a BINARY_DOUBLE parameter is not bit exact and has extra CPU load on both client and server

        Parameters:
        parameterIndex - the first parameter is 1, the second is 2, ...
        value - the parameter value
        Throws:
        SQLException - if a database access error occurs

      • setBinaryDouble

        void setBinaryDouble​(int parameterIndex,
                     BINARY_DOUBLE value)
              throws SQLException
        Sets the designated parameter to an oracle.sql.BINARY_DOUBLE value. See setBinaryDouble for additional information.
        Parameters:
        parameterIndex - the first parameter is 1, the second is 2, ...
        value - the parameter value
        Throws:
        SQLException - if a database access error occurs

      • setOPAQUE

        void setOPAQUE​(int parameterIndex,
               OPAQUE val)
        throws SQLException
        Binds the designated parameter to a oracle.sql.OPAQUE value.
        Parameters:
        parameterIndex - the first parameter is 1, the second is 2, ...
        val - the parameter value
        Throws:
        SQLException - if a database access error occurs

      • setOracleObject

        void setOracleObject​(int parameterIndex,
                     Datum x)
              throws SQLException
        Binds the designated parameter to a oracle.sql.Datum value.

        This is a generic setXXX() method for binding oracle.sql. data into a prepared statement as an oracle.sql.Datum object.

        Parameters:
        parameterIndex - the first parameter is 1, the second is 2, ...
        x - the parameter value
        Throws:
        SQLException - if a database access error occurs

      • setStructDescriptor

        void setStructDescriptor​(int parameterIndex,
                         StructDescriptor desc)
                  throws SQLException
        Binds the bind type of designated parameter from an oracle.sql.StructDescriptor.
        Parameters:
        parameterIndex - the first parameter is 1, the second is 2, ...
        desc - the StructDescriptor to bind
        Throws:
        SQLException - if a database access error occurs

      • setRAW

        void setRAW​(int parameterIndex,
            RAW raw)
     throws SQLException
        Binds the designated parameter to a oracle.sql.RAW value.
        Parameters:
        parameterIndex - the first parameter is 1, the second is 2, ...
        raw - the parameter value
        Throws:
        SQLException - if a database access error occurs

      • setREF

        void setREF​(int parameterIndex,
            REF ref)
     throws SQLException
        Binds the designated parameter to a oracle.sql.REF value.
        Parameters:
        parameterIndex - the first parameter is 1, the second is 2, ...
        ref - the parameter value
        Throws:
        SQLException - if a database access error occurs

      • setRefType

        void setRefType​(int parameterIndex,
                REF ref)
         throws SQLException
        Binds the designated parameter to a oracle.sql.REF value.

        Note: This is the same as setREF.

        Parameters:
        parameterIndex - the first parameter is 1, the second is 2, ...
        ref - the parameter value
        Throws:
        SQLException - if a database access error occurs
        See Also:
        setREF

      • setROWID

        void setROWID​(int parameterIndex,
              ROWID rowid)
       throws SQLException
        Binds the designated parameter to a oracle.sql.ROWID value.
        Parameters:
        parameterIndex - the first parameter is 1, the second is 2, ...
        rowid - the parameter value
        Throws:
        SQLException - if a database access error occurs

      • setSTRUCT

        void setSTRUCT​(int parameterIndex,
               STRUCT struct)
        throws SQLException
        Binds the designated parameter to a oracle.sql.STRUCT value.
        Parameters:
        parameterIndex - the first parameter is 1, the second is 2, ...
        struct - the parameter value
        Throws:
        SQLException - if a database access error occurs

      • setTIMESTAMP

        void setTIMESTAMP​(int parameterIndex,
                  TIMESTAMP x)
           throws SQLException
        Binds the designated parameter to an oracle.sql.TIMESTAMP value.
        Parameters:
        parameterIndex - specifies the parameter index. Index starts from 1.
        x - specifies the parameter value.
        Throws:
        SQLException - if an error occurs
        Since:
        9i

      • setTIMESTAMPTZ

        void setTIMESTAMPTZ​(int parameterIndex,
                    TIMESTAMPTZ x)
             throws SQLException
        Binds the designated parameter to an oracle.sql.TIMESTAMPTZ value.
        Parameters:
        parameterIndex - specifies the parameter index. Index starts from 1.
        x - specifies the parameter value.
        Throws:
        SQLException - if an error occurs
        Since:
        9i

      • setTIMESTAMPLTZ

        void setTIMESTAMPLTZ​(int parameterIndex,
                     TIMESTAMPLTZ x)
              throws SQLException
        Binds the designated parameter to an oracle.sql.TIMESTAMPLTZ value.

        In order to use this method, the calling program must first set the session time zone of the corresponding connection by using OracleConnection.setSessionTimeZone().

        Parameters:
        parameterIndex - specifies the parameter index. Index starts from 1.
        x - specifies the parameter value.
        Throws:
        SQLException - if an error occurs
        Since:
        9i

      • setINTERVALYM

        void setINTERVALYM​(int parameterIndex,
                   INTERVALYM x)
            throws SQLException
        Binds the designated parameter to an oracle.sql.INTERVALYM value.
        Parameters:
        parameterIndex - specifies the parameter index. Index starts from 1.
        x - specifies the parameter value.
        Throws:
        SQLException - if an error occurs
        Since:
        9i

      • setINTERVALDS

        void setINTERVALDS​(int parameterIndex,
                   INTERVALDS x)
            throws SQLException
        Binds the designated parameter to an oracle.sql.INTERVALDS value.
        Parameters:
        parameterIndex - specifies the parameter index. Index starts from 1.
        x - specifies the parameter value.
        Throws:
        SQLException - if an error occurs
        Since:
        10i

      • setNullAtName

        void setNullAtName​(String parameterName,
                   int sqlType,
                   String sqlName)
            throws SQLException
        Sets the designated parameter to a SQL NULL value.
        Parameters:
        parameterName -
        sqlType -
        sqlName - the name of the SQL type
        Throws:
        SQLException - if a database access error occurs

      • setNullAtName

        void setNullAtName​(String parameterName,
                   int sqlType)
            throws SQLException
        Sets the designated parameter to a SQL NULL value.
        Parameters:
        parameterName -
        sqlType -
        Throws:
        SQLException - if a database access error occurs

      • setBooleanAtName

        void setBooleanAtName​(String parameterName,
                      boolean value)
               throws SQLException
        Sets the designated parameter to a Java Boolean value.
        Parameters:
        parameterName -
        value - the parameter value
        Throws:
        SQLException - if a database access error occurs

      • setByteAtName

        void setByteAtName​(String parameterName,
                   byte value)
            throws SQLException
        Sets the designated parameter to a Java Byte value.
        Parameters:
        parameterName -
        value - the parameter value
        Throws:
        SQLException - if a database access error occurs

      • setShortAtName

        void setShortAtName​(String parameterName,
                    short value)
             throws SQLException
        Sets the designated parameter to a Java Short value.
        Parameters:
        parameterName -
        value - the parameter value
        Throws:
        SQLException - if a database access error occurs

      • setIntAtName

        void setIntAtName​(String parameterName,
                  int value)
           throws SQLException
        Sets the designated parameter to a Java Int value.
        Parameters:
        parameterName -
        value - the parameter value
        Throws:
        SQLException - if a database access error occurs

      • setLongAtName

        void setLongAtName​(String parameterName,
                   long value)
            throws SQLException
        Sets the designated parameter to a Java Long value.
        Parameters:
        parameterName -
        value - the parameter value
        Throws:
        SQLException - if a database access error occurs

      • setFloatAtName

        void setFloatAtName​(String parameterName,
                    float value)
             throws SQLException
        Sets the designated parameter to a Java Float value.
        Parameters:
        parameterName -
        value - the parameter value
        Throws:
        SQLException - if a database access error occurs

      • setDoubleAtName

        void setDoubleAtName​(String parameterName,
                     double value)
              throws SQLException
        Sets the designated parameter to a Java Double value.
        Parameters:
        parameterName -
        value - the parameter value
        Throws:
        SQLException - if a database access error occurs

      • setBinaryFloatAtName

        void setBinaryFloatAtName​(String parameterName,
                          float value)
                   throws SQLException
        Sets the designated parameter to a Java Float value. See setBinaryFloat for additional information.
        Parameters:
        parameterName -
        value - the parameter value
        Throws:
        SQLException - if a database access error occurs

      • setBinaryFloatAtName

        void setBinaryFloatAtName​(String parameterName,
                          BINARY_FLOAT value)
                   throws SQLException
        Sets the designated parameter to an oracle.sql.BINARY_FLOAT value. See setBinaryFloat for additional information.
        Parameters:
        parameterName -
        value - the parameter value
        Throws:
        SQLException - if a database access error occurs

      • setBinaryDoubleAtName

        void setBinaryDoubleAtName​(String parameterName,
                           double value)
                    throws SQLException
        Sets the designated parameter to a Java Double value. See setBinaryDouble for additional information.
        Parameters:
        parameterName -
        value - the parameter value
        Throws:
        SQLException - if a database access error occurs

      • setBinaryDoubleAtName

        void setBinaryDoubleAtName​(String parameterName,
                           BINARY_DOUBLE value)
                    throws SQLException
        Sets the designated parameter to an oracle.sql.BINARY_DOUBLE value. See setBinaryDouble for additional information.
        Parameters:
        parameterName -
        value - the parameter value
        Throws:
        SQLException - if a database access error occurs

      • setBigDecimalAtName

        void setBigDecimalAtName​(String parameterName,
                         BigDecimal value)
                  throws SQLException
        Sets the designated parameter to a Java BigDecimal value.
        Parameters:
        parameterName -
        value - the parameter value
        Throws:
        SQLException - if a database access error occurs

      • setStringAtName

        void setStringAtName​(String parameterName,
                     String value)
              throws SQLException
        Sets the designated parameter to a Java String value.
        Parameters:
        parameterName -
        value - the parameter value
        Throws:
        SQLException - if a database access error occurs

      • setStringForClob

        void setStringForClob​(int parameterIndex,
                      String value)
               throws SQLException
        Sets the designated parameter to a Java String value. For large strings this will only work correctly with a CLOB column.
        Parameters:
        parameterIndex -
        value - the parameter value
        Throws:
        SQLException - if a database access error occurs

      • setStringForClobAtName

        void setStringForClobAtName​(String parameterName,
                            String value)
                     throws SQLException
        Sets the designated parameter to a Java String value. For large strings this will only work correctly with a CLOB column.
        Parameters:
        parameterName -
        value - the parameter value
        Throws:
        SQLException - if a database access error occurs

      • setFixedCHARAtName

        void setFixedCHARAtName​(String parameterName,
                        String value)
                 throws SQLException
        Sets the designated parameter to a Java FixedCHAR value.
        Parameters:
        parameterName -
        value - the parameter value
        Throws:
        SQLException - if a database access error occurs

      • setCursorAtName

        void setCursorAtName​(String parameterName,
                     ResultSet value)
              throws SQLException
        Sets the designated parameter to a Java Cursor value.
        Parameters:
        parameterName -
        value - the parameter value
        Throws:
        SQLException - if a database access error occurs

      • setROWIDAtName

        void setROWIDAtName​(String parameterName,
                    ROWID value)
             throws SQLException
        Sets the designated parameter to an oracle.sql.ROWIDvalue.
        Parameters:
        parameterName -
        value - the parameter value
        Throws:
        SQLException - if a database access error occurs

      • setArrayAtName

        void setArrayAtName​(String parameterName,
                    Array value)
             throws SQLException
        Sets the designated parameter to a Java Array value.
        Parameters:
        parameterName -
        value - the parameter value
        Throws:
        SQLException - if a database access error occurs

      • setARRAYAtName

        void setARRAYAtName​(String parameterName,
                    ARRAY value)
             throws SQLException
        Sets the designated parameter to a oracle.sql.ARRAY value.
        Parameters:
        parameterName -
        value - the parameter value
        Throws:
        SQLException - if a database access error occurs

      • setOPAQUEAtName

        void setOPAQUEAtName​(String parameterName,
                     OPAQUE value)
              throws SQLException
        Sets the designated parameter to an oracle.sql.OPAQUEvalue.
        Parameters:
        parameterName -
        value - the parameter value
        Throws:
        SQLException - if a database access error occurs

      • setStructDescriptorAtName

        void setStructDescriptorAtName​(String parameterName,
                               StructDescriptor desc)
                        throws SQLException
        Sets the designated parameter to an oracle.sql.StructDescriptor value.
        Parameters:
        parameterName -
        desc - the StructDescriptor to bind
        Throws:
        SQLException - if a database access error occurs

      • setSTRUCTAtName

        void setSTRUCTAtName​(String parameterName,
                     STRUCT value)
              throws SQLException
        Sets the designated parameter to an oracle.sql.STRUCTvalue.
        Parameters:
        parameterName -
        value - the parameter value
        Throws:
        SQLException - if a database access error occurs

      • setRAWAtName

        void setRAWAtName​(String parameterName,
                  RAW value)
           throws SQLException
        Sets the designated parameter to an oracle.sql.RAWvalue.
        Parameters:
        parameterName -
        value - the parameter value
        Throws:
        SQLException - if a database access error occurs

      • setCHARAtName

        void setCHARAtName​(String parameterName,
                   CHAR value)
            throws SQLException
        Sets the designated parameter to an oracle.sql.CHAR value.
        Parameters:
        parameterName -
        value - the parameter value
        Throws:
        SQLException - if a database access error occurs

      • setDATEAtName

        void setDATEAtName​(String parameterName,
                   DATE value)
            throws SQLException
        Sets the designated parameter to an oracle.sql.DATE value.
        Parameters:
        parameterName -
        value - the parameter value
        Throws:
        SQLException - if a database access error occurs

      • setNUMBERAtName

        void setNUMBERAtName​(String parameterName,
                     NUMBER value)
              throws SQLException
        Sets the designated parameter to an oracle.sql.NUMBER value.
        Parameters:
        parameterName -
        value - the parameter value
        Throws:
        SQLException - if a database access error occurs

      • setBLOBAtName

        void setBLOBAtName​(String parameterName,
                   BLOB value)
            throws SQLException
        Sets the designated parameter to an oracle.sql.BLOB value.
        Parameters:
        parameterName -
        value - the parameter value
        Throws:
        SQLException - if a database access error occurs

      • setBlobAtName

        void setBlobAtName​(String parameterName,
                   Blob value)
            throws SQLException
        Sets the designated parameter to a Java Blob value.
        Parameters:
        parameterName -
        value - the parameter value
        Throws:
        SQLException - if a database access error occurs

      • setBlobAtName

        void setBlobAtName​(String parameterName,
                   InputStream stream,
                   long length)
            throws SQLException
        Sets the designated parameter to a stream value.
        Parameters:
        parameterName -
        stream - the stream from which to read the value
        length - the number of bytes to read
        Throws:
        SQLException - if a database access error occurs

      • setBlobAtName

        void setBlobAtName​(String parameterName,
                   InputStream stream)
            throws SQLException
        Sets the designated parameter to a stream value.
        Parameters:
        parameterName -
        stream - the stream from which to read the value
        Throws:
        SQLException - if a database access error occurs

      • setCLOBAtName

        void setCLOBAtName​(String parameterName,
                   CLOB value)
            throws SQLException
        Sets the designated parameter to an oracle.sql.CLOB value.
        Parameters:
        parameterName -
        value - the parameter value
        Throws:
        SQLException - if a database access error occurs

      • setClobAtName

        void setClobAtName​(String parameterName,
                   Clob value)
            throws SQLException
        Sets the designated parameter to a Java Clob value.
        Parameters:
        parameterName -
        value - the parameter value
        Throws:
        SQLException - if a database access error occurs

      • setClobAtName

        void setClobAtName​(String parameterName,
                   Reader reader,
                   long length)
            throws SQLException
        Sets the designated parameter to a stream value.
        Parameters:
        parameterName -
        reader - the Reader from which to get the value
        length - the number of bytes to read
        Throws:
        SQLException - if a database access error occurs

      • setClobAtName

        void setClobAtName​(String parameterName,
                   Reader reader)
            throws SQLException
        Sets the designated parameter to a stream value.
        Parameters:
        parameterName -
        reader - the Reader from which to get the value
        Throws:
        SQLException - if a database access error occurs

      • setBFILEAtName

        void setBFILEAtName​(String parameterName,
                    BFILE value)
             throws SQLException
        Sets the designated parameter to a oracle.sql.BFILEvalue.
        Parameters:
        parameterName -
        value - the parameter value
        Throws:
        SQLException - if a database access error occurs

      • setBfileAtName

        void setBfileAtName​(String parameterName,
                    BFILE value)
             throws SQLException
        Sets the designated parameter to a oracle.sql.BFILEvalue.
        Parameters:
        parameterName -
        value - the parameter value
        Throws:
        SQLException - if a database access error occurs

      • setBytesAtName

        void setBytesAtName​(String parameterName,
                    byte[] value)
             throws SQLException
        Sets the designated parameter to a Java Bytes value.
        Parameters:
        parameterName -
        value - the parameter value
        Throws:
        SQLException - if a database access error occurs

      • setBytesForBlob

        void setBytesForBlob​(int parameterIndex,
                     byte[] value)
              throws SQLException
        Sets the designated parameter to a Java bytes value. For large byte arrays this will only work correctly with a BLOB or LONG RAW column
        Parameters:
        parameterIndex -
        value - the parameter value
        Throws:
        SQLException - if a database access error occurs

      • setBytesForBlobAtName

        void setBytesForBlobAtName​(String parameterName,
                           byte[] value)
                    throws SQLException
        Sets the designated parameter to a Java byte array value. For large byte arrays this will only work correctly with a BLOB or LONG RAW column.
        Parameters:
        parameterName -
        value - the parameter value
        Throws:
        SQLException - if a database access error occurs

      • setDateAtName

        void setDateAtName​(String parameterName,
                   Date value)
            throws SQLException
        Sets the designated parameter to a Java Date value.
        Parameters:
        parameterName -
        value - the parameter value
        Throws:
        SQLException - if a database access error occurs

      • setDateAtName

        void setDateAtName​(String parameterName,
                   Date value,
                   Calendar cal)
            throws SQLException
        Sets the designated parameter to a Java Date value.
        Parameters:
        parameterName -
        value - the parameter value
        cal - the calendar to interpret the date
        Throws:
        SQLException - if a database access error occurs

      • setTimeAtName

        void setTimeAtName​(String parameterName,
                   Time value)
            throws SQLException
        Sets the designated parameter to a Java Time value.
        Parameters:
        parameterName -
        value - the parameter value
        Throws:
        SQLException - if a database access error occurs

      • setTimeAtName

        void setTimeAtName​(String parameterName,
                   Time value,
                   Calendar cal)
            throws SQLException
        Sets the designated parameter to a Java Time value.
        Parameters:
        parameterName -
        value - the parameter value
        cal - the Calendar to use to interpret the value
        Throws:
        SQLException - if a database access error occurs

      • setTimestampAtName

        void setTimestampAtName​(String parameterName,
                        Timestamp value)
                 throws SQLException
        Sets the designated parameter to a Java Timestamp value.
        Parameters:
        parameterName -
        value - the parameter value
        Throws:
        SQLException - if a database access error occurs

      • setTimestampAtName

        void setTimestampAtName​(String parameterName,
                        Timestamp value,
                        Calendar cal)
                 throws SQLException
        Sets the designated parameter to a Java Timestamp value.
        Parameters:
        parameterName -
        value - the parameter value
        cal - the Calendar to use to interpret the date
        Throws:
        SQLException - if a database access error occurs

      • setINTERVALYMAtName

        void setINTERVALYMAtName​(String parameterName,
                         INTERVALYM value)
                  throws SQLException
        Sets the designated parameter to an oracle.sql.INTERVALYM value.
        Parameters:
        parameterName -
        value - the parameter value
        Throws:
        SQLException - if a database access error occurs

      • setINTERVALDSAtName

        void setINTERVALDSAtName​(String parameterName,
                         INTERVALDS value)
                  throws SQLException
        Sets the designated parameter to an oracle.sql.INTERVALDS value.
        Parameters:
        parameterName -
        value - the parameter value
        Throws:
        SQLException - if a database access error occurs

      • setTIMESTAMPAtName

        void setTIMESTAMPAtName​(String parameterName,
                        TIMESTAMP value)
                 throws SQLException
        Sets the designated parameter to an oracle.sql.TIMESTAMP value.
        Parameters:
        parameterName -
        value - the parameter value
        Throws:
        SQLException - if a database access error occurs

      • setTIMESTAMPTZAtName

        void setTIMESTAMPTZAtName​(String parameterName,
                          TIMESTAMPTZ value)
                   throws SQLException
        Sets the designated parameter to an oracle.sql.TIMESTAMPTZ value.
        Parameters:
        parameterName -
        value - the parameter value
        Throws:
        SQLException - if a database access error occurs

      • setTIMESTAMPLTZAtName

        void setTIMESTAMPLTZAtName​(String parameterName,
                           TIMESTAMPLTZ value)
                    throws SQLException
        Sets the designated parameter to an oracle.sql.TIMESTAMPLTZ value.
        Parameters:
        parameterName -
        value - the parameter value
        Throws:
        SQLException - if a database access error occurs

      • setAsciiStreamAtName

        void setAsciiStreamAtName​(String parameterName,
                          InputStream stream,
                          int length)
                   throws SQLException
        Sets the designated parameter to a Java AsciiStream value.
        Parameters:
        parameterName -
        stream - the stream value
        length -
        Throws:
        SQLException - if a database access error occurs

      • setAsciiStreamAtName

        void setAsciiStreamAtName​(String parameterName,
                          InputStream stream,
                          long length)
                   throws SQLException
        Sets the designated parameter to a Java AsciiStream value.
        Parameters:
        parameterName -
        stream - the stream value
        length -
        Throws:
        SQLException - if a database access error occurs

      • setAsciiStreamAtName

        void setAsciiStreamAtName​(String parameterName,
                          InputStream stream)
                   throws SQLException
        Sets the designated parameter to a Java AsciiStream value.
        Parameters:
        parameterName -
        stream - the stream value
        Throws:
        SQLException - if a database access error occurs

      • setBinaryStreamAtName

        void setBinaryStreamAtName​(String parameterName,
                           InputStream stream,
                           int length)
                    throws SQLException
        Sets the designated parameter to a Java BinaryStream value.
        Parameters:
        parameterName -
        stream -
        length -
        Throws:
        SQLException - if a database access error occurs

      • setBinaryStreamAtName

        void setBinaryStreamAtName​(String parameterName,
                           InputStream stream,
                           long length)
                    throws SQLException
        Sets the designated parameter to a Java BinaryStream value.
        Parameters:
        parameterName -
        stream -
        length -
        Throws:
        SQLException - if a database access error occurs

      • setBinaryStreamAtName

        void setBinaryStreamAtName​(String parameterName,
                           InputStream stream)
                    throws SQLException
        Sets the designated parameter to a Java BinaryStream value.
        Parameters:
        parameterName -
        stream -
        Throws:
        SQLException - if a database access error occurs

      • setCharacterStreamAtName

        void setCharacterStreamAtName​(String parameterName,
                              Reader reader,
                              long length)
                       throws SQLException
        Sets the designated parameter to a Java CharacterStream value.
        Parameters:
        parameterName -
        reader -
        length -
        Throws:
        SQLException - if a database access error occurs

      • setCharacterStreamAtName

        void setCharacterStreamAtName​(String parameterName,
                              Reader reader)
                       throws SQLException
        Sets the designated parameter to a Java CharacterStream value.
        Parameters:
        parameterName -
        reader -
        Throws:
        SQLException - if a database access error occurs

      • setUnicodeStreamAtName

        void setUnicodeStreamAtName​(String parameterName,
                            InputStream stream,
                            int length)
                     throws SQLException
        Sets the designated parameter to a Java UnicodeStream value.
        Parameters:
        parameterName -
        stream -
        length -
        Throws:
        SQLException - if a database access error occurs

      • setCustomDatumAtName

        void setCustomDatumAtName​(String parameterName,
                          CustomDatum value)
                   throws SQLException
        Sets the designated parameter to a Java CustomDatum value.
        Parameters:
        parameterName -
        value - the parameter value, should not be null.
        Throws:
        SQLException - if a database access error occurs, of if null value is passed as value.

      • setORADataAtName

        void setORADataAtName​(String parameterName,
                      ORAData value)
               throws SQLException
        Sets the designated parameter to an oracle.sql.ORADatavalue.
        Parameters:
        parameterName -
        value - the parameter value, should not be null.
        Throws:
        SQLException - if a database access error occurs, or if null value is passed as value.

      • setObjectAtName

        void setObjectAtName​(String parameterName,
                     Object value,
                     int targetSqlType,
                     int scale)
              throws SQLException
        Sets the designated parameter to a Java Object value.
        Parameters:
        parameterName -
        value - the parameter value
        targetSqlType -
        scale -
        Throws:
        SQLException - if a database access error occurs

      • setObjectAtName

        void setObjectAtName​(String parameterName,
                     Object value,
                     int targetSqlType)
              throws SQLException
        Sets the designated parameter to a Java Object value.
        Parameters:
        parameterName -
        value - the parameter value
        targetSqlType -
        Throws:
        SQLException - if a database access error occurs

      • setRefTypeAtName

        void setRefTypeAtName​(String parameterName,
                      REF value)
               throws SQLException
        Sets the designated parameter to an oracle.sql.REFvalue.
        Parameters:
        parameterName -
        value - the parameter value
        Throws:
        SQLException - if a database access error occurs

      • setRefAtName

        void setRefAtName​(String parameterName,
                  Ref value)
           throws SQLException
        Sets the designated parameter to a Java Ref value.
        Parameters:
        parameterName -
        value - the parameter value
        Throws:
        SQLException - if a database access error occurs

      • setREFAtName

        void setREFAtName​(String parameterName,
                  REF value)
           throws SQLException
        Sets the designated parameter to an oracle.sql.REFvalue.
        Parameters:
        parameterName -
        value - the parameter value
        Throws:
        SQLException - if a database access error occurs

      • setObjectAtName

        void setObjectAtName​(String parameterName,
                     Object value)
              throws SQLException
        Sets the designated parameter to a Java Object value.
        Parameters:
        parameterName -
        value - the parameter value
        Throws:
        SQLException - if a database access error occurs

      • setOracleObjectAtName

        void setOracleObjectAtName​(String parameterName,
                           Datum value)
                    throws SQLException
        Sets the designated parameter to an oracle.sql.Datumvalue.
        Parameters:
        parameterName -
        value - the parameter value
        Throws:
        SQLException - if a database access error occurs

      • setURLAtName

        void setURLAtName​(String parameterName,
                  URL value)
           throws SQLException
        Sets the designated parameter to a Java URL value.
        Parameters:
        parameterName -
        value - the parameter value
        Throws:
        SQLException - if a database access error occurs

      • setCheckBindTypes

        void setCheckBindTypes​(boolean flag)
        Enable/disable bind type checking.

        When bind type checking is disabled, the Jdbc driver does not check bind types for every execute. It is intended to be used as a performance enhancement if the user knows for fact that bind types do not change across different executions. The default is true.

        Parameters:
        flag - set it to false if Bind Types doesn't change

      • setPlsqlIndexTable

        @Deprecated
void setPlsqlIndexTable​(int parameterIndex,
                        Object arrayData,
                        int maxLen,
                        int curLen,
                        int elemSqlType,
                        int elemMaxLen)
                 throws SQLException
        Deprecated.
        since 18.1. Use java.sql.PreparedStatement.setObject(int parameterIndex, Object x).
        Binds a PL/SQL Associative Array parameter in the IN parameter mode.

        Associative Arrays were formerly called index-by-tables. In PL/SQL they are arrays of key-value pairs where the keys may be numeric or string types and the values may be any scalar type. The keys may be sparse. See the PL/SQL manual

        The database only exports a limited form of this to the client where the keys must be numeric, positive and dense and the values can be only numeric or string. The lengths of the string data are limited to 32767 bytes. The number of characters depends on the character set used. See the PL/SQL manual. The JDBC-thin and JDBC-OCI drivers support 32767 bytes. The server side internal driver is limited to 16382 bytes for input.

        Parameters:
        parameterIndex - This argument indicates the parameter position within the statement. The first parameter is 1, the second is 2, ...
        arrayData - This argument is an array of values to be bound to the PL/SQL index-by table parameter. The value is of type java.lang.Object, and the value can be a Java primitive type array such as int[] or a Java object array such as BigDecimal[].
        maxLen - This argument specifies the maximum table length of the index-by table bind value which defines the maximum possible curLen for batch updates. For standalone binds, maxLen should use the same value as curLen. This argument is required.
        curLen - This argument specifies the actual size of the index-by table bind value in arrayData. If the curLen value is smaller than the size of arrayData, only the curLen number of table elements is passed to the database. If the curLen value is larger than the size of arrayData, the entire arrayData is sent to the database.
        elemSqlType - This argument specifies the index-by table element type based on the values defined in the OracleTypes class.
        elemMaxLen - This argument specifies the index-table element maximum length in case the element type is CHAR, VARCHAR, or RAW. This value is ignored for other types. A value of 0 for elemMaxLen would inidicate the driver to calculate the elemMaxLen based on the actual length of data bound. For a non zero value if the data bound is greater than elemMaxLen it is truncated.
        Throws:
        SQLException - if a database access error occurs
        Since:
        8.1.7

      • setFormOfUse

        void setFormOfUse​(int parameterIndex,
                  short formOfUse)
        Specifies if the data is bound for a SQL NCHAR datatype. It sets the "form of use" of a column of this prepared statement. There are two constants that specify the "form of use": FORM_CHAR for SQL CHAR datatypes and FORM_NCHAR for SQL NCHAR datatypes, where FORM_CHAR is the default. If the "form of use" is set to FORM_NCHAR, the JDBC driver will represent the provided data in the national character set of the server.

        The usage of SQL NCHAR datatypes is similar to that of the SQL CHAR (CHAR, VARCHAR2, and CLOB) datatypes. JDBC uses the same classes and methods to access SQL NCHAR datatypes that are used for the corresponding SQL CHAR datatypes. Therefore, there are no separate, corresponding classes defined in the oracle.sql package for SQL NCHAR datatypes. Likewise, there is no separate, corresponding constant defined in the oracle.jdbc.OracleTypes class for SQL NCHAR datatypes. The only difference in usage between the two datatypes occur in a data bind situation: a JDBC program must call the setFormOfUse() method to specify if the data is bound for a SQL NCHAR datatype.

        In order to put this method in effect, you must invoke this method before setXXX() and registerOutParameter() for the column.

        The following code shows how to access SQL NCHAR data:

            //
    // Table TEST has the following columns:
    // - NUMBER
    // - NVARCHAR2
    // - NCHAR
    //
    oracle.jdbc.OraclePreparedStatement pstmt =
    (oracle.jdbc.OraclePreparedStatement)
    conn.prepareStatement("insert into TEST values(?, ?, ?)");
    
    // oracle.jdbc.OraclePreparedStatement.FORM_NCHAR should be used for all NCHAR,
    // NVARCHAR2 and NCLOB data types.
    
    pstmt.setFormOfUse(2, FORM_NCHAR);
    pstmt.setFormOfUse(3, FORM_NCHAR);
    pstmt.setInt(1, 1);                    // NUMBER column
    pstmt.setString(2, myUnicodeString1);  // NVARCHAR2 column
    pstmt.setString(3, myUnicodeString2);  // NCHAR column
    pstmt.execute();
        Parameters:
        parameterIndex - index of the column in the preparedStatment
        formOfUse - use FORM_CHAR for CHAR, VARCHAR2 and CLOB data, or FORM_NCHAR for NCHAR, NVARCHAR2 and NCLOB data. FORM_CHAR is the default.
        Since:
        9i

      • setDisableStmtCaching

        void setDisableStmtCaching​(boolean cache)
        Don't Cache this object even when the corresponding Connection is Cache Enabled.
        Parameters:
        cache - Set it to true, if you don't want this statement to be cached.

      • OracleGetParameterMetaData

        OracleParameterMetaData OracleGetParameterMetaData()
                                            throws SQLException
        Retrieves the number, types and properties of this PreparedStatement object's parameters.
        Returns:
        an OracleParameterMetaData object that contains information about the number, types and properties of this PreparedStatement object's parameters
        Throws:
        SQLException - if a database access error occurs
        Since:
        9.0.2
        See Also:
        OracleParameterMetaData

      • registerReturnParameter

        void registerReturnParameter​(int paramIndex,
                             int externalType,
                             int maxSize)
                      throws SQLException
        Registers return parameter for DML Returning. maxSize is the max bytes or chars of the return parameter, depending on the type of the return parameter. This method can be only used with char or raw types. If you don't know the max size of return parameters, you should use registerReturnParameter(int paramIndex, int externalType), which picks the default max size for you. If you know the max size of return parameters, using this method can reduce memory consumption.
        Parameters:
        paramIndex - Index of return parameter (should be > 0)
        externalType - Type of return parameter
        maxSize - Max bytes or chars of return parameter
        Throws:
        SQLException - if an error occurs
        Since:
        10.2

      • registerReturnParameter

        void registerReturnParameter​(int paramIndex,
                             int externalType,
                             String typeName)
                      throws SQLException
        Registers return parameter for DML Returning.
        Parameters:
        paramIndex - Index of return parameter (should be > 0)
        externalType - Type of return parameter
        typeName - The fully-qualified name of an SQL structured type
        Throws:
        SQLException - if an error occurs
        Since:
        10.2

      • getReturnResultSet

        ResultSet getReturnResultSet()
                      throws SQLException
        Returns result set that contains data returned from DML Returning.
        Throws:
        SQLException - if an error occurs
        Since:
        10.2

      • setNCharacterStreamAtName

        void setNCharacterStreamAtName​(String parameterName,
                               Reader reader,
                               long length)
                        throws SQLException
        Sets the designated parameter to a Java CharacterStream value using the NCHAR character set.
        Parameters:
        parameterName -
        reader -
        length -
        Throws:
        SQLException - if a database access error occurs

      • setNCharacterStreamAtName

        void setNCharacterStreamAtName​(String parameterName,
                               Reader reader)
                        throws SQLException
        Sets the designated parameter to a Java CharacterStream value using the NCHAR character set.
        Parameters:
        parameterName -
        reader -
        Throws:
        SQLException - if a database access error occurs

      • setNClobAtName

        void setNClobAtName​(String parameterName,
                    NClob value)
             throws SQLException
        Sets the designated parameter to a java.sql.NClobvalue.
        Parameters:
        parameterName -
        value - the parameter value
        Throws:
        SQLException - if a database access error occurs

      • setNClobAtName

        void setNClobAtName​(String parameterName,
                    Reader reader,
                    long length)
             throws SQLException
        Sets the designated parameter to a java.sql.NClobvalue.
        Parameters:
        parameterName -
        reader - the Reader from which to get the value
        length - the number of characters to read
        Throws:
        SQLException - if a database access error occurs

      • setNClobAtName

        void setNClobAtName​(String parameterName,
                    Reader reader)
             throws SQLException
        Sets the designated parameter to a java.sql.NClobvalue.
        Parameters:
        parameterName -
        reader - the Reader from which to get the value
        Throws:
        SQLException - if a database access error occurs

      • setNStringAtName

        void setNStringAtName​(String parameterName,
                      String value)
               throws SQLException
        Sets the designated parameter to a java.sql.Stringvalue using the NCHAR character set
        Parameters:
        parameterName -
        value - the parameter value
        Throws:
        SQLException - if a database access error occurs

      • setRowIdAtName

        void setRowIdAtName​(String parameterName,
                    RowId value)
             throws SQLException
        Sets the designated parameter to a java.sql.RowIdvalue.
        Parameters:
        parameterName -
        value - the parameter value
        Throws:
        SQLException - if a database access error occurs

      • setSQLXMLAtName

        void setSQLXMLAtName​(String parameterName,
                     SQLXML value)
              throws SQLException
        Sets the designated parameter to a java.sql.SQLXMLvalue.
        Parameters:
        parameterName -
        value - the parameter value
        Throws:
        SQLException - if a database access error occurs

      • executeAsyncOracle

        default Flow.Publisher<Boolean> executeAsyncOracle()
                                            throws SQLException
        Asynchronously executes the SQL statement in this PreparedStatement object, which may be any kind of SQL statement. This method returns a Publisher that publishes a single Boolean to indicate the form of the first result. The returned Publisher publishes Boolean.TRUE when execution of the SQL is completed and the result is a ResultSet. It publishes Boolean.FALSE when execution of the SQL is completed and the result is an update count or there is no result. You must call one of the get result methods to retrieve the results: getResultSet or getUpdateCount. You must call getMoreResults to move to any subsequent result(s).

        The returned Publisher calls onError with a SQLTimeoutException when the driver has determined that the timeout value that was specified by the setQueryTimeout method has been exceeded and has at least attempted to cancel the currently running Statement. It calls onError with SQLException if a database access error occurs.

        This method is primarily used for executing DDL or stored procedure calls. To execute queries use executeQueryAsyncOracle(). To execute DML use executeUpdateAsyncOracle().

        Calling any method of this PreparedStatement except cancel, isClosed, or one defined by Object after this method is called will block until the returned Publisher calls onComplete or onError.

        Asynchronous tasks initiated by this method will execute under the current AccessControlContext of the calling thread.

        Returns:
        a Publisher that publishes Boolean.TRUE if the first result is a ResultSet object; Boolean.FALSE if the first result is an update count or there is no result
        Throws:
        SQLException - if a database error occurs or this method is called on a closed PreparedStatement
        Since:
        20

      • executeQueryAsyncOracle

        default Flow.Publisher<OracleResultSet> executeQueryAsyncOracle()
                                                         throws SQLException
        Executes the SQL query in this PreparedStatement object asynchronously and returns a Publisher which publishes a single ResultSet containing the rows produced.

        If the query produces an error or if the query does not produce a set of rows, the Publisher calls onError with a SQLException corresponding to the error.

        The returned Publisher calls onError with a SQLTimeoutException when the driver has determined that the timeout value that was specified by the setQueryTimeout method has been exceeded and has at least attempted to cancel the currently running Statement. It calls onError with SQLException if a database access error occurs.

        Calling any method of this PreparedStatement except cancel, isClosed, or one defined by Object after this method is called will block until the returned Publisher calls onComplete or onError.

        Asynchronous tasks initiated by this method will execute under the current AccessControlContext of the calling thread.

        Returns:
        a Publisher of the ResultSet
        Throws:
        SQLException - if a database access error occurs; this method is called on a closed PreparedStatement or the implementation detects that the SQL statement does not return a ResultSet object
        Since:
        20

      • executeUpdateAsyncOracle

        default Flow.Publisher<Long> executeUpdateAsyncOracle()
                                               throws SQLException
        Asynchronously executes the SQL statement in this PreparedStatement object, which must be a SQL Data Manipulation Language (DML) statement, such as INSERT, UPDATE or DELETE; or an SQL statement that returns nothing, such as a DDL statement. Returns a Publisher which publishes a single count of the number of rows modified. If the SQL statement returns nothing the returned Publisher publishes 0. If the statement produces an error or if the statement produces a set of rows, the Publisher calls onError with a SQLException corresponding to the error.

        The returned Publisher calls onError with a SQLTimeoutException when the driver has determined that the timeout value that was specified by the setQueryTimeout method has been exceeded and has at least attempted to cancel the currently running Statement. It is calls onError with SQLException if a access error occurs.

        Calling any method of this PreparedStatement except cancel, isClosed, or one defined by Object after this method is called will block until the returned Publisher calls onComplete or onError.

        Asynchronous tasks initiated by this method will execute under the current AccessControlContext of the calling thread.

        Returns:
        a Publisher of the count of rows modified
        Throws:
        SQLException - if a database access error occurs; this method is called on a closed PreparedStatement or the implementation detects that the SQL statement returns a ResultSet object
        Since:
        20

      • executeBatchAsyncOracle

        default Flow.Publisher<Long> executeBatchAsyncOracle()
                                              throws SQLException
        Submits a batch of commands to the database for asynchronously execution and if all commands execute successfully, the returned Publisher publishes the update counts. The published Long values are published in the order corresponding to the commands in the batch, which are ordered according to the order in which they were added to the batch. The published values may be one of the following:
        1. A number greater than or equal to zero -- indicates that the command was processed successfully and is an update count giving the number of rows in the database that were affected by the command's execution
        2. A value of SUCCESS_NO_INFO -- indicates that the command was processed successfully but that the number of rows affected is unknown

          If one of the commands in a batch update fails to execute properly, the returned Publisher calls onError with a BatchUpdateException. After such a failure a JDBC driver may or may not continue to process the remaining commands in the batch. However, the driver's behavior must be consistent with a particular DBMS, either always continuing to process commands or never continuing to process commands. If the driver continues processing after a failure, the array returned by the method BatchUpdateException.getUpdateCounts will contain as many elements as there are commands in the batch, and at least one of the elements will be the following:

        3. A value of EXECUTE_FAILED -- indicates that the command failed to execute successfully and occurs only if a driver continues to process commands after a command fails

        The returned Publisher calls onError with a BatchUpdateException when the driver has determined that the timeout value that was specified by the setQueryTimeout method has been exceeded and has at least attempted to cancel the currently running Statement. It calls onError with SQLException if a database access error occurs.

        Calling any method of this PreparedStatement except cancel, isClosed, or one defined by Object after this method is called will block until the returned Publisher calls onComplete or onError.

        Asynchronous tasks initiated by this method will execute under the current AccessControlContext of the calling thread.

        Returns:
        a Publisher that publishes one Long for each command in the batch. The elements are published in the order in which commands were added to the batch. If a command fails the Publisher calls onError with the SQLException that caused the failure.
        Throws:
        SQLException - if a database access error occurs, this method is called on a closed PreparedStatement or the driver does not support batch statements. Throws BatchUpdateException (a subclass of SQLException) if the implementation detects that one of the commands sent to the database returns a result set.
        Since:
        20