OraclePreparedStatement (Oracle Database JDBC Java API Reference)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

Oracle®Database JDBC Java API Reference
12c Release 1 (12.1.0.2)
E56669-01

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

oracle.jdbc
Interface OraclePreparedStatement

All Superinterfaces:: 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 Summary
`static short`	`FORM_CHAR` Specifies the "form of use" for SQL CHAR datatypes (CHAR, VARCHAR2 and CLOB).
`static short`	`FORM_NCHAR` Specifies the "form of use" for SQL NCHAR datatypes (NCHAR, NVARCHAR2 and NCLOB).

Fields inherited from interface oracle.jdbc.OracleStatement
`EXPLICIT, IMPLICIT, NEW`

Fields inherited from interface java.sql.Statement
`CLOSE_ALL_RESULTS, CLOSE_CURRENT_RESULT, EXECUTE_FAILED, KEEP_CURRENT_RESULT, NO_GENERATED_KEYS, RETURN_GENERATED_KEYS, SUCCESS_NO_INFO`

Method Summary
`void`	`defineParameterType(int param_index, int type, int max_size)` Define the type under which you will bind the parameter and the maximum size (in characters) of data you will bind in binds.
`void`	`defineParameterTypeBytes(int param_index, int type, int max_size)` Define the type under which you will bind the parameter and the maximum size (in bytes) of data you will bind in binds.
`void`	`defineParameterTypeChars(int param_index, int type, int max_size)` Define the type under which you will bind the parameter and the maximum size (in characters) of data you will bind in binds.
`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.
`ResultSet`	`getReturnResultSet()` Returns result set that contains data returned from DML Returning.
`OracleParameterMetaData`	`OracleGetParameterMetaData()` Retrieves the number, types and properties of this `PreparedStatement` object's parameters.
`void`	`registerReturnParameter(int paramIndex, int externalType)` Registers return parameter for DML Returning.
`void`	`registerReturnParameter(int paramIndex, int externalType, int maxSize)` Registers return parameter for DML Returning.
`void`	`registerReturnParameter(int paramIndex, int externalType, String typeName)` Registers return parameter for DML Returning.
`int`	`sendBatch()` 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.
`void`	`setARRAY(int parameterIndex, ARRAY arr)` Binds the designated parameter to a `oracle.sql.ARRAY`.
`void`	`setArrayAtName(String parameterName, Array value)` Sets the designated parameter to a Java Array value.
`void`	`setARRAYAtName(String parameterName, ARRAY value)` Sets the designated parameter to a `oracle.sql.ARRAY` value.
`void`	`setAsciiStreamAtName(String parameterName, InputStream stream)` Sets the designated parameter to a Java AsciiStream value.
`void`	`setAsciiStreamAtName(String parameterName, InputStream stream, int length)` Sets the designated parameter to a Java AsciiStream value.
`void`	`setAsciiStreamAtName(String parameterName, InputStream stream, long length)` Sets the designated parameter to a Java AsciiStream value.
`void`	`setBfile(int parameterIndex, BFILE file)` Binds the designated parameter to a `oracle.sql.BFILE` value.
`void`	`setBFILE(int parameterIndex, BFILE file)` Binds the designated parameter to a `oracle.sql.BFILE` value.
`void`	`setBfileAtName(String parameterName, BFILE value)` Sets the designated parameter to a `oracle.sql.BFILE`value.
`void`	`setBFILEAtName(String parameterName, BFILE value)` Sets the designated parameter to a `oracle.sql.BFILE`value.
`void`	`setBigDecimalAtName(String parameterName, BigDecimal value)` Sets the designated parameter to a Java BigDecimal value.
`void`	`setBinaryDouble(int parameterIndex, BINARY_DOUBLE value)` Sets the designated parameter to an oracle.sql.BINARY_DOUBLE value.
`void`	`setBinaryDouble(int parameterIndex, double value)` Sets the designated parameter to a Java double value.
`void`	`setBinaryDoubleAtName(String parameterName, BINARY_DOUBLE value)` Sets the designated parameter to an oracle.sql.BINARY_DOUBLE value.
`void`	`setBinaryDoubleAtName(String parameterName, double value)` Sets the designated parameter to a Java Double value.
`void`	`setBinaryFloat(int parameterIndex, BINARY_FLOAT value)` Sets the designated parameter to an oracle.sql.BINARY_FLOAT value.
`void`	`setBinaryFloat(int parameterIndex, float value)` Sets the designated parameter to a Java float value.
`void`	`setBinaryFloatAtName(String parameterName, BINARY_FLOAT value)` Sets the designated parameter to an oracle.sql.BINARY_FLOAT value.
`void`	`setBinaryFloatAtName(String parameterName, float value)` Sets the designated parameter to a Java Float value.
`void`	`setBinaryStreamAtName(String parameterName, InputStream stream)` Sets the designated parameter to a Java BinaryStream value.
`void`	`setBinaryStreamAtName(String parameterName, InputStream stream, int length)` Sets the designated parameter to a Java BinaryStream value.
`void`	`setBinaryStreamAtName(String parameterName, InputStream stream, long length)` Sets the designated parameter to a Java BinaryStream value.
`void`	`setBLOB(int parameterIndex, BLOB lob)` Binds the designated parameter to a `oracle.sql.BLOB` value.
`void`	`setBlobAtName(String parameterName, Blob value)` Sets the designated parameter to a Java Blob value.
`void`	`setBLOBAtName(String parameterName, BLOB value)` Sets the designated parameter to an oracle.sql.BLOB value.
`void`	`setBlobAtName(String parameterName, InputStream stream)` Sets the designated parameter to a stream value.
`void`	`setBlobAtName(String parameterName, InputStream stream, long length)` Sets the designated parameter to a stream value.
`void`	`setBooleanAtName(String parameterName, boolean value)` Sets the designated parameter to a Java Boolean value.
`void`	`setByteAtName(String parameterName, byte value)` Sets the designated parameter to a Java Byte value.
`void`	`setBytesAtName(String parameterName, byte[] value)` Sets the designated parameter to a Java Bytes value.
`void`	`setBytesForBlob(int parameterIndex, byte[] value)` Sets the designated parameter to a Java bytes value.
`void`	`setBytesForBlobAtName(String parameterName, byte[] value)` Sets the designated parameter to a Java byte array value.
`void`	`setCHAR(int parameterIndex, CHAR ch)` Binds the designated parameter to a `oracle.sql.CHAR` value.
`void`	`setCharacterStreamAtName(String parameterName, Reader reader)` Sets the designated parameter to a Java CharacterStream value.
`void`	`setCharacterStreamAtName(String parameterName, Reader reader, long length)` Sets the designated parameter to a Java CharacterStream value.
`void`	`setCHARAtName(String parameterName, CHAR value)` Sets the designated parameter to an oracle.sql.CHAR value.
`void`	`setCheckBindTypes(boolean flag)` Enable/disable bind type checking.
`void`	`setCLOB(int parameterIndex, CLOB lob)` Binds the designated parameter to a `oracle.sql.CLOB` value.
`void`	`setClobAtName(String parameterName, Clob value)` Sets the designated parameter to a Java Clob value.
`void`	`setCLOBAtName(String parameterName, CLOB value)` Sets the designated parameter to an oracle.sql.CLOB value.
`void`	`setClobAtName(String parameterName, Reader reader)` Sets the designated parameter to a stream value.
`void`	`setClobAtName(String parameterName, Reader reader, long length)` Sets the designated parameter to a stream value.
`void`	`setCursor(int parameterIndex, ResultSet rs)` Deprecated.
`void`	`setCursorAtName(String parameterName, ResultSet value)` Sets the designated parameter to a Java Cursor value.
`void`	`setCustomDatum(int parameterIndex, CustomDatum x)` Deprecated.
`void`	`setCustomDatumAtName(String parameterName, CustomDatum value)` Sets the designated parameter to a Java CustomDatum value.
`void`	`setDATE(int parameterIndex, DATE date)` Binds the designated parameter to a `oracle.sql.DATE` value.
`void`	`setDateAtName(String parameterName, Date value)` Sets the designated parameter to a Java Date value.
`void`	`setDATEAtName(String parameterName, DATE value)` Sets the designated parameter to an oracle.sql.DATE value.
`void`	`setDateAtName(String parameterName, Date value, Calendar cal)` Sets the designated parameter to a Java Date value.
`void`	`setDisableStmtCaching(boolean cache)` Don't Cache this object even when the corresponding Connection is Cache Enabled.
`void`	`setDoubleAtName(String parameterName, double value)` Sets the designated parameter to a Java Double value.
`void`	`setExecuteBatch(int batchValue)` 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.
`void`	`setFixedCHAR(int parameterIndex, String x)` Sets the disignated parameter to a `String` and executes a non-padded comparison with a SQL CHAR.
`void`	`setFixedCHARAtName(String parameterName, String value)` Sets the designated parameter to a Java FixedCHAR value.
`void`	`setFloatAtName(String parameterName, float value)` Sets the designated parameter to a Java Float value.
`void`	`setFormOfUse(int parameterIndex, short formOfUse)` Specifies if the data is bound for a SQL NCHAR datatype.
`void`	`setIntAtName(String parameterName, int value)` Sets the designated parameter to a Java Int value.
`void`	`setINTERVALDS(int parameterIndex, INTERVALDS x)` Binds the designated parameter to an oracle.sql.INTERVALDS value.
`void`	`setINTERVALDSAtName(String parameterName, INTERVALDS value)` Sets the designated parameter to an oracle.sql.INTERVALDS value.
`void`	`setINTERVALYM(int parameterIndex, INTERVALYM x)` Binds the designated parameter to an oracle.sql.INTERVALYM value.
`void`	`setINTERVALYMAtName(String parameterName, INTERVALYM value)` Sets the designated parameter to an oracle.sql.INTERVALYM value.
`void`	`setLongAtName(String parameterName, long value)` Sets the designated parameter to a Java Long value.
`void`	`setNCharacterStreamAtName(String parameterName, Reader reader)` Sets the designated parameter to a Java CharacterStream value using the NCHAR character set.
`void`	`setNCharacterStreamAtName(String parameterName, Reader reader, long length)` Sets the designated parameter to a Java CharacterStream value using the NCHAR character set.
`void`	`setNClobAtName(String parameterName, NClob value)` Sets the designated parameter to a `java.sql.NClob`value.
`void`	`setNClobAtName(String parameterName, Reader reader)` Sets the designated parameter to a `java.sql.NClob`value.
`void`	`setNClobAtName(String parameterName, Reader reader, long length)` Sets the designated parameter to a `java.sql.NClob`value.
`void`	`setNStringAtName(String parameterName, String value)` Sets the designated parameter to a `java.sql.String`value using the NCHAR character set
`void`	`setNullAtName(String parameterName, int sqlType)` Sets the designated parameter to a SQL NULL value.
`void`	`setNullAtName(String parameterName, int sqlType, String sqlName)` Sets the designated parameter to a SQL NULL value.
`void`	`setNUMBER(int parameterIndex, NUMBER num)` Binds the designated parameter to a `oracle.sql.NUMBER` value.
`void`	`setNUMBERAtName(String parameterName, NUMBER value)` Sets the designated parameter to an `oracle.sql.NUMBER` value.
`void`	`setObjectAtName(String parameterName, Object value)` Sets the designated parameter to a Java Object value.
`void`	`setObjectAtName(String parameterName, Object value, int targetSqlType)` Sets the designated parameter to a Java Object value.
`void`	`setObjectAtName(String parameterName, Object value, int targetSqlType, int scale)` Sets the designated parameter to a Java Object value.
`void`	`setOPAQUE(int parameterIndex, OPAQUE val)` Binds the designated parameter to a `oracle.sql.OPAQUE` value.
`void`	`setOPAQUEAtName(String parameterName, OPAQUE value)` Sets the designated parameter to an `oracle.sql.OPAQUE`value.
`void`	`setOracleObject(int parameterIndex, Datum x)` Binds the designated parameter to a `oracle.sql.Datum` value.
`void`	`setOracleObjectAtName(String parameterName, Datum value)` Sets the designated parameter to an `oracle.sql.Datum`value.
`void`	`setORAData(int parameterIndex, ORAData x)` Binds the designated parameter to a `oracle.sql.ORAData` value.
`void`	`setORADataAtName(String parameterName, ORAData value)` Sets the designated parameter to an `oracle.sql.ORAData`value.
`void`	`setPlsqlIndexTable(int parameterIndex, Object arrayData, int maxLen, int curLen, int elemSqlType, int elemMaxLen)` Binds a PL/SQL Associative Array parameter in the IN parameter mode.
`void`	`setRAW(int parameterIndex, RAW raw)` Binds the designated parameter to a `oracle.sql.RAW` value.
`void`	`setRAWAtName(String parameterName, RAW value)` Sets the designated parameter to an `oracle.sql.RAW`value.
`void`	`setREF(int parameterIndex, REF ref)` Binds the designated parameter to a `oracle.sql.REF` value.
`void`	`setRefAtName(String parameterName, Ref value)` Sets the designated parameter to a Java Ref value.
`void`	`setREFAtName(String parameterName, REF value)` Sets the designated parameter to an `oracle.sql.REF`value.
`void`	`setRefType(int parameterIndex, REF ref)` Binds the designated parameter to a `oracle.sql.REF` value.
`void`	`setRefTypeAtName(String parameterName, REF value)` Sets the designated parameter to an `oracle.sql.REF`value.
`void`	`setROWID(int parameterIndex, ROWID rowid)` Binds the designated parameter to a `oracle.sql.ROWID` value.
`void`	`setRowIdAtName(String parameterName, RowId value)` Sets the designated parameter to a `java.sql.RowId`value.
`void`	`setROWIDAtName(String parameterName, ROWID value)` Sets the designated parameter to an `oracle.sql.ROWID`value.
`void`	`setShortAtName(String parameterName, short value)` Sets the designated parameter to a Java Short value.
`void`	`setSQLXMLAtName(String parameterName, SQLXML value)` Sets the designated parameter to a `java.sql.SQLXML`value.
`void`	`setStringAtName(String parameterName, String value)` Sets the designated parameter to a Java String value.
`void`	`setStringForClob(int parameterIndex, String value)` Sets the designated parameter to a Java String value.
`void`	`setStringForClobAtName(String parameterName, String value)` Sets the designated parameter to a Java String value.
`void`	`setSTRUCT(int parameterIndex, STRUCT struct)` Binds the designated parameter to a `oracle.sql.STRUCT` value.
`void`	`setSTRUCTAtName(String parameterName, STRUCT value)` Sets the designated parameter to an `oracle.sql.STRUCT`value.
`void`	`setStructDescriptor(int parameterIndex, StructDescriptor desc)` Binds the bind type of designated parameter from an oracle.sql.StructDescriptor.
`void`	`setStructDescriptorAtName(String parameterName, StructDescriptor desc)` Sets the designated parameter to an `oracle.sql.StructDescriptor` value.
`void`	`setTimeAtName(String parameterName, Time value)` Sets the designated parameter to a Java Time value.
`void`	`setTimeAtName(String parameterName, Time value, Calendar cal)` Sets the designated parameter to a Java Time value.
`void`	`setTIMESTAMP(int parameterIndex, TIMESTAMP x)` Binds the designated parameter to an oracle.sql.TIMESTAMP value.
`void`	`setTimestampAtName(String parameterName, Timestamp value)` Sets the designated parameter to a Java Timestamp value.
`void`	`setTIMESTAMPAtName(String parameterName, TIMESTAMP value)` Sets the designated parameter to an `oracle.sql.TIMESTAMP` value.
`void`	`setTimestampAtName(String parameterName, Timestamp value, Calendar cal)` Sets the designated parameter to a Java Timestamp value.
`void`	`setTIMESTAMPLTZ(int parameterIndex, TIMESTAMPLTZ x)` Binds the designated parameter to an `oracle.sql.TIMESTAMPLTZ` value.
`void`	`setTIMESTAMPLTZAtName(String parameterName, TIMESTAMPLTZ value)` Sets the designated parameter to an `oracle.sql.TIMESTAMPLTZ` value.
`void`	`setTIMESTAMPTZ(int parameterIndex, TIMESTAMPTZ x)` Binds the designated parameter to an `oracle.sql.TIMESTAMPTZ` value.
`void`	`setTIMESTAMPTZAtName(String parameterName, TIMESTAMPTZ value)` Sets the designated parameter to an `oracle.sql.TIMESTAMPTZ` value.
`void`	`setUnicodeStreamAtName(String parameterName, InputStream stream, int length)` Sets the designated parameter to a Java UnicodeStream value.
`void`	`setURLAtName(String parameterName, URL value)` Sets the designated parameter to a Java URL value.

Methods inherited from interface java.sql.PreparedStatement
addBatch, clearParameters, execute, executeQuery, executeUpdate, getMetaData, getParameterMetaData, setArray, setAsciiStream, setAsciiStream, setAsciiStream, setBigDecimal, setBinaryStream, setBinaryStream, setBinaryStream, setBlob, setBlob, setBlob, setBoolean, setByte, setBytes, setCharacterStream, setCharacterStream, setCharacterStream, setClob, setClob, setClob, setDate, setDate, setDouble, setFloat, setInt, setLong, setNCharacterStream, setNCharacterStream, setNClob, setNClob, setNClob, setNString, setNull, setNull, setObject, setObject, setObject, setRef, setRowId, setShort, setSQLXML, setString, setTime, setTime, setTimestamp, setTimestamp, setUnicodeStream, setURL

Methods inherited from interface java.sql.PreparedStatement

addBatch, clearParameters, execute, executeQuery, executeUpdate, getMetaData, getParameterMetaData, setArray, setAsciiStream, setAsciiStream, setAsciiStream, setBigDecimal, setBinaryStream, setBinaryStream, setBinaryStream, setBlob, setBlob, setBlob, setBoolean, setByte, setBytes, setCharacterStream, setCharacterStream, setCharacterStream, setClob, setClob, setClob, setDate, setDate, setDouble, setFloat, setInt, setLong, setNCharacterStream, setNCharacterStream, setNClob, setNClob, setNClob, setNString, setNull, setNull, setObject, setObject, setObject, setRef, setRowId, setShort, setSQLXML, setString, setTime, setTime, setTimestamp, setTimestamp, setUnicodeStream, setURL

Methods inherited from interface oracle.jdbc.OracleStatement
`clearDefines, closeWithKey, creationState, defineColumnType, defineColumnType, defineColumnType, defineColumnType, defineColumnTypeBytes, defineColumnTypeChars, getLobPrefetchSize, getRegisteredQueryId, getRegisteredTableNames, getRowPrefetch, isNCHAR, setDatabaseChangeRegistration, setLobPrefetchSize, setRowPrefetch`

Methods inherited from interface java.sql.Statement
addBatch, cancel, clearBatch, clearWarnings, close, execute, execute, execute, execute, executeBatch, executeQuery, executeUpdate, executeUpdate, executeUpdate, executeUpdate, getConnection, getFetchDirection, getFetchSize, getGeneratedKeys, getMaxFieldSize, getMaxRows, getMoreResults, getMoreResults, getQueryTimeout, getResultSet, getResultSetConcurrency, getResultSetHoldability, getResultSetType, getUpdateCount, getWarnings, isClosed, isPoolable, setCursorName, setEscapeProcessing, setFetchDirection, setFetchSize, setMaxFieldSize, setMaxRows, setPoolable, setQueryTimeout

Methods inherited from interface java.sql.Statement

addBatch, cancel, clearBatch, clearWarnings, close, execute, execute, execute, execute, executeBatch, executeQuery, executeUpdate, executeUpdate, executeUpdate, executeUpdate, getConnection, getFetchDirection, getFetchSize, getGeneratedKeys, getMaxFieldSize, getMaxRows, getMoreResults, getMoreResults, getQueryTimeout, getResultSet, getResultSetConcurrency, getResultSetHoldability, getResultSetType, getUpdateCount, getWarnings, isClosed, isPoolable, setCursorName, setEscapeProcessing, setFetchDirection, setFetchSize, setMaxFieldSize, setMaxRows, setPoolable, setQueryTimeout

Methods inherited from interface java.sql.Wrapper
`isWrapperFor, unwrap`

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.

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.

Retrieves the batch value of this statement for the Oracle update batching model (default is set by the connection object).

To set the batch value for this statement, you can use the setExecuteBatch method. You can also set a default batch value with the OracleConnection.setDefaultExecuteBatch.

Returns:: the batch value
See Also:: OracleConnection.setDefaultExecuteBatch, setExecuteBatch

sendBatch

int sendBatch()
              throws SQLException

Sends any existing batch (for the Oracle update batching model).

This method flushes any batched executions before the batch value is reached. Executions normally happen when the number of executions reaches the batch value, which is set via the setExecuteBatch method. It does not do anything if the statement does not use the Oracle batching model.

Returns:: the update count.
Throws:: SQLException - if an error occurred

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

Sets the batch value of this statement for the Oracle update batching model (the default value is set by the connection object).

The Oracle update batching model allows you to "batch" multiple executions of a single statement with different bind variables. Actual execution happens when the number of batched executions reaches the "batch value", which is set by this method.

The batch value for this prepared statement can be set at any time via this method. Changing the batch value will affect all future executes. You can also use OracleConnection.setDefaultExecuteBatch to set a default batch value.

The batch value will automatically be set to 1 by the driver if any of the bind types is of type stream. This overrides any value that the user might have set. Binds that were performed before any setXXXStream() is called, and that have not been executed, will be flushed (i.e. executed).

Note: It is important to be aware that you cannot mix the Oracle update batching model and the standard one. In any single application, you can use the syntax of one model or the other, but not both. The Oracle JDBC driver will throw exceptions when you mix these syntaxes.

Parameters:: batchValue - batch value to be set. It must be greater than or equal to 1.
Throws:: SQLException - if batchValue is less than 1
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

void setPlsqlIndexTable(int parameterIndex,
                        Object arrayData,
                        int maxLen,
                        int curLen,
                        int elemSqlType,
                        int elemMaxLen)
                        throws SQLException

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)
                             throws SQLException

Registers return parameter for DML Returning.

Parameters:: paramIndex - Index of return parameter (should be > 0); externalType - Type of return parameter.
For OracleTypes REF, STRUCT, JAVA_STRUCT, ARRAY, use:
registerReturnParameter(int paramIndex, int externalType, String typeName)
Throws:: SQLException - if an error occurs
Since:: 10.2

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

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

Oracle®Database JDBC Java API Reference
12c Release 1 (12.1.0.2)
E56669-01

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

oracle.jdbc Interface OraclePreparedStatement

FORM_NCHAR

FORM_CHAR

defineParameterTypeBytes

defineParameterTypeChars

defineParameterType

getExecuteBatch

sendBatch

setARRAY

setBfile

setBFILE

setBLOB

setCHAR

setCLOB

setCursor

setCustomDatum

setORAData

setDATE

setExecuteBatch

setFixedCHAR

setNUMBER

setBinaryFloat

setBinaryFloat

setBinaryDouble

setBinaryDouble

setOPAQUE

setOracleObject

setStructDescriptor

setRAW

setREF

setRefType

setROWID

setSTRUCT

setTIMESTAMP

setTIMESTAMPTZ

setTIMESTAMPLTZ

setINTERVALYM

setINTERVALDS

setNullAtName

setNullAtName

setBooleanAtName

setByteAtName

setShortAtName

setIntAtName

setLongAtName

setFloatAtName

setDoubleAtName

setBinaryFloatAtName

setBinaryFloatAtName

setBinaryDoubleAtName

setBinaryDoubleAtName

setBigDecimalAtName

setStringAtName

setStringForClob

setStringForClobAtName

setFixedCHARAtName

setCursorAtName

setROWIDAtName

setArrayAtName

setARRAYAtName

setOPAQUEAtName

setStructDescriptorAtName

setSTRUCTAtName

setRAWAtName

setCHARAtName

setDATEAtName

setNUMBERAtName

setBLOBAtName

setBlobAtName

setBlobAtName

setBlobAtName

setCLOBAtName

setClobAtName

setClobAtName

setClobAtName

setBFILEAtName

setBfileAtName

setBytesAtName

setBytesForBlob

setBytesForBlobAtName

oracle.jdbc
Interface OraclePreparedStatement