Interface OraclePreparedStatement
- All Superinterfaces:
AutoCloseable,OracleCommonPreparedStatement,OracleCommonStatement,OracleStatement,PreparedStatement,Statement,Wrapper
- All Known Subinterfaces:
OracleCallableStatement
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
FieldsModifier and TypeFieldDescriptionstatic final shortSpecifies the "form of use" for SQL CHAR datatypes (CHAR, VARCHAR2 and CLOB).static final shortSpecifies the "form of use" for SQL NCHAR datatypes (NCHAR, NVARCHAR2 and NCLOB).Fields inherited from interface oracle.jdbc.OracleStatement
EXPLICIT, IMPLICIT, NEWFields 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
Modifier and TypeMethodDescriptionvoiddefineParameterType(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.voiddefineParameterTypeBytes(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.voiddefineParameterTypeChars(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.Executes the SQL query in thisPreparedStatementobject asynchronously and returns aPublisherwhich publishes a singleResultSetcontaining the rows produced.intExecutes the SQL statement in thisPreparedStatementobject, which must be an SQL Data Manipulation Language (DML) statement, such asINSERT,UPDATEorDELETE; or an SQL statement that returns nothing, such as a DDL statement.default intDeprecated.As of 12.1 all APIs related to oracle-style statement batching are deprecated in favor of standard JDBC batching.Returns result set that contains data returned from DML Returning.Retrieves the number, types and properties of thisPreparedStatementobject's parameters.voidregisterReturnParameter(int paramIndex, int externalType) Registers return parameter for DML Returning.voidregisterReturnParameter(int paramIndex, int externalType, int maxSize) Registers return parameter for DML Returning.voidregisterReturnParameter(int paramIndex, int externalType, String typeName) Registers return parameter for DML Returning.intDeprecated.As of 12.1 all APIs related to oracle-style statement batching are deprecated in favor of standard JDBC batching.voidBinds the designated parameter to aoracle.sql.ARRAY.voidsetArrayAtName(String parameterName, Array value) Sets the designated parameter to a Java Array value.voidsetARRAYAtName(String parameterName, ARRAY value) Sets the designated parameter to aoracle.sql.ARRAYvalue.voidsetAsciiStreamAtName(String parameterName, InputStream stream) Sets the designated parameter to a Java AsciiStream value.voidsetAsciiStreamAtName(String parameterName, InputStream stream, int length) Sets the designated parameter to a Java AsciiStream value.voidsetAsciiStreamAtName(String parameterName, InputStream stream, long length) Sets the designated parameter to a Java AsciiStream value.voidBinds the designated parameter to aoracle.sql.BFILEvalue.voidBinds the designated parameter to aoracle.sql.BFILEvalue.voidsetBfileAtName(String parameterName, BFILE value) Sets the designated parameter to aoracle.sql.BFILEvalue.voidsetBFILEAtName(String parameterName, BFILE value) Sets the designated parameter to aoracle.sql.BFILEvalue.voidsetBigDecimalAtName(String parameterName, BigDecimal value) Sets the designated parameter to a Java BigDecimal value.voidsetBinaryDouble(int parameterIndex, double value) Sets the designated parameter to a Java double value.voidsetBinaryDouble(int parameterIndex, BINARY_DOUBLE value) Sets the designated parameter to an oracle.sql.BINARY_DOUBLE value.voidsetBinaryDoubleAtName(String parameterName, double value) Sets the designated parameter to a Java Double value.voidsetBinaryDoubleAtName(String parameterName, BINARY_DOUBLE value) Sets the designated parameter to an oracle.sql.BINARY_DOUBLE value.voidsetBinaryFloat(int parameterIndex, float value) Sets the designated parameter to a Java float value.voidsetBinaryFloat(int parameterIndex, BINARY_FLOAT value) Sets the designated parameter to an oracle.sql.BINARY_FLOAT value.voidsetBinaryFloatAtName(String parameterName, float value) Sets the designated parameter to a Java Float value.voidsetBinaryFloatAtName(String parameterName, BINARY_FLOAT value) Sets the designated parameter to an oracle.sql.BINARY_FLOAT value.voidsetBinaryStreamAtName(String parameterName, InputStream stream) Sets the designated parameter to a Java BinaryStream value.voidsetBinaryStreamAtName(String parameterName, InputStream stream, int length) Sets the designated parameter to a Java BinaryStream value.voidsetBinaryStreamAtName(String parameterName, InputStream stream, long length) Sets the designated parameter to a Java BinaryStream value.voidBinds the designated parameter to aoracle.sql.BLOBvalue.voidsetBlobAtName(String parameterName, InputStream stream) Sets the designated parameter to a stream value.voidsetBlobAtName(String parameterName, InputStream stream, long length) Sets the designated parameter to a stream value.voidsetBlobAtName(String parameterName, Blob value) Sets the designated parameter to a Java Blob value.voidsetBLOBAtName(String parameterName, BLOB value) Sets the designated parameter to an oracle.sql.BLOB value.voidsetBooleanAtName(String parameterName, boolean value) Sets the designated parameter to a Java Boolean value.voidsetByteAtName(String parameterName, byte value) Sets the designated parameter to a Java Byte value.voidsetBytesAtName(String parameterName, byte[] value) Sets the designated parameter to a Java Bytes value.voidsetBytesForBlob(int parameterIndex, byte[] value) Sets the designated parameter to a Java bytes value.voidsetBytesForBlobAtName(String parameterName, byte[] value) Sets the designated parameter to a Java byte array value.voidBinds the designated parameter to aoracle.sql.CHARvalue.voidsetCharacterStreamAtName(String parameterName, Reader reader) Sets the designated parameter to a Java CharacterStream value.voidsetCharacterStreamAtName(String parameterName, Reader reader, long length) Sets the designated parameter to a Java CharacterStream value.voidsetCHARAtName(String parameterName, CHAR value) Sets the designated parameter to an oracle.sql.CHAR value.voidsetCheckBindTypes(boolean flag) Enable/disable bind type checking.voidBinds the designated parameter to aoracle.sql.CLOBvalue.voidsetClobAtName(String parameterName, Reader reader) Sets the designated parameter to a stream value.voidsetClobAtName(String parameterName, Reader reader, long length) Sets the designated parameter to a stream value.voidsetClobAtName(String parameterName, Clob value) Sets the designated parameter to a Java Clob value.voidsetCLOBAtName(String parameterName, CLOB value) Sets the designated parameter to an oracle.sql.CLOB value.voidDeprecated.voidsetCursorAtName(String parameterName, ResultSet value) Sets the designated parameter to a Java Cursor value.voidsetCustomDatum(int parameterIndex, CustomDatum x) Deprecated.voidsetCustomDatumAtName(String parameterName, CustomDatum value) Sets the designated parameter to a Java CustomDatum value.voidBinds the designated parameter to aoracle.sql.DATEvalue.voidsetDateAtName(String parameterName, Date value) Sets the designated parameter to a Java Date value.voidsetDateAtName(String parameterName, Date value, Calendar cal) Sets the designated parameter to a Java Date value.voidsetDATEAtName(String parameterName, DATE value) Sets the designated parameter to an oracle.sql.DATE value.voidsetDisableStmtCaching(boolean cache) Don't Cache this object even when the corresponding Connection is Cache Enabled.voidsetDoubleAtName(String parameterName, double value) Sets the designated parameter to a Java Double value.default voidsetExecuteBatch(int batchValue) Deprecated.As of 12.1 all APIs related to oracle-style statement batching are deprecated in favor of standard JDBC batching.voidsetFixedCHAR(int parameterIndex, String x) Sets the designated parameter to aStringand executes a non-padded comparison with a SQL CHAR.voidsetFixedCHARAtName(String parameterName, String value) Sets the designated parameter to a Java FixedCHAR value.voidsetFloatAtName(String parameterName, float value) Sets the designated parameter to a Java Float value.voidsetFormOfUse(int parameterIndex, short formOfUse) Specifies if the data is bound for a SQL NCHAR datatype.voidsetIntAtName(String parameterName, int value) Sets the designated parameter to a Java Int value.voidsetINTERVALDS(int parameterIndex, INTERVALDS x) Binds the designated parameter to an oracle.sql.INTERVALDS value.voidsetINTERVALDSAtName(String parameterName, INTERVALDS value) Sets the designated parameter to an oracle.sql.INTERVALDS value.voidsetINTERVALYM(int parameterIndex, INTERVALYM x) Binds the designated parameter to an oracle.sql.INTERVALYM value.voidsetINTERVALYMAtName(String parameterName, INTERVALYM value) Sets the designated parameter to an oracle.sql.INTERVALYM value.voidsetLongAtName(String parameterName, long value) Sets the designated parameter to a Java Long value.voidsetNCharacterStreamAtName(String parameterName, Reader reader) Sets the designated parameter to a Java CharacterStream value using the NCHAR character set.voidsetNCharacterStreamAtName(String parameterName, Reader reader, long length) Sets the designated parameter to a Java CharacterStream value using the NCHAR character set.voidsetNClobAtName(String parameterName, Reader reader) Sets the designated parameter to ajava.sql.NClobvalue.voidsetNClobAtName(String parameterName, Reader reader, long length) Sets the designated parameter to ajava.sql.NClobvalue.voidsetNClobAtName(String parameterName, NClob value) Sets the designated parameter to ajava.sql.NClobvalue.voidsetNStringAtName(String parameterName, String value) Sets the designated parameter to ajava.sql.Stringvalue using the NCHAR character setvoidsetNullAtName(String parameterName, int sqlType) Sets the designated parameter to a SQL NULL value.voidsetNullAtName(String parameterName, int sqlType, String sqlName) Sets the designated parameter to a SQL NULL value.voidBinds the designated parameter to aoracle.sql.NUMBERvalue.voidsetNUMBERAtName(String parameterName, NUMBER value) Sets the designated parameter to anoracle.sql.NUMBERvalue.voidsetObjectAtName(String parameterName, Object value) Sets the designated parameter to a Java Object value.voidsetObjectAtName(String parameterName, Object value, int targetSqlType) Sets the designated parameter to a Java Object value.voidsetObjectAtName(String parameterName, Object value, int targetSqlType, int scale) Sets the designated parameter to a Java Object value.voidBinds the designated parameter to aoracle.sql.OPAQUEvalue.voidsetOPAQUEAtName(String parameterName, OPAQUE value) Sets the designated parameter to anoracle.sql.OPAQUEvalue.voidsetOracleObject(int parameterIndex, Datum x) Binds the designated parameter to aoracle.sql.Datumvalue.voidsetOracleObjectAtName(String parameterName, Datum value) Sets the designated parameter to anoracle.sql.Datumvalue.voidsetORAData(int parameterIndex, ORAData x) Binds the designated parameter to aoracle.sql.ORADatavalue.voidsetORADataAtName(String parameterName, ORAData value) Sets the designated parameter to anoracle.sql.ORADatavalue.voidsetPlsqlIndexTable(int parameterIndex, Object arrayData, int maxLen, int curLen, int elemSqlType, int elemMaxLen) Deprecated.since 18.1.voidBinds the designated parameter to aoracle.sql.RAWvalue.voidsetRAWAtName(String parameterName, RAW value) Sets the designated parameter to anoracle.sql.RAWvalue.voidBinds the designated parameter to aoracle.sql.REFvalue.voidsetRefAtName(String parameterName, Ref value) Sets the designated parameter to a Java Ref value.voidsetREFAtName(String parameterName, REF value) Sets the designated parameter to anoracle.sql.REFvalue.voidsetRefType(int parameterIndex, REF ref) Binds the designated parameter to aoracle.sql.REFvalue.voidsetRefTypeAtName(String parameterName, REF value) Sets the designated parameter to anoracle.sql.REFvalue.voidBinds the designated parameter to aoracle.sql.ROWIDvalue.voidsetRowIdAtName(String parameterName, RowId value) Sets the designated parameter to ajava.sql.RowIdvalue.voidsetROWIDAtName(String parameterName, ROWID value) Sets the designated parameter to anoracle.sql.ROWIDvalue.voidsetShortAtName(String parameterName, short value) Sets the designated parameter to a Java Short value.voidsetSQLXMLAtName(String parameterName, SQLXML value) Sets the designated parameter to ajava.sql.SQLXMLvalue.voidsetStringAtName(String parameterName, String value) Sets the designated parameter to a Java String value.voidsetStringForClob(int parameterIndex, String value) Sets the designated parameter to a Java String value.voidsetStringForClobAtName(String parameterName, String value) Sets the designated parameter to a Java String value.voidBinds the designated parameter to aoracle.sql.STRUCTvalue.voidsetSTRUCTAtName(String parameterName, STRUCT value) Sets the designated parameter to anoracle.sql.STRUCTvalue.voidsetStructDescriptor(int parameterIndex, StructDescriptor desc) Binds the bind type of designated parameter from an oracle.sql.StructDescriptor.voidsetStructDescriptorAtName(String parameterName, StructDescriptor desc) Sets the designated parameter to anoracle.sql.StructDescriptorvalue.voidsetTimeAtName(String parameterName, Time value) Sets the designated parameter to a Java Time value.voidsetTimeAtName(String parameterName, Time value, Calendar cal) Sets the designated parameter to a Java Time value.voidsetTIMESTAMP(int parameterIndex, TIMESTAMP x) Binds the designated parameter to an oracle.sql.TIMESTAMP value.voidsetTimestampAtName(String parameterName, Timestamp value) Sets the designated parameter to a Java Timestamp value.voidsetTimestampAtName(String parameterName, Timestamp value, Calendar cal) Sets the designated parameter to a Java Timestamp value.voidsetTIMESTAMPAtName(String parameterName, TIMESTAMP value) Sets the designated parameter to anoracle.sql.TIMESTAMPvalue.voidsetTIMESTAMPLTZ(int parameterIndex, TIMESTAMPLTZ x) Binds the designated parameter to anoracle.sql.TIMESTAMPLTZvalue.voidsetTIMESTAMPLTZAtName(String parameterName, TIMESTAMPLTZ value) Sets the designated parameter to anoracle.sql.TIMESTAMPLTZvalue.voidsetTIMESTAMPTZ(int parameterIndex, TIMESTAMPTZ x) Binds the designated parameter to anoracle.sql.TIMESTAMPTZvalue.voidsetTIMESTAMPTZAtName(String parameterName, TIMESTAMPTZ value) Sets the designated parameter to anoracle.sql.TIMESTAMPTZvalue.voidsetUnicodeStreamAtName(String parameterName, InputStream stream, int length) Sets the designated parameter to a Java UnicodeStream value.voidsetURLAtName(String parameterName, URL value) Sets the designated parameter to a Java URL value.Methods inherited from interface oracle.jdbc.OracleCommonPreparedStatement
executeAsyncOracle, executeBatchAsyncOracle, executeUpdateAsyncOracleMethods inherited from interface oracle.jdbc.OracleCommonStatement
continueOnErrorMethods inherited from interface oracle.jdbc.OracleStatement
clearDefines, closeOnCompletion, closeWithKey, creationState, defineColumnType, defineColumnType, defineColumnType, defineColumnType, defineColumnTypeBytes, defineColumnTypeChars, enquoteIdentifier, enquoteLiteral, enquoteNCharLiteral, getLobPrefetchSize, getRegisteredQueryId, getRegisteredTableNames, getRowPrefetch, getSqlId, isNCHAR, isSimpleIdentifier, setDatabaseChangeRegistration, setEscapeProcessing, setLobPrefetchSize, setRowPrefetchMethods inherited from interface java.sql.PreparedStatement
addBatch, clearParameters, execute, executeLargeUpdate, 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, setObject, setObject, setRef, setRowId, setShort, setSQLXML, setString, setTime, setTime, setTimestamp, setTimestamp, setUnicodeStream, setURLMethods inherited from interface java.sql.Statement
addBatch, cancel, clearBatch, clearWarnings, close, execute, execute, execute, execute, executeBatch, executeLargeBatch, executeLargeUpdate, executeLargeUpdate, executeLargeUpdate, executeLargeUpdate, executeQuery, executeUpdate, executeUpdate, executeUpdate, executeUpdate, getConnection, getFetchDirection, getFetchSize, getGeneratedKeys, getLargeMaxRows, getLargeUpdateCount, getMaxFieldSize, getMaxRows, getMoreResults, getMoreResults, getQueryTimeout, getResultSet, getResultSetConcurrency, getResultSetHoldability, getResultSetType, getUpdateCount, getWarnings, isClosed, isCloseOnCompletion, isPoolable, setCursorName, setFetchDirection, setFetchSize, setLargeMaxRows, setMaxFieldSize, setMaxRows, setPoolable, setQueryTimeoutMethods inherited from interface java.sql.Wrapper
isWrapperFor, unwrap
-
Field Details
-
FORM_NCHAR
static final short FORM_NCHARSpecifies the "form of use" for SQL NCHAR datatypes (NCHAR, NVARCHAR2 and NCLOB). It is used only in the argument tosetFormOfUse().- See Also:
-
FORM_CHAR
static final short FORM_CHARSpecifies the "form of use" for SQL CHAR datatypes (CHAR, VARCHAR2 and CLOB). It is used only in the argument tosetFormOfUse().- See Also:
-
-
Method Details
-
defineParameterTypeBytes
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 thesetXXXcall, 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.CHARas the type value if you are going bind later assetCHARand useOracleTypes.VARCHARif you are going to bind assetStringfor 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
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 thesetXXXcall, 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.CHARas the type value if you are going bind later assetCHARand useOracleTypes.VARCHARif you are going to bind assetStringfor 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
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
default 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:
-
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.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
Binds the designated parameter to aoracle.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
Binds the designated parameter to aoracle.sql.BFILEvalue.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
Binds the designated parameter to aoracle.sql.BFILEvalue.Note: An instance of the
oracle.sql.BFILEclass 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
OraclePreparedStatementobjectopsto 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 validoracle.sql.BFILEobject (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 theBFILEclass 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
Binds the designated parameter to aoracle.sql.BLOBvalue.Note: An instance of the
oracle.sql.BLOBclass 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
OraclePreparedStatementobjectopsand a BLOB namedmy_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 methodBLOB.getBinaryOutputStreamto 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
Binds the designated parameter to aoracle.sql.CHARvalue.setCHARchecks 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,
setCHARwill 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:
-
setCLOB
Binds the designated parameter to aoracle.sql.CLOBvalue.Note: An instance of the
oracle.sql.CLOBclass 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
OraclePreparedStatementobjectopsand a CLOB namedmy_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 methodsCLOB.getCharacterOutputStreamorCLOB.getAsciiOutputStreamto 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
Deprecated.Binds the designated parameter to ajava.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:
-
setCustomDatum
Deprecated.Binds the designated parameter to aoracle.sql.CustomDatumvalue.In the 9i release the
oracle.sql.CustomDatumhas been deprecated and replaced by theoracle.sql.ORADatainterface. For this reason, this method is also deprecated. It is recommended to usesetORAData()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
Binds the designated parameter to aoracle.sql.ORADatavalue.- 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
Binds the designated parameter to aoracle.sql.DATEvalue.- Parameters:
parameterIndex- the first parameter is 1, the second is 2, ...date- the parameter value- Throws:
SQLException- if a database access error occurs
-
setExecuteBatch
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- ifbatchValueis less than 1 (never thrown).- See Also:
-
setFixedCHAR
Sets the designated parameter to aStringand 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 theWHEREclause of aSELECTstatement--the character data in theWHEREclause must also be padded to the column width to produce a match in theSELECTstatement. 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
OraclePreparedStatementto use thesetFixedCHAR()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()andsetFixedCHAR()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:
- Remember to cast your prepared statement object to
-
setNUMBER
Binds the designated parameter to aoracle.sql.NUMBERvalue.- Parameters:
parameterIndex- the first parameter is 1, the second is 2, ...num- the parameter value- Throws:
SQLException- if a database access error occurs
-
setBinaryFloat
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 a 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 a 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
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
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 a 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 a 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
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
Binds the designated parameter to aoracle.sql.OPAQUEvalue.- Parameters:
parameterIndex- the first parameter is 1, the second is 2, ...val- the parameter value- Throws:
SQLException- if a database access error occurs
-
setOracleObject
Binds the designated parameter to aoracle.sql.Datumvalue.This is a generic
setXXX()method for bindingoracle.sql.data into a prepared statement as anoracle.sql.Datumobject.- Parameters:
parameterIndex- the first parameter is 1, the second is 2, ...x- the parameter value- Throws:
SQLException- if a database access error occurs
-
setStructDescriptor
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
Binds the designated parameter to aoracle.sql.RAWvalue.- Parameters:
parameterIndex- the first parameter is 1, the second is 2, ...raw- the parameter value- Throws:
SQLException- if a database access error occurs
-
setREF
Binds the designated parameter to aoracle.sql.REFvalue.- Parameters:
parameterIndex- the first parameter is 1, the second is 2, ...ref- the parameter value- Throws:
SQLException- if a database access error occurs
-
setRefType
Binds the designated parameter to aoracle.sql.REFvalue.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:
-
setROWID
Binds the designated parameter to aoracle.sql.ROWIDvalue.- Parameters:
parameterIndex- the first parameter is 1, the second is 2, ...rowid- the parameter value- Throws:
SQLException- if a database access error occurs
-
setSTRUCT
Binds the designated parameter to aoracle.sql.STRUCTvalue.- Parameters:
parameterIndex- the first parameter is 1, the second is 2, ...struct- the parameter value- Throws:
SQLException- if a database access error occurs
-
setTIMESTAMP
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
Binds the designated parameter to anoracle.sql.TIMESTAMPTZvalue.- Parameters:
parameterIndex- specifies the parameter index. Index starts from 1.x- specifies the parameter value.- Throws:
SQLException- if an error occurs- Since:
- 9i
-
setTIMESTAMPLTZ
Binds the designated parameter to anoracle.sql.TIMESTAMPLTZvalue.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
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
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
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
Sets the designated parameter to a SQL NULL value.- Parameters:
parameterName-sqlType-- Throws:
SQLException- if a database access error occurs
-
setBooleanAtName
Sets the designated parameter to a Java Boolean value.- Parameters:
parameterName-value- the parameter value- Throws:
SQLException- if a database access error occurs
-
setByteAtName
Sets the designated parameter to a Java Byte value.- Parameters:
parameterName-value- the parameter value- Throws:
SQLException- if a database access error occurs
-
setShortAtName
Sets the designated parameter to a Java Short value.- Parameters:
parameterName-value- the parameter value- Throws:
SQLException- if a database access error occurs
-
setIntAtName
Sets the designated parameter to a Java Int value.- Parameters:
parameterName-value- the parameter value- Throws:
SQLException- if a database access error occurs
-
setLongAtName
Sets the designated parameter to a Java Long value.- Parameters:
parameterName-value- the parameter value- Throws:
SQLException- if a database access error occurs
-
setFloatAtName
Sets the designated parameter to a Java Float value.- Parameters:
parameterName-value- the parameter value- Throws:
SQLException- if a database access error occurs
-
setDoubleAtName
Sets the designated parameter to a Java Double value.- Parameters:
parameterName-value- the parameter value- Throws:
SQLException- if a database access error occurs
-
setBinaryFloatAtName
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
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
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
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
Sets the designated parameter to a Java BigDecimal value.- Parameters:
parameterName-value- the parameter value- Throws:
SQLException- if a database access error occurs
-
setStringAtName
Sets the designated parameter to a Java String value.- Parameters:
parameterName-value- the parameter value- Throws:
SQLException- if a database access error occurs
-
setStringForClob
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
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
Sets the designated parameter to a Java FixedCHAR value.- Parameters:
parameterName-value- the parameter value- Throws:
SQLException- if a database access error occurs
-
setCursorAtName
Sets the designated parameter to a Java Cursor value.- Parameters:
parameterName-value- the parameter value- Throws:
SQLException- if a database access error occurs
-
setROWIDAtName
Sets the designated parameter to anoracle.sql.ROWIDvalue.- Parameters:
parameterName-value- the parameter value- Throws:
SQLException- if a database access error occurs
-
setArrayAtName
Sets the designated parameter to a Java Array value.- Parameters:
parameterName-value- the parameter value- Throws:
SQLException- if a database access error occurs
-
setARRAYAtName
Sets the designated parameter to aoracle.sql.ARRAYvalue.- Parameters:
parameterName-value- the parameter value- Throws:
SQLException- if a database access error occurs
-
setOPAQUEAtName
Sets the designated parameter to anoracle.sql.OPAQUEvalue.- Parameters:
parameterName-value- the parameter value- Throws:
SQLException- if a database access error occurs
-
setStructDescriptorAtName
Sets the designated parameter to anoracle.sql.StructDescriptorvalue.- Parameters:
parameterName-desc- the StructDescriptor to bind- Throws:
SQLException- if a database access error occurs
-
setSTRUCTAtName
Sets the designated parameter to anoracle.sql.STRUCTvalue.- Parameters:
parameterName-value- the parameter value- Throws:
SQLException- if a database access error occurs
-
setRAWAtName
Sets the designated parameter to anoracle.sql.RAWvalue.- Parameters:
parameterName-value- the parameter value- Throws:
SQLException- if a database access error occurs
-
setCHARAtName
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
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
Sets the designated parameter to anoracle.sql.NUMBERvalue.- Parameters:
parameterName-value- the parameter value- Throws:
SQLException- if a database access error occurs
-
setBLOBAtName
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
Sets the designated parameter to a Java Blob value.- Parameters:
parameterName-value- the parameter value- Throws:
SQLException- if a database access error occurs
-
setBlobAtName
Sets the designated parameter to a stream value.- Parameters:
parameterName-stream- the stream from which to read the valuelength- the number of bytes to read- Throws:
SQLException- if a database access error occurs
-
setBlobAtName
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
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
Sets the designated parameter to a Java Clob value.- Parameters:
parameterName-value- the parameter value- Throws:
SQLException- if a database access error occurs
-
setClobAtName
Sets the designated parameter to a stream value.- Parameters:
parameterName-reader- the Reader from which to get the valuelength- the number of bytes to read- Throws:
SQLException- if a database access error occurs
-
setClobAtName
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
Sets the designated parameter to aoracle.sql.BFILEvalue.- Parameters:
parameterName-value- the parameter value- Throws:
SQLException- if a database access error occurs
-
setBfileAtName
Sets the designated parameter to aoracle.sql.BFILEvalue.- Parameters:
parameterName-value- the parameter value- Throws:
SQLException- if a database access error occurs
-
setBytesAtName
Sets the designated parameter to a Java Bytes value.- Parameters:
parameterName-value- the parameter value- Throws:
SQLException- if a database access error occurs
-
setBytesForBlob
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
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
Sets the designated parameter to a Java Date value.- Parameters:
parameterName-value- the parameter value- Throws:
SQLException- if a database access error occurs
-
setDateAtName
Sets the designated parameter to a Java Date value.- Parameters:
parameterName-value- the parameter valuecal- the calendar to interpret the date- Throws:
SQLException- if a database access error occurs
-
setTimeAtName
Sets the designated parameter to a Java Time value.- Parameters:
parameterName-value- the parameter value- Throws:
SQLException- if a database access error occurs
-
setTimeAtName
Sets the designated parameter to a Java Time value.- Parameters:
parameterName-value- the parameter valuecal- the Calendar to use to interpret the value- Throws:
SQLException- if a database access error occurs
-
setTimestampAtName
Sets the designated parameter to a Java Timestamp value.- Parameters:
parameterName-value- the parameter value- Throws:
SQLException- if a database access error occurs
-
setTimestampAtName
Sets the designated parameter to a Java Timestamp value.- Parameters:
parameterName-value- the parameter valuecal- the Calendar to use to interpret the date- Throws:
SQLException- if a database access error occurs
-
setINTERVALYMAtName
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
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
Sets the designated parameter to anoracle.sql.TIMESTAMPvalue.- Parameters:
parameterName-value- the parameter value- Throws:
SQLException- if a database access error occurs
-
setTIMESTAMPTZAtName
Sets the designated parameter to anoracle.sql.TIMESTAMPTZvalue.- Parameters:
parameterName-value- the parameter value- Throws:
SQLException- if a database access error occurs
-
setTIMESTAMPLTZAtName
Sets the designated parameter to anoracle.sql.TIMESTAMPLTZvalue.- Parameters:
parameterName-value- the parameter value- Throws:
SQLException- if a database access error occurs
-
setAsciiStreamAtName
Sets the designated parameter to a Java AsciiStream value.- Parameters:
parameterName-stream- the stream valuelength-- 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 valuelength-- Throws:
SQLException- if a database access error occurs
-
setAsciiStreamAtName
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
Sets the designated parameter to a Java BinaryStream value.- Parameters:
parameterName-stream-- Throws:
SQLException- if a database access error occurs
-
setCharacterStreamAtName
Sets the designated parameter to a Java CharacterStream value.- Parameters:
parameterName-reader-length-- Throws:
SQLException- if a database access error occurs
-
setCharacterStreamAtName
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
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
Sets the designated parameter to anoracle.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 valuetargetSqlType-scale-- Throws:
SQLException- if a database access error occurs
-
setObjectAtName
Sets the designated parameter to a Java Object value.- Parameters:
parameterName-value- the parameter valuetargetSqlType-- Throws:
SQLException- if a database access error occurs
-
setRefTypeAtName
Sets the designated parameter to anoracle.sql.REFvalue.- Parameters:
parameterName-value- the parameter value- Throws:
SQLException- if a database access error occurs
-
setRefAtName
Sets the designated parameter to a Java Ref value.- Parameters:
parameterName-value- the parameter value- Throws:
SQLException- if a database access error occurs
-
setREFAtName
Sets the designated parameter to anoracle.sql.REFvalue.- Parameters:
parameterName-value- the parameter value- Throws:
SQLException- if a database access error occurs
-
setObjectAtName
Sets the designated parameter to a Java Object value.- Parameters:
parameterName-value- the parameter value- Throws:
SQLException- if a database access error occurs
-
setOracleObjectAtName
Sets the designated parameter to anoracle.sql.Datumvalue.- Parameters:
parameterName-value- the parameter value- Throws:
SQLException- if a database access error occurs
-
setURLAtName
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 indicate 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_CHARfor SQL CHAR datatypes andFORM_NCHARfor SQL NCHAR datatypes, whereFORM_CHARis the default. If the "form of use" is set toFORM_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, andCLOB) 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 theoracle.sqlpackage for SQL NCHAR datatypes. Likewise, there is no separate, corresponding constant defined in theoracle.jdbc.OracleTypesclass for SQL NCHAR datatypes. The only difference in usage between the two datatypes occur in a data bind situation: a JDBC program must call thesetFormOfUse()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()andregisterOutParameter()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 preparedStatmentformOfUse- 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
Retrieves the number, types and properties of thisPreparedStatementobject's parameters.- Returns:
- an
OracleParameterMetaDataobject that contains information about the number, types and properties of thisPreparedStatementobject's parameters - Throws:
SQLException- if a database access error occurs- Since:
- 9.0.2
- See Also:
-
registerReturnParameter
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
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 parametermaxSize- Max bytes or chars of return parameter- Throws:
SQLException- if an error occurs- Since:
- 10.2
-
registerReturnParameter
Registers return parameter for DML Returning.- Parameters:
paramIndex- Index of return parameter (should be > 0)externalType- Type of return parametertypeName- The fully-qualified name of an SQL structured type- Throws:
SQLException- if an error occurs- Since:
- 10.2
-
getReturnResultSet
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
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
Sets the designated parameter to ajava.sql.NClobvalue.- Parameters:
parameterName-value- the parameter value- Throws:
SQLException- if a database access error occurs
-
setNClobAtName
Sets the designated parameter to ajava.sql.NClobvalue.- Parameters:
parameterName-reader- the Reader from which to get the valuelength- the number of characters to read- Throws:
SQLException- if a database access error occurs
-
setNClobAtName
Sets the designated parameter to ajava.sql.NClobvalue.- Parameters:
parameterName-reader- the Reader from which to get the value- Throws:
SQLException- if a database access error occurs
-
setNStringAtName
Sets the designated parameter to ajava.sql.Stringvalue using the NCHAR character set- Parameters:
parameterName-value- the parameter value- Throws:
SQLException- if a database access error occurs
-
setRowIdAtName
Sets the designated parameter to ajava.sql.RowIdvalue.- Parameters:
parameterName-value- the parameter value- Throws:
SQLException- if a database access error occurs
-
setSQLXMLAtName
Sets the designated parameter to ajava.sql.SQLXMLvalue.- Parameters:
parameterName-value- the parameter value- Throws:
SQLException- if a database access error occurs
-
executeQueryAsyncOracle
Executes the SQL query in this
PreparedStatementobject asynchronously and returns aPublisherwhich publishes a singleResultSetcontaining the rows produced.If the query produces an error or if the query does not produce a set of rows, the
PublishercallsonErrorwith aSQLExceptioncorresponding to the error.The returned
PublishercallsonErrorwith aSQLTimeoutExceptionwhen the driver has determined that the timeout value that was specified by thesetQueryTimeoutmethod has been exceeded and has at least attempted to cancel the currently runningStatement. It callsonErrorwithSQLExceptionif a database access error occurs.Calling any method of this
PreparedStatementexceptcancel,isClosed, or one defined byObjectafter this method is called will block until the returnedPublishercallsonCompleteoronError.Oracle JDBC implements this
OracleCommonPreparedStatementmethod to publish an instance ofOracleResultSet.- Specified by:
executeQueryAsyncOraclein interfaceOracleCommonPreparedStatement- Returns:
- a
Publisherof theResultSet - Throws:
SQLException- if a database access error occurs; this method is called on a closedPreparedStatementor the implementation detects that the SQL statement does not return aResultSetobject
-
executeUpdateAndSuspend
Executes the SQL statement in thisPreparedStatementobject, which must be an SQL Data Manipulation Language (DML) statement, such asINSERT,UPDATEorDELETE; or an SQL statement that returns nothing, such as a DDL statement. Then suspends any active sessionless transaction in the current session. This offers an alternative to separately callingPreparedStatement.executeUpdate()followed byOracleConnection.suspendTransactionImmediately(), allowing them to be combined into a single round-trip. If either the executeUpdate or suspend operations throws an exception, both operations fail. If no transaction is active the suspend operation is a no-op.- Returns:
- either (1) the row count for SQL Data Manipulation Language (DML) statements or (2) 0 for SQL statements that return nothing.
- Throws:
SQLException
-