Interface OracleCallableStatement
-
- All Superinterfaces:
java.lang.AutoCloseable,java.sql.CallableStatement,OracleCommonPreparedStatement,OracleCommonStatement,OraclePreparedStatement,OracleStatement,java.sql.PreparedStatement,java.sql.Statement,java.sql.Wrapper
public interface OracleCallableStatement extends java.sql.CallableStatement, OraclePreparedStatement
This interface extends theOraclePreparedStatement(which extends theOracleStatementinterface) and incorporates standard JDBC callable statement functionality. It is used to execute SQL stored procedure.Oracle JDBC drivers support execution of PL/SQL stored procedures and anonymous blocks. They support both SQL92 escape syntax and Oracle PL/SQL block syntax. The following PL/SQL calls would work with any Oracle JDBC driver:
// SQL92 syntax CallableStatement cs1 = conn.prepareCall ( "{call proc (?,?)}" ) ; // stored proc CallableStatement cs2 = conn.prepareCall ( "{? = call func (?,?)}" ) ; // stored func // Oracle PL/SQL block syntax CallableStatement cs3 = conn.prepareCall ( "begin proc (?,?); end;" ) ; // stored proc CallableStatement cs4 = conn.prepareCall ( "begin ? := func(?,?); end;" ) ; // stored funcAs an example of using Oracle syntax, here is a PL/SQL code snippet that creates a stored function. The PL/SQL function gets a character sequence and concatenates a suffix to it:
create or replace function foo (val1 char) return char as begin return val1 || 'suffix'; end;
Your invocation call in your JDBC program should look like:
Connection conn = DriverManager.getConnection ("jdbc:oracle:oci8:@<hoststring>", "scott", "tiger"); CallableStatement cs = conn.prepareCall ("begin ? := foo(?); end;"); cs.registerOutParameter(1,Types.CHAR); cs.setString(2, "aa"); cs.executeUpdate(); String result = cs.getString(1);- Since:
- 8.1.7
- See Also:
Connection.prepareCall(String)
-
-
Field Summary
-
Fields inherited from interface oracle.jdbc.OraclePreparedStatement
FORM_CHAR, FORM_NCHAR
-
Fields inherited from interface oracle.jdbc.OracleStatement
EXPLICIT, IMPLICIT, NEW
-
-
Method Summary
All Methods Instance Methods Abstract Methods Deprecated Methods Modifier and Type Method Description java.lang.ObjectgetAnyDataEmbeddedObject(int parameterIndex)Deprecated.As of Oracle 11R1 there is full support for ANYTYPE and ANYDATA.ARRAYgetARRAY(int parameterIndex)Retrieves data into anoracle.sql.ARRAYobject.java.io.InputStreamgetAsciiStream(int parameterIndex)Retrieves data into anjava.io.InputStreamobject.BFILEgetBfile(int parameterIndex)Retrieves data into anoracle.sql.BFILEobject.BFILEgetBFILE(int parameterIndex)Retrieves data into anoracle.sql.BFILEobject.java.io.InputStreamgetBinaryStream(int parameterIndex)Retrieves data into anjava.io.InputStreamobject.java.io.InputStreamgetBinaryStream(java.lang.String parameterName)Retrieves data into anjava.io.InputStreamobject.BLOBgetBLOB(int parameterIndex)Retrieves data into anoracle.sql.BLOBobject.CHARgetCHAR(int parameterIndex)Retrieves data into anoracle.sql.CHARobject.java.io.ReadergetCharacterStream(int parameterIndex)Retrieves data into anjava.io.Readerobject.CLOBgetCLOB(int parameterIndex)Retrieves data into anoracle.sql.CLOBobject.java.sql.ResultSetgetCursor(int parameterIndex)Retrieves data into anjava.sql.ResultSetobject.java.lang.ObjectgetCustomDatum(int parameterIndex, CustomDatumFactory factory)Deprecated.DATEgetDATE(int parameterIndex)Retrieves data into anoracle.sql.DATEobject.INTERVALDSgetINTERVALDS(int parameterIndex)Retrieves data into anoracle.sql.INTERVALDSobject.INTERVALYMgetINTERVALYM(int parameterIndex)Retrieves data into anoracle.sql.INTERVALYMobject.NUMBERgetNUMBER(int parameterIndex)Retrieves data into anoracle.sql.NUMBERobject.java.lang.ObjectgetObject(int parameterIndex, OracleDataFactory factory)Returns an instance ofOracleData, which is returned by the factory's "create" methodOPAQUEgetOPAQUE(int parameterIndex)Retrieves data into anoracle.sql.OPAQUEobject.DatumgetOracleObject(int parameterIndex)Retrieves data into anoracle.sql.Datumobject.Datum[]getOraclePlsqlIndexTable(int paramIndex)Deprecated.since 18.1 Use java.sql.CallableStatement.getObject(int parameterIndex) method.java.lang.ObjectgetORAData(int parameterIndex, ORADataFactory factory)java.lang.ObjectgetPlsqlIndexTable(int paramIndex)Deprecated.since 18.1.java.lang.ObjectgetPlsqlIndexTable(int paramIndex, java.lang.Class<?> primitiveType)Deprecated.since 18.1.RAWgetRAW(int parameterIndex)Retrieves data into anoracle.sql.RAWobject.REFgetREF(int parameterIndex)Retrieves data into anoracle.sql.REFobject.ROWIDgetROWID(int parameterIndex)Retrieves data into anoracle.sql.ROWIDobject.STRUCTgetSTRUCT(int parameterIndex)Retrieves data into anoracle.sql.STRUCTobject.TIMESTAMPgetTIMESTAMP(int paramIdx)Retrieves data into anoracle.sql.TIMESTAMPobject.TIMESTAMPLTZgetTIMESTAMPLTZ(int paramIdx)Retrieves data into anoracle.sql.TIMESTAMPLTZobject.TIMESTAMPTZgetTIMESTAMPTZ(int paramIdx)Retrieves data into anoracle.sql.TIMESTAMPTZobject.java.io.InputStreamgetUnicodeStream(int parameterIndex)Retrieves data into anjava.io.InputStreamobject.java.io.InputStreamgetUnicodeStream(java.lang.String parameterName)Retrieves data into anjava.io.InputStreamobject.voidregisterIndexTableOutParameter(int paramIndex, int maxLen, int elemSqlType, int elemMaxLen)Deprecated.since 18.1.voidregisterOutParameter(int paramIndex, int sqlType, int scale, int maxLength)Special Oracle version of registerOutParameter for registering CHAR, VARCHAR, LONG, RAW and LONG RAW columns.voidregisterOutParameter(java.lang.String parameterName, int sqlType, int scale, int maxLength)Special Oracle version of registerOutParameter for registering CHAR, VARCHAR, LONG, RAW and LONG RAW columns.voidregisterOutParameterAtName(java.lang.String parameterMarkerName, int sqlType)Special Oracle method to registerOutParameter by the parameterMarkerName of oracle style parameter markers instead of parameterIndex.voidregisterOutParameterAtName(java.lang.String parameterMarkerName, int sqlType, int scale)Special Oracle method to registerOutParameter by the parameterMarkerName of oracle style parameter markers instead of parameterIndex.voidregisterOutParameterAtName(java.lang.String parameterMarkerName, int sqlType, java.lang.String typeName)Special Oracle method to registerOutParameter by the parameterMarkerName of oracle style parameter markers instead of parameterIndex.voidregisterOutParameterBytes(int paramIndex, int sqlType, int scale, int maxLength)Deprecated.As of Oracle 10g Release 1 all character values are measured in Java chars so this method is no longer supported.voidregisterOutParameterChars(int paramIndex, int sqlType, int scale, int maxLength)Deprecated.As of Oracle 10g Release 1 all character values are measured in Java chars so this method is no longer needed.voidsetArray(java.lang.String parameterName, java.sql.Array x)Sets the designated parameter to anjava.sql.Arrayvalue.voidsetARRAY(java.lang.String parameterName, ARRAY x)Sets the designated parameter to anoracle.sql.ARRAYvalue.voidsetAsciiStream(java.lang.String parameterName, java.io.InputStream x, int y)Sets the designated parameter to the given input stream, which will have the specified number of bytes.voidsetBfile(java.lang.String parameterName, BFILE x)Sets the designated parameter to anoracle.sql.BFILEvalue.voidsetBFILE(java.lang.String parameterName, BFILE x)Sets the designated parameter to anoracle.sql.BFILEvalue.voidsetBigDecimal(java.lang.String parameterName, java.math.BigDecimal x)Sets the designated parameter to the givenjava.math.BigDecimalvalue.voidsetBinaryDouble(java.lang.String parameterName, double x)Sets the designated parameter to the givenoracle.sql.BINARY_FLOATvalue.voidsetBinaryDouble(java.lang.String parameterName, BINARY_DOUBLE x)Sets the designated parameter to the givenoracle.sql.BINARY_FLOATvalue.voidsetBinaryFloat(java.lang.String parameterName, float x)Sets the designated parameter to the given Javafloatvalue.voidsetBinaryFloat(java.lang.String parameterName, BINARY_FLOAT x)Sets the designated parameter to the givenoracle.sql.BINARY_FLOATvalue.voidsetBinaryStream(java.lang.String parameterName, java.io.InputStream x, int y)Sets the designated parameter to the given input stream, which will have the specified number of bytes.voidsetBlob(java.lang.String parameterName, java.sql.Blob x)Sets the designated parameter to anjava.sql.Blobvalue.voidsetBLOB(java.lang.String parameterName, BLOB x)Sets the designated parameter to anoracle.sql.BLOBvalue.voidsetBoolean(java.lang.String parameterName, boolean x)Sets the designated parameter to the given Javabooleanvalue.voidsetByte(java.lang.String parameterName, byte x)Sets the designated parameter to the given Javabytevalue.voidsetBytes(java.lang.String parameterName, byte[] x)Sets the designated parameter to the given Java array of bytes.voidsetBytesForBlob(java.lang.String parameterName, byte[] x)Sets the designated parameter to the given Javabyte[]value.voidsetCHAR(java.lang.String parameterName, CHAR x)Sets the designated parameter to anoracle.sql.CHARvalue.voidsetCharacterStream(java.lang.String parameterName, java.io.Reader x, int y)Sets the designated parameter to the givenReaderobject, which is the given number of characters long.voidsetClob(java.lang.String parameterName, java.sql.Clob x)Sets the designated parameter to anjava.sql.Clobvalue.voidsetCLOB(java.lang.String parameterName, CLOB x)Sets the designated parameter to anoracle.sql.CLOBvalue.voidsetCursor(java.lang.String parameterName, java.sql.ResultSet x)Sets the designated parameter to a Java Cursor value.voidsetCustomDatum(java.lang.String parameterName, CustomDatum x)Sets the designated parameter to anoracle.sql.CustomDatumvalue.voidsetDate(java.lang.String parameterName, java.sql.Date x)Sets the designated parameter to the givenjava.sql.Datevalue.voidsetDate(java.lang.String parameterName, java.sql.Date x, java.util.Calendar cal)Sets the designated parameter to the givenjava.sql.Datevalue, using the givenCalendarobject.voidsetDATE(java.lang.String parameterName, DATE x)Sets the designated parameter to anoracle.sql.DATEvalue.voidsetDouble(java.lang.String parameterName, double x)Sets the designated parameter to the given Javadoublevalue.voidsetFixedCHAR(java.lang.String parameterName, java.lang.String x)Sets the designated parameter to aStringSee the javadoc for the setFixedChar(int, String) method in OraclePreparedStatement.voidsetFloat(java.lang.String parameterName, float x)Sets the designated parameter to the given Javafloatvalue.voidsetInt(java.lang.String parameterName, int x)Sets the designated parameter to the given Javaintvalue.voidsetINTERVALDS(java.lang.String parameterName, INTERVALDS x)Sets the designated parameter to anoracle.sql.INTERVALDSvalue.voidsetINTERVALYM(java.lang.String parameterName, INTERVALYM x)Sets the designated parameter to anoracle.sql.INTERVALYMvalue.voidsetLong(java.lang.String parameterName, long x)Sets the designated parameter to the given Javalongvalue.voidsetNull(java.lang.String parameterName, int sqlType)Sets the designated parameter to SQLNULL.voidsetNull(java.lang.String parameterName, int sqlType, java.lang.String typeName)Sets the designated parameter to SQLNULL.voidsetNUMBER(java.lang.String parameterName, NUMBER x)Sets the designated parameter to anoracle.sql.NUMBERvalue.voidsetObject(java.lang.String parameterName, java.lang.Object x)Sets the value of the designated parameter with the given object.voidsetObject(java.lang.String parameterName, java.lang.Object x, int y)Sets the value of the designated parameter with the given object.voidsetObject(java.lang.String parameterName, java.lang.Object x, int targetSqlType, int scale)Sets the value of the designated parameter with the given object.voidsetOPAQUE(java.lang.String parameterName, OPAQUE x)Sets the designated parameter to anoracle.sql.OPAQUEvalue.voidsetOracleObject(java.lang.String parameterName, Datum x)Sets the designated parameter to anoracle.sql.Datumvalue.voidsetORAData(java.lang.String parameterName, ORAData x)Sets the designated parameter to anoracle.sql.ORADatavalue.voidsetRAW(java.lang.String parameterName, RAW x)Sets the designated parameter to anoracle.sql.RAWvalue.voidsetRef(java.lang.String parameterName, java.sql.Ref x)Sets the designated parameter to anjdbc.sql.Refvalue.voidsetREF(java.lang.String parameterName, REF x)Sets the designated parameter to anoracle.sql.REFvalue.voidsetRefType(java.lang.String parameterName, REF x)Sets the designated parameter to anoracle.sql.REFvalue.voidsetROWID(java.lang.String parameterName, ROWID x)Sets the designated parameter to anoracle.sql.ROWIDvalue.voidsetShort(java.lang.String parameterName, short x)Sets the designated parameter to the given Javashortvalue.voidsetString(java.lang.String parameterName, java.lang.String x)Sets the designated parameter to the given JavaStringvalue.voidsetStringForClob(java.lang.String parameterName, java.lang.String x)Sets the designated parameter to the given JavaStringvalue.voidsetSTRUCT(java.lang.String parameterName, STRUCT x)Sets the designated parameter to anoracle.sql.STRUCTvalue.voidsetStructDescriptor(java.lang.String parameterName, StructDescriptor x)voidsetTime(java.lang.String parameterName, java.sql.Time x)Sets the designated parameter to the givenjava.sql.Timevalue.voidsetTime(java.lang.String parameterName, java.sql.Time x, java.util.Calendar cal)Sets the designated parameter to the givenjava.sql.Timevalue, using the givenCalendarobject.voidsetTimestamp(java.lang.String parameterName, java.sql.Timestamp x)Sets the designated parameter to the givenjava.sql.Timestampvalue.voidsetTimestamp(java.lang.String parameterName, java.sql.Timestamp x, java.util.Calendar cal)Sets the designated parameter to the givenjava.sql.Timestampvalue, using the givenCalendarobject.voidsetTIMESTAMP(java.lang.String parameterName, TIMESTAMP x)Sets the designated parameter to anoracle.sql.TIMESTAMPvalue.voidsetTIMESTAMPLTZ(java.lang.String parameterName, TIMESTAMPLTZ x)Sets the designated parameter to anoracle.sql.TIMESTAMPLTZvalue.voidsetTIMESTAMPTZ(java.lang.String parameterName, TIMESTAMPTZ x)Sets the designated parameter to anoracle.sql.TIMESTAMPTZvalue.voidsetUnicodeStream(java.lang.String parameterName, java.io.InputStream x, int y)Sets the designated parameter to a Java UnicodeStream value.voidsetURL(java.lang.String parameterName, java.net.URL x)Sets the designated parameter to the givenjava.net.URLobject.-
Methods inherited from interface java.sql.CallableStatement
getArray, getArray, getBigDecimal, getBigDecimal, getBigDecimal, getBlob, getBlob, getBoolean, getBoolean, getByte, getByte, getBytes, getBytes, getCharacterStream, getClob, getClob, getDate, getDate, getDate, getDate, getDouble, getDouble, getFloat, getFloat, getInt, getInt, getLong, getLong, getNCharacterStream, getNCharacterStream, getNClob, getNClob, getNString, getNString, getObject, getObject, getObject, getObject, getObject, getObject, getRef, getRef, getRowId, getRowId, getShort, getShort, getSQLXML, getSQLXML, getString, getString, getTime, getTime, getTime, getTime, getTimestamp, getTimestamp, getTimestamp, getTimestamp, getURL, getURL, registerOutParameter, registerOutParameter, registerOutParameter, registerOutParameter, registerOutParameter, registerOutParameter, registerOutParameter, registerOutParameter, registerOutParameter, registerOutParameter, registerOutParameter, registerOutParameter, setAsciiStream, setAsciiStream, setBinaryStream, setBinaryStream, setBlob, setBlob, setCharacterStream, setCharacterStream, setClob, setClob, setNCharacterStream, setNCharacterStream, setNClob, setNClob, setNClob, setNString, setObject, setObject, setRowId, setSQLXML, wasNull
-
Methods inherited from interface oracle.jdbc.OracleCommonPreparedStatement
executeAsyncOracle, executeBatchAsyncOracle, executeUpdateAsyncOracle
-
Methods inherited from interface oracle.jdbc.OracleCommonStatement
continueOnError
-
Methods inherited from interface oracle.jdbc.OraclePreparedStatement
defineParameterType, defineParameterTypeBytes, defineParameterTypeChars, executeQueryAsyncOracle, executeUpdateAndSuspend, getExecuteBatch, getReturnResultSet, OracleGetParameterMetaData, registerReturnParameter, registerReturnParameter, registerReturnParameter, sendBatch, setARRAY, setArrayAtName, setARRAYAtName, setAsciiStreamAtName, setAsciiStreamAtName, setAsciiStreamAtName, setBfile, setBFILE, setBfileAtName, setBFILEAtName, setBigDecimalAtName, setBinaryDouble, setBinaryDouble, setBinaryDoubleAtName, setBinaryDoubleAtName, setBinaryFloat, setBinaryFloat, setBinaryFloatAtName, setBinaryFloatAtName, setBinaryStreamAtName, setBinaryStreamAtName, setBinaryStreamAtName, setBLOB, setBlobAtName, setBlobAtName, setBlobAtName, setBLOBAtName, setBooleanAtName, setByteAtName, setBytesAtName, setBytesForBlob, setBytesForBlobAtName, setCHAR, setCharacterStreamAtName, setCharacterStreamAtName, setCHARAtName, setCheckBindTypes, setCLOB, setClobAtName, setClobAtName, setClobAtName, setCLOBAtName, setCursor, setCursorAtName, setCustomDatum, setCustomDatumAtName, setDATE, setDateAtName, setDateAtName, setDATEAtName, setDisableStmtCaching, setDoubleAtName, setExecuteBatch, setFixedCHAR, setFixedCHARAtName, setFloatAtName, setFormOfUse, setIntAtName, setINTERVALDS, setINTERVALDSAtName, setINTERVALYM, setINTERVALYMAtName, setLongAtName, setNCharacterStreamAtName, setNCharacterStreamAtName, setNClobAtName, setNClobAtName, setNClobAtName, setNStringAtName, setNullAtName, setNullAtName, setNUMBER, setNUMBERAtName, setObjectAtName, setObjectAtName, setObjectAtName, setOPAQUE, setOPAQUEAtName, setOracleObject, setOracleObjectAtName, setORAData, setORADataAtName, setPlsqlIndexTable, setRAW, setRAWAtName, setREF, setRefAtName, setREFAtName, setRefType, setRefTypeAtName, setROWID, setRowIdAtName, setROWIDAtName, setShortAtName, setSQLXMLAtName, setStringAtName, setStringForClob, setStringForClobAtName, setSTRUCT, setSTRUCTAtName, setStructDescriptor, setStructDescriptorAtName, setTimeAtName, setTimeAtName, setTIMESTAMP, setTimestampAtName, setTimestampAtName, setTIMESTAMPAtName, setTIMESTAMPLTZ, setTIMESTAMPLTZAtName, setTIMESTAMPTZ, setTIMESTAMPTZAtName, setUnicodeStreamAtName, setURLAtName
-
Methods 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, setRowPrefetch
-
Methods 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, setURL
-
Methods 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, setQueryTimeout
-
-
-
-
Method Detail
-
getARRAY
ARRAY getARRAY(int parameterIndex) throws java.sql.SQLException
Retrieves data into anoracle.sql.ARRAYobject.- Parameters:
parameterIndex- the first parameter is 1, the second is 2, and so on- Returns:
- data into an
ARRAY - Throws:
java.sql.SQLException- if an error occurs (conversion or database-access error)
-
getAsciiStream
java.io.InputStream getAsciiStream(int parameterIndex) throws java.sql.SQLExceptionRetrieves data into anjava.io.InputStreamobject.- Parameters:
parameterIndex- the first parameter is 1, the second is 2, and so on- Returns:
- data into an
java.io.InputStream - Throws:
java.sql.SQLException- if an error occurs (conversion or database-access error)
-
getBFILE
BFILE getBFILE(int parameterIndex) throws java.sql.SQLException
Retrieves data into anoracle.sql.BFILEobject.- Parameters:
parameterIndex- the first parameter is 1, the second is 2, and so on- Returns:
- data into an
oracle.sql.BFILE - Throws:
java.sql.SQLException- if an error occurs (conversion or database-access error)
-
getBfile
BFILE getBfile(int parameterIndex) throws java.sql.SQLException
Retrieves data into anoracle.sql.BFILEobject.- Parameters:
parameterIndex- the first parameter is 1, the second is 2, and so on- Returns:
- data into an
oracle.sql.BFILE - Throws:
java.sql.SQLException- if an error occurs (conversion or database-access error)
-
getBinaryStream
java.io.InputStream getBinaryStream(int parameterIndex) throws java.sql.SQLExceptionRetrieves data into anjava.io.InputStreamobject.- Parameters:
parameterIndex- the first parameter is 1, the second is 2, and so on- Returns:
- data into an
java.io.InputStream - Throws:
java.sql.SQLException- if an error occurs (conversion or database-access error)
-
getBinaryStream
java.io.InputStream getBinaryStream(java.lang.String parameterName) throws java.sql.SQLExceptionRetrieves data into anjava.io.InputStreamobject.- Parameters:
parameterName- the name of the stored procedure formal parameter- Returns:
- data into an
java.io.InputStream - Throws:
java.sql.SQLException- if an error occurs (conversion or database-access error)
-
getBLOB
BLOB getBLOB(int parameterIndex) throws java.sql.SQLException
Retrieves data into anoracle.sql.BLOBobject.- Parameters:
parameterIndex- the first parameter is 1, the second is 2, and so on- Returns:
- data into an
oracle.sql.BLOB - Throws:
java.sql.SQLException- if an error occurs (conversion or database-access error)
-
getCHAR
CHAR getCHAR(int parameterIndex) throws java.sql.SQLException
Retrieves data into anoracle.sql.CHARobject.- Parameters:
parameterIndex- the first parameter is 1, the second is 2, and so on- Returns:
- data into an
oracle.sql.CHAR - Throws:
java.sql.SQLException- if an error occurs (conversion or database-access error)
-
getCharacterStream
java.io.Reader getCharacterStream(int parameterIndex) throws java.sql.SQLExceptionRetrieves data into anjava.io.Readerobject.- Specified by:
getCharacterStreamin interfacejava.sql.CallableStatement- Parameters:
parameterIndex- the first parameter is 1, the second is 2, and so on- Returns:
- data into an
java.io.Reader - Throws:
java.sql.SQLException- if an error occurs (conversion or database-access error)
-
getCLOB
CLOB getCLOB(int parameterIndex) throws java.sql.SQLException
Retrieves data into anoracle.sql.CLOBobject.- Parameters:
parameterIndex- the first parameter is 1, the second is 2, and so on- Returns:
- data into an
oracle.sql.CLOB - Throws:
java.sql.SQLException- if an error occurs (conversion or database-access error)
-
getCursor
java.sql.ResultSet getCursor(int parameterIndex) throws java.sql.SQLExceptionRetrieves data into anjava.sql.ResultSetobject.- Parameters:
parameterIndex- the first parameter is 1, the second is 2, and so on- Returns:
- data into an
java.sql.ResultSet - Throws:
java.sql.SQLException- if an error occurs (conversion or database-access error)
-
getCustomDatum
java.lang.Object getCustomDatum(int parameterIndex, CustomDatumFactory factory) throws java.sql.SQLExceptionDeprecated.- Parameters:
parameterIndex- the first parameter is 1, the second is 2, and so onfactory-- Returns:
- Throws:
java.sql.SQLException- if an error occurs (conversion or database-access error)
-
getORAData
java.lang.Object getORAData(int parameterIndex, ORADataFactory factory) throws java.sql.SQLException- Parameters:
parameterIndex- the first parameter is 1, the second is 2, and so onfactory-- Returns:
- Throws:
java.sql.SQLException- if an error occurs (conversion or database-access error)
-
getObject
java.lang.Object getObject(int parameterIndex, OracleDataFactory factory) throws java.sql.SQLExceptionReturns an instance ofOracleData, which is returned by the factory's "create" method- Parameters:
parameterIndex- the first parameter is 1, the second is 2, and so onfactory-- Returns:
- Throws:
java.sql.SQLException- if an error occurs (conversion or database-access error)
-
getAnyDataEmbeddedObject
java.lang.Object getAnyDataEmbeddedObject(int parameterIndex) throws java.sql.SQLExceptionDeprecated.As of Oracle 11R1 there is full support for ANYTYPE and ANYDATA. Please use oracle.sql.ANYDATA for new code and plan on replacing any use of this method by the next major release. Note that in 11R1 this method is reimplemented using the ANYDATA support and will now also function in all the drivers, not just oci. In the previous implementation it was possible to call registerOutParameter with a sqlType of either oracle.jdbc.OracleTypes.OPAQUE or oracle.jdbc.OracleTypes.STRUCT The new implementation requires the correct type which is OPAQUE.Retrieves data of an embedded object within AnyData- Parameters:
parameterIndex- the first parameter is 1- Returns:
- data depending on the embedded type in AnyData
- Throws:
java.sql.SQLException- if an error occurs (conversion or database-access error)
-
getDATE
DATE getDATE(int parameterIndex) throws java.sql.SQLException
Retrieves data into anoracle.sql.DATEobject.- Parameters:
parameterIndex- the first parameter is 1, the second is 2, and so on- Returns:
- data into an
oracle.sql.DATE - Throws:
java.sql.SQLException- if an error occurs (conversion or database-access error)
-
getNUMBER
NUMBER getNUMBER(int parameterIndex) throws java.sql.SQLException
Retrieves data into anoracle.sql.NUMBERobject.- Parameters:
parameterIndex- the first parameter is 1, the second is 2, and so on- Returns:
- data into an
oracle.sql.NUMBER - Throws:
java.sql.SQLException- if an error occurs (conversion or database-access error)
-
getOPAQUE
OPAQUE getOPAQUE(int parameterIndex) throws java.sql.SQLException
Retrieves data into anoracle.sql.OPAQUEobject.- Parameters:
parameterIndex- the first parameter is 1, the second is 2, and so on- Returns:
- data into an
oracle.sql.OPAQUE - Throws:
java.sql.SQLException- if an error occurs (conversion or database-access error)
-
getOracleObject
Datum getOracleObject(int parameterIndex) throws java.sql.SQLException
Retrieves data into anoracle.sql.Datumobject.- Parameters:
parameterIndex- the first parameter is 1, the second is 2, and so on- Returns:
- data into an
oracle.sql.Datum - Throws:
java.sql.SQLException- if an error occurs (conversion or database-access error)
-
getRAW
RAW getRAW(int parameterIndex) throws java.sql.SQLException
Retrieves data into anoracle.sql.RAWobject.- Parameters:
parameterIndex- the first parameter is 1, the second is 2, and so on- Returns:
- data into an
oracle.sql.RAW - Throws:
java.sql.SQLException- if an error occurs (conversion or database-access error)
-
getREF
REF getREF(int parameterIndex) throws java.sql.SQLException
Retrieves data into anoracle.sql.REFobject.- Parameters:
parameterIndex- the first parameter is 1, the second is 2, and so on- Returns:
- data into an
oracle.sql.REF - Throws:
java.sql.SQLException- if an error occurs (conversion or database-access error)
-
getROWID
ROWID getROWID(int parameterIndex) throws java.sql.SQLException
Retrieves data into anoracle.sql.ROWIDobject.- Parameters:
parameterIndex- the first parameter is 1, the second is 2, and so on- Returns:
- data into an
oracle.sql.ROWID - Throws:
java.sql.SQLException- if an error occurs (conversion or database-access error)
-
getSTRUCT
STRUCT getSTRUCT(int parameterIndex) throws java.sql.SQLException
Retrieves data into anoracle.sql.STRUCTobject.- Parameters:
parameterIndex- the first parameter is 1, the second is 2, and so on- Returns:
- data into an
oracle.sql.STRUCT - Throws:
java.sql.SQLException- if an error occurs (conversion or database-access error)
-
getINTERVALYM
INTERVALYM getINTERVALYM(int parameterIndex) throws java.sql.SQLException
Retrieves data into anoracle.sql.INTERVALYMobject.- Parameters:
parameterIndex- the first parameter is 1, the second is 2, and so on- Returns:
- data into an
oracle.sql.INTERVALYM - Throws:
java.sql.SQLException- if an error occurs (conversion or database-access error)- Since:
- 9i
-
getINTERVALDS
INTERVALDS getINTERVALDS(int parameterIndex) throws java.sql.SQLException
Retrieves data into anoracle.sql.INTERVALDSobject.- Parameters:
parameterIndex- the first parameter is 1, the second is 2, and so on- Returns:
- data into an
oracle.sql.INTERVALDS - Throws:
java.sql.SQLException- if an error occurs (conversion or database-access error)- Since:
- 10i
-
getTIMESTAMP
TIMESTAMP getTIMESTAMP(int paramIdx) throws java.sql.SQLException
Retrieves data into anoracle.sql.TIMESTAMPobject.- Parameters:
paramIdx- the first parameter is 1, the second is 2, and so on- Returns:
- data into an
oracle.sql.TIMESTAMP - Throws:
java.sql.SQLException- if an error occurs (conversion or database-access error)- Since:
- 9i
-
getTIMESTAMPTZ
TIMESTAMPTZ getTIMESTAMPTZ(int paramIdx) throws java.sql.SQLException
Retrieves data into anoracle.sql.TIMESTAMPTZobject.- Parameters:
paramIdx- the first parameter is 1, the second is 2, and so on- Returns:
- data into an
oracle.sql.TIMESTAMPTZ - Throws:
java.sql.SQLException- if an error occurs (conversion or database-access error)- Since:
- 9i
-
getTIMESTAMPLTZ
TIMESTAMPLTZ getTIMESTAMPLTZ(int paramIdx) throws java.sql.SQLException
Retrieves data into anoracle.sql.TIMESTAMPLTZobject.- Parameters:
paramIdx- the first parameter is 1, the second is 2, and so on- Returns:
- data into an
oracle.sql.TIMESTAMPLTZ - Throws:
java.sql.SQLException- if an error occurs (conversion or database-access error)- Since:
- 9i
-
getUnicodeStream
java.io.InputStream getUnicodeStream(int parameterIndex) throws java.sql.SQLExceptionRetrieves data into anjava.io.InputStreamobject.- Parameters:
parameterIndex- the first parameter is 1, the second is 2, and so on- Returns:
- data into an
java.io.InputStream - Throws:
java.sql.SQLException- if an error occurs (conversion or database-access error)
-
getUnicodeStream
java.io.InputStream getUnicodeStream(java.lang.String parameterName) throws java.sql.SQLExceptionRetrieves data into anjava.io.InputStreamobject.- Parameters:
parameterName- the name of the stored procedure formal parameter- Returns:
- data into an
java.io.InputStream - Throws:
java.sql.SQLException- if an error occurs (conversion or database-access error)
-
registerOutParameter
void registerOutParameter(int paramIndex, int sqlType, int scale, int maxLength) throws java.sql.SQLExceptionSpecial Oracle version of registerOutParameter for registering CHAR, VARCHAR, LONG, RAW and LONG RAW columns. Depending on the value of OracleConnection.getDataSizeUnits(), maxLength will be measured in bytes or characters.- Parameters:
paramIndex- parameter index (the first parameter is 1).sqlType- type of the bind parameterscale- not usedmaxLength- maximum length of the column, specified in bytes or characters.- Throws:
java.sql.SQLException- if an error occurs (conversion or database-access error)
-
registerOutParameterBytes
void registerOutParameterBytes(int paramIndex, int sqlType, int scale, int maxLength) throws java.sql.SQLExceptionDeprecated.As of Oracle 10g Release 1 all character values are measured in Java chars so this method is no longer supported. It now is the equivalent of calling registerOutParameter with the same args. Since the number of bytes is at least as large as the number of characters this will always work although it may waste memory. Use registerOutParameter with the number of Java chars instead.Special Oracle version of registerOutParameter for registering CHAR, VARCHAR, LONG, RAW and LONG RAW columns. This version accepts a maxLength parameter measured in bytes.- Parameters:
paramIndex- parameter index (the first parameter is 1).sqlType- type of the bind parameterscale- not usedmaxLength- maximum length of the column, specified in bytes. If not specified, maximum length allowed for that type is used.- Throws:
java.sql.SQLException- if an error occurs (conversion or database-access error)
-
registerOutParameterChars
void registerOutParameterChars(int paramIndex, int sqlType, int scale, int maxLength) throws java.sql.SQLExceptionDeprecated.As of Oracle 10g Release 1 all character values are measured in Java chars so this method is no longer needed. Call registerOutParameter with the same args instead.Special Oracle version of registerOutParameter for registering CHAR, VARCHAR, LONG, RAW and LONG RAW columns. This version accepts a maxLength parameter measured in characters.- Parameters:
paramIndex- parameter index (the first parameter is 1).sqlType- type of the bind parameterscale- not usedmaxLength- maximum length of the column, specified in characters. If not specified, maximum length allowed for that type is used.- Throws:
java.sql.SQLException- if an error occurs (conversion or database-access error)
-
getPlsqlIndexTable
@Deprecated java.lang.Object getPlsqlIndexTable(int paramIndex) throws java.sql.SQLExceptionDeprecated.since 18.1. Use java.sql.CallableStatement.getObject(int parameterIndex) method.Get the value of a PLSQL Associative Array ( formerly known as index-by-table ) parameter as a Java array. The type of the Java array will be the default Java object type corresponding to the element's SQL type, following the mapping for built-in types specified in the JDBC spec.- Parameters:
paramIndex- the first parameter is 1, the second is 2, and so on- Returns:
- A java.lang.Object holding the parameter value.
- Throws:
java.sql.SQLException- if a database-access error occurs.java.sql.SQLException- if an error occurs (conversion or database-access error)- See Also:
registerIndexTableOutParameter(int, int, int, int)
-
getPlsqlIndexTable
@Deprecated java.lang.Object getPlsqlIndexTable(int paramIndex, java.lang.Class<?> primitiveType) throws java.sql.SQLExceptionDeprecated.since 18.1. Use java.sql.CallableStatement.getObject(int parameterIndex, Class<T> type) method.Get the value of a PLSQL Associative Array ( formerly known as index-by-table ) parameter as a primitive array. 'primitiveType' specifies the return array type.- Parameters:
paramIndex- the first parameter is 1, the second is 2, and so onprimitiveType- is a primitive type class. For example,java.lang.Double.Type- Returns:
- A java.lang.Object holding the parameter value.
- Throws:
java.sql.SQLException- if a database-access error occurs.java.sql.SQLException- if an error occurs (conversion or database-access error)- See Also:
registerIndexTableOutParameter(int, int, int, int)
-
getOraclePlsqlIndexTable
@Deprecated Datum[] getOraclePlsqlIndexTable(int paramIndex) throws java.sql.SQLException
Deprecated.since 18.1 Use java.sql.CallableStatement.getObject(int parameterIndex) method.Get the value of a PLSQL Associative Array ( formerly known as index-by-table ) parameter as an oracle.sql.Datum array.- Parameters:
paramIndex- the first parameter is 1, the second is 2, and so on- Returns:
- A Datum array holding the parameter value.
- Throws:
java.sql.SQLException- if a database-access error occurs.java.sql.SQLException- if an error occurs (conversion or database-access error)- See Also:
registerIndexTableOutParameter(int, int, int, int)
-
registerIndexTableOutParameter
@Deprecated void registerIndexTableOutParameter(int paramIndex, int maxLen, int elemSqlType, int elemMaxLen) throws java.sql.SQLExceptionDeprecated.since 18.1. Use java.sql.CallableStatement.registerOutParameter (int parameterIndex, int sqlType, String typeName).Special Oracle version of registerOutParameter for registering a limited form of PL/SQL Associative Array parameters. 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. This API is supported by the oci and thin driver It is also supported by the server side internal driver with a limitation on the element length for string of 1999 characters. For oci and thin this is the same as the database limitation of 32767 characters.- Parameters:
paramIndex- the first parameter is 1, the second is 2, and so onmaxLen- the maximum possible number of elements.elemSqlType- index table element SQL type (as defined in java.sql.Types or OracleTypes).elemMaxLen- maximum length of the element. If not specified, maximum length allowed for that type is used.- Throws:
java.sql.SQLException- if sqlType is invalid, or an error occurred.- Since:
- 8.1.7
-
setBinaryFloat
void setBinaryFloat(java.lang.String parameterName, BINARY_FLOAT x) throws java.sql.SQLExceptionSets the designated parameter to the givenoracle.sql.BINARY_FLOATvalue.- Parameters:
parameterName- the name of the stored procedure formal parameterx- the parameter value- Throws:
java.sql.SQLException- if a database access error occurs- Since:
- 10.0
- See Also:
CallableStatement.getFloat(int)
-
setBinaryDouble
void setBinaryDouble(java.lang.String parameterName, BINARY_DOUBLE x) throws java.sql.SQLExceptionSets the designated parameter to the givenoracle.sql.BINARY_FLOATvalue.- Parameters:
parameterName- name of the stored procedure formal parameterx- the parameter value- Throws:
java.sql.SQLException- if a database access error occurs- Since:
- 10.0
- See Also:
CallableStatement.getDouble(int)
-
setStringForClob
void setStringForClob(java.lang.String parameterName, java.lang.String x) throws java.sql.SQLExceptionSets the designated parameter to the given JavaStringvalue. The driver converts this to an SQLVARCHARorLONGVARCHARvalue (depending on the argument's size relative to the driver's limits onVARCHARvalues) when it sends it to the database. If the string is larger than 32765 it is converted to a temporary clob and that is sent to the database. This clob conversion produces data truncation for columns of typeVARCHARandLONGVARCHAR. This is wrong.- Parameters:
parameterName- the name of the stored procedure formal parameterx- the parameter value- Throws:
java.sql.SQLException- if a database access error occurs- Since:
- 10i Release 1
- See Also:
CallableStatement.getString(int)
-
setBytesForBlob
void setBytesForBlob(java.lang.String parameterName, byte[] x) throws java.sql.SQLExceptionSets the designated parameter to the given Javabyte[]value. The driver converts this to an SQLBINARYorLONGBINARY CHECK THISvalue (depending on the argument's size relative to the driver's limits onVARCHARvalues) when it sends it to the database. If the byte array is larger than 32765 it is converted to a temporary blob and that is sent to the database. This blob conversion produces data truncation for columns of typeBINARY..- Parameters:
parameterName- the name of the stored procedure formal parameterx- the parameter value- Throws:
java.sql.SQLException- if a database access error occurs- Since:
- 10i Release 1
- See Also:
CallableStatement.getString(int)
-
registerOutParameter
void registerOutParameter(java.lang.String parameterName, int sqlType, int scale, int maxLength) throws java.sql.SQLExceptionSpecial Oracle version of registerOutParameter for registering CHAR, VARCHAR, LONG, RAW and LONG RAW columns. Depending on the value of OracleConnection.getDataSizeUnits(), maxLength will be measured in bytes or characters.- Parameters:
parameterName- the name of the parametersqlType- SQL type code defined byjava.sql.Types.scale- the desired number of digits to the right of the decimal point. It must be greater than or equal to zero.maxLength- maximum length of the column, specified in bytes or characters.- Throws:
java.sql.SQLException- if an error occurs (conversion or database-access error)- Since:
- 10i Release 1
-
setNull
void setNull(java.lang.String parameterName, int sqlType, java.lang.String typeName) throws java.sql.SQLExceptionSets the designated parameter to SQLNULL. This version of the methodsetNullshould be used for user-defined types and REF type parameters. Examples of user-defined types include: STRUCT, DISTINCT, JAVA_OBJECT, and named array types.Note: To be portable, applications must give the SQL type code and the fully-qualified SQL type name when specifying a NULL user-defined or REF parameter. In the case of a user-defined type the name is the type name of the parameter itself. For a REF parameter, the name is the type name of the referenced type. If a JDBC driver does not need the type code or type name information, it may ignore it. Although it is intended for user-defined and Ref parameters, this method may be used to set a null parameter of any JDBC type. If the parameter does not have a user-defined or REF type, the given typeName is ignored.
- Specified by:
setNullin interfacejava.sql.CallableStatement- Parameters:
parameterName- the name of the stored procedure formal parametersqlType- a value fromjava.sql.TypestypeName- the fully-qualified name of an SQL user-defined type; ignored if the parameter is not a user-defined type or SQLREFvalue- Throws:
java.sql.SQLException- if a database access error occurs- Since:
- 10i Release 1
-
setNull
void setNull(java.lang.String parameterName, int sqlType) throws java.sql.SQLExceptionSets the designated parameter to SQLNULL.Note: You must specify the parameter's SQL type.
- Specified by:
setNullin interfacejava.sql.CallableStatement- Parameters:
parameterName- the name of the stored procedure formal parametersqlType- the SQL type code defined injava.sql.Types- Throws:
java.sql.SQLException- if a database access error occurs- Since:
- 9.0.2
-
setBoolean
void setBoolean(java.lang.String parameterName, boolean x) throws java.sql.SQLExceptionSets the designated parameter to the given Javabooleanvalue. The driver converts this to an SQLBITvalue when it sends it to the database.- Specified by:
setBooleanin interfacejava.sql.CallableStatement- Parameters:
parameterName- the name of the stored procedure formal parameterx- the parameter value- Throws:
java.sql.SQLException- if a database access error occurs- Since:
- 9.0.2
- See Also:
CallableStatement.getBoolean(int)
-
setByte
void setByte(java.lang.String parameterName, byte x) throws java.sql.SQLExceptionSets the designated parameter to the given Javabytevalue. The driver converts this to an SQLTINYINTvalue when it sends it to the database.- Specified by:
setBytein interfacejava.sql.CallableStatement- Parameters:
parameterName- the name of the stored procedure formal parameterx- the parameter value- Throws:
java.sql.SQLException- if a database access error occurs- Since:
- 9.0.2
- See Also:
CallableStatement.getByte(int)
-
setShort
void setShort(java.lang.String parameterName, short x) throws java.sql.SQLExceptionSets the designated parameter to the given Javashortvalue. The driver converts this to an SQLSMALLINTvalue when it sends it to the database.- Specified by:
setShortin interfacejava.sql.CallableStatement- Parameters:
parameterName- the name of the stored procedure formal parameterx- the parameter value- Throws:
java.sql.SQLException- if a database access error occurs- Since:
- 9.0.2
- See Also:
CallableStatement.getShort(int)
-
setInt
void setInt(java.lang.String parameterName, int x) throws java.sql.SQLExceptionSets the designated parameter to the given Javaintvalue. The driver converts this to an SQLINTEGERvalue when it sends it to the database.- Specified by:
setIntin interfacejava.sql.CallableStatement- Parameters:
parameterName- the name of the stored procedure formal parameterx- the parameter value- Throws:
java.sql.SQLException- if a database access error occurs- Since:
- 9.0.2
- See Also:
CallableStatement.getInt(int)
-
setLong
void setLong(java.lang.String parameterName, long x) throws java.sql.SQLExceptionSets the designated parameter to the given Javalongvalue. The driver converts this to an SQLBIGINTvalue when it sends it to the database.- Specified by:
setLongin interfacejava.sql.CallableStatement- Parameters:
parameterName- the name of the stored procedure formal parameterx- the parameter value- Throws:
java.sql.SQLException- if a database access error occurs- Since:
- 9.0.2
- See Also:
CallableStatement.getLong(int)
-
setFloat
void setFloat(java.lang.String parameterName, float x) throws java.sql.SQLExceptionSets the designated parameter to the given Javafloatvalue. The driver converts this to an SQLFLOATvalue when it sends it to the database.- Specified by:
setFloatin interfacejava.sql.CallableStatement- Parameters:
parameterName- the name of the stored procedure formal parameterx- the parameter value- Throws:
java.sql.SQLException- if a database access error occurs- Since:
- 9.0.2
- See Also:
CallableStatement.getFloat(int)
-
setBinaryFloat
void setBinaryFloat(java.lang.String parameterName, float x) throws java.sql.SQLExceptionSets the designated parameter to the given Javafloatvalue. The driver converts this to an SQLBINARY_FLOATvalue when it sends it to the database.- Parameters:
parameterName- the name of the stored procedure formal parameterx- the parameter value- Throws:
java.sql.SQLException- if a database access error occurs- Since:
- 10.0
- See Also:
CallableStatement.getFloat(int)
-
setBinaryDouble
void setBinaryDouble(java.lang.String parameterName, double x) throws java.sql.SQLExceptionSets the designated parameter to the givenoracle.sql.BINARY_FLOATvalue.- Parameters:
parameterName- the name of the stored procedure formal parameterx- the parameter value- Throws:
java.sql.SQLException- if a database access error occurs- Since:
- 10.0
- See Also:
CallableStatement.getFloat(int)
-
setDouble
void setDouble(java.lang.String parameterName, double x) throws java.sql.SQLExceptionSets the designated parameter to the given Javadoublevalue. The driver converts this to an SQLDOUBLEvalue when it sends it to the database.- Specified by:
setDoublein interfacejava.sql.CallableStatement- Parameters:
parameterName- the name of the stored procedure formal parameterx- the parameter value- Throws:
java.sql.SQLException- if a database access error occurs- Since:
- 9.0.2
- See Also:
CallableStatement.getDouble(int)
-
setBigDecimal
void setBigDecimal(java.lang.String parameterName, java.math.BigDecimal x) throws java.sql.SQLExceptionSets the designated parameter to the givenjava.math.BigDecimalvalue. The driver converts this to an SQLNUMERICvalue when it sends it to the database.- Specified by:
setBigDecimalin interfacejava.sql.CallableStatement- Parameters:
parameterName- the name of the stored procedure formal parameterx- the parameter value- Throws:
java.sql.SQLException- if a database access error occurs- Since:
- 9.0.2
- See Also:
CallableStatement.getBigDecimal(int, int)
-
setString
void setString(java.lang.String parameterName, java.lang.String x) throws java.sql.SQLExceptionSets the designated parameter to the given JavaStringvalue. The driver converts this to an SQLVARCHARorLONGVARCHARvalue (depending on the argument's size relative to the driver's limits onVARCHARvalues) when it sends it to the database.- Specified by:
setStringin interfacejava.sql.CallableStatement- Parameters:
parameterName- the name of the stored procedure formal parameterx- the parameter value- Throws:
java.sql.SQLException- if a database access error occurs- Since:
- 9.0.2
- See Also:
CallableStatement.getString(int)
-
setFixedCHAR
void setFixedCHAR(java.lang.String parameterName, java.lang.String x) throws java.sql.SQLExceptionSets the designated parameter to aStringSee the javadoc for the setFixedChar(int, String) method in OraclePreparedStatement. Note that PL/SQL comparison operators do provide blank padding.- Parameters:
parameterName- the name of the stored procedure formal parameterx- the parameter value- Throws:
java.sql.SQLException- if a database access error occurs
-
setCursor
void setCursor(java.lang.String parameterName, java.sql.ResultSet x) throws java.sql.SQLExceptionSets the designated parameter to a Java Cursor value.- Parameters:
parameterName- the name of the stored procedure formal parameterx- the parameter value- Throws:
java.sql.SQLException- if a database access error occurs
-
setROWID
void setROWID(java.lang.String parameterName, ROWID x) throws java.sql.SQLExceptionSets the designated parameter to anoracle.sql.ROWIDvalue.- Parameters:
parameterName- the name of the stored procedure formal parameterx- the parameter value- Throws:
java.sql.SQLException- if a database access error occurs
-
setRAW
void setRAW(java.lang.String parameterName, RAW x) throws java.sql.SQLExceptionSets the designated parameter to anoracle.sql.RAWvalue.- Parameters:
parameterName- the name of the stored procedure formal parameterx- the parameter value- Throws:
java.sql.SQLException- if a database access error occurs
-
setCHAR
void setCHAR(java.lang.String parameterName, CHAR x) throws java.sql.SQLExceptionSets the designated parameter to anoracle.sql.CHARvalue.- Parameters:
parameterName- the name of the stored procedure formal parameterx- the parameter value- Throws:
java.sql.SQLException- if a database access error occurs
-
setDATE
void setDATE(java.lang.String parameterName, DATE x) throws java.sql.SQLExceptionSets the designated parameter to anoracle.sql.DATEvalue.- Parameters:
parameterName- the name of the stored procedure formal parameterx- the parameter value- Throws:
java.sql.SQLException- if a database access error occurs
-
setNUMBER
void setNUMBER(java.lang.String parameterName, NUMBER x) throws java.sql.SQLExceptionSets the designated parameter to anoracle.sql.NUMBERvalue.- Parameters:
parameterName- the name of the stored procedure formal parameterx- the parameter value- Throws:
java.sql.SQLException- if a database access error occurs
-
setBLOB
void setBLOB(java.lang.String parameterName, BLOB x) throws java.sql.SQLExceptionSets the designated parameter to anoracle.sql.BLOBvalue.- Parameters:
parameterName- the name of the stored procedure formal parameterx- the parameter value- Throws:
java.sql.SQLException- if a database access error occurs
-
setBlob
void setBlob(java.lang.String parameterName, java.sql.Blob x) throws java.sql.SQLExceptionSets the designated parameter to anjava.sql.Blobvalue.- Specified by:
setBlobin interfacejava.sql.CallableStatement- Parameters:
parameterName- the name of the stored procedure formal parameterx- the parameter value- Throws:
java.sql.SQLException- if a database access error occurs
-
setCLOB
void setCLOB(java.lang.String parameterName, CLOB x) throws java.sql.SQLExceptionSets the designated parameter to anoracle.sql.CLOBvalue.- Parameters:
parameterName- the name of the stored procedure formal parameterx- the parameter value- Throws:
java.sql.SQLException- if a database access error occurs
-
setClob
void setClob(java.lang.String parameterName, java.sql.Clob x) throws java.sql.SQLExceptionSets the designated parameter to anjava.sql.Clobvalue.- Specified by:
setClobin interfacejava.sql.CallableStatement- Parameters:
parameterName- the name of the stored procedure formal parameterx- the parameter value- Throws:
java.sql.SQLException- if a database access error occurs
-
setBFILE
void setBFILE(java.lang.String parameterName, BFILE x) throws java.sql.SQLExceptionSets the designated parameter to anoracle.sql.BFILEvalue.- Parameters:
parameterName- the name of the stored procedure formal parameterx- the parameter value- Throws:
java.sql.SQLException- if a database access error occurs
-
setBfile
void setBfile(java.lang.String parameterName, BFILE x) throws java.sql.SQLExceptionSets the designated parameter to anoracle.sql.BFILEvalue.- Parameters:
parameterName- the name of the stored procedure formal parameterx- the parameter value- Throws:
java.sql.SQLException- if a database access error occurs
-
setBytes
void setBytes(java.lang.String parameterName, byte[] x) throws java.sql.SQLExceptionSets the designated parameter to the given Java array of bytes. The driver converts this to an SQLVARBINARYorLONGVARBINARY(depending on the argument's size relative to the driver's limits onVARBINARYvalues) when it sends it to the database.- Specified by:
setBytesin interfacejava.sql.CallableStatement- Parameters:
parameterName- the name of the stored procedure formal parameterx- the parameter value- Throws:
java.sql.SQLException- if a database access error occurs- Since:
- 9.0.2
- See Also:
CallableStatement.getBytes(int)
-
setDate
void setDate(java.lang.String parameterName, java.sql.Date x) throws java.sql.SQLExceptionSets the designated parameter to the givenjava.sql.Datevalue. The driver converts this to an SQLDATEvalue when it sends it to the database.- Specified by:
setDatein interfacejava.sql.CallableStatement- Parameters:
parameterName- the name of the stored procedure formal parameterx- the parameter value- Throws:
java.sql.SQLException- if a database access error occurs- Since:
- 9.0.2
- See Also:
CallableStatement.getDate(int)
-
setTime
void setTime(java.lang.String parameterName, java.sql.Time x) throws java.sql.SQLExceptionSets the designated parameter to the givenjava.sql.Timevalue. The driver converts this to an SQLTIMEvalue when it sends it to the database.- Specified by:
setTimein interfacejava.sql.CallableStatement- Parameters:
parameterName- the name of the stored procedure formal parameterx- the parameter value- Throws:
java.sql.SQLException- if a database access error occurs- Since:
- 9.0.2
- See Also:
CallableStatement.getTime(int)
-
setTimestamp
void setTimestamp(java.lang.String parameterName, java.sql.Timestamp x) throws java.sql.SQLExceptionSets the designated parameter to the givenjava.sql.Timestampvalue. The driver converts this to an SQLTIMESTAMPvalue when it sends it to the database.- Specified by:
setTimestampin interfacejava.sql.CallableStatement- Parameters:
parameterName- the name of the stored procedure formal parameterx- the parameter value- Throws:
java.sql.SQLException- if a database access error occurs- Since:
- 9.0.2
- See Also:
CallableStatement.getTimestamp(int)
-
setINTERVALYM
void setINTERVALYM(java.lang.String parameterName, INTERVALYM x) throws java.sql.SQLExceptionSets the designated parameter to anoracle.sql.INTERVALYMvalue.- Parameters:
parameterName- the name of the stored procedure formal parameterx- the parameter value- Throws:
java.sql.SQLException- if a database access error occurs
-
setINTERVALDS
void setINTERVALDS(java.lang.String parameterName, INTERVALDS x) throws java.sql.SQLExceptionSets the designated parameter to anoracle.sql.INTERVALDSvalue.- Parameters:
parameterName- the name of the stored procedure formal parameterx- the parameter value- Throws:
java.sql.SQLException- if a database access error occurs
-
setTIMESTAMP
void setTIMESTAMP(java.lang.String parameterName, TIMESTAMP x) throws java.sql.SQLExceptionSets the designated parameter to anoracle.sql.TIMESTAMPvalue.- Parameters:
parameterName- the name of the stored procedure formal parameterx- the parameter value- Throws:
java.sql.SQLException- if a database access error occurs
-
setTIMESTAMPTZ
void setTIMESTAMPTZ(java.lang.String parameterName, TIMESTAMPTZ x) throws java.sql.SQLExceptionSets the designated parameter to anoracle.sql.TIMESTAMPTZvalue.- Parameters:
parameterName- the name of the stored procedure formal parameterx- the parameter value- Throws:
java.sql.SQLException- if a database access error occurs
-
setTIMESTAMPLTZ
void setTIMESTAMPLTZ(java.lang.String parameterName, TIMESTAMPLTZ x) throws java.sql.SQLExceptionSets the designated parameter to anoracle.sql.TIMESTAMPLTZvalue.- Parameters:
parameterName- the name of the stored procedure formal parameterx- the parameter value- Throws:
java.sql.SQLException- if a database access error occurs
-
setAsciiStream
void setAsciiStream(java.lang.String parameterName, java.io.InputStream x, int y) throws java.sql.SQLExceptionSets the designated parameter to the given input stream, which will have the specified number of bytes. When a very large ASCII value is input to aLONGVARCHARparameter, it may be more practical to send it via ajava.io.InputStream. Data will be read from the stream as needed until end-of-file is reached. The JDBC driver will do any necessary conversion from ASCII to the database char format.Note: This stream object can either be a standard Java stream object or your own subclass that implements the standard interface.
- Specified by:
setAsciiStreamin interfacejava.sql.CallableStatement- Parameters:
parameterName- the name of the stored procedure formal parameterx- the Java input stream that contains the ASCII parameter valuey- the number of bytes in the stream- Throws:
java.sql.SQLException- if a database access error occurs- Since:
- 9.0.2
-
setBinaryStream
void setBinaryStream(java.lang.String parameterName, java.io.InputStream x, int y) throws java.sql.SQLExceptionSets the designated parameter to the given input stream, which will have the specified number of bytes. When a very large binary value is input to aLONGVARBINARYparameter, it may be more practical to send it via ajava.io.InputStreamobject. The data will be read from the stream as needed until end-of-file is reached.Note: This stream object can either be a standard Java stream object or your own subclass that implements the standard interface.
- Specified by:
setBinaryStreamin interfacejava.sql.CallableStatement- Parameters:
parameterName- the name of the stored procedure formal parameterx- the java input stream which contains the binary parameter valuey- the number of bytes in the stream- Throws:
java.sql.SQLException- if a database access error occurs- Since:
- 9.0.2
-
setUnicodeStream
void setUnicodeStream(java.lang.String parameterName, java.io.InputStream x, int y) throws java.sql.SQLExceptionSets the designated parameter to a Java UnicodeStream value.- Parameters:
parameterName- the name of the stored procedure formal parameterx- the java input stream which contains the binary parameter valuey- the number of bytes in the stream- Throws:
java.sql.SQLException- if a database access error occurs
-
setCharacterStream
void setCharacterStream(java.lang.String parameterName, java.io.Reader x, int y) throws java.sql.SQLExceptionSets the designated parameter to the givenReaderobject, which is the given number of characters long. When a very large UNICODE value is input to aLONGVARCHARparameter, it may be more practical to send it via ajava.io.Readerobject. The data will be read from the stream as needed until end-of-file is reached. The JDBC driver will do any necessary conversion from UNICODE to the database char format.Note: This stream object can either be a standard Java stream object or your own subclass that implements the standard interface.
- Specified by:
setCharacterStreamin interfacejava.sql.CallableStatement- Parameters:
parameterName- the name of the stored procedure formal parameterx- thejava.io.Readerobject that contains the UNICODE data used as the designated parametery- the number of characters in the stream- Throws:
java.sql.SQLException- if a database access error occurs- Since:
- 9.0.2
-
setDate
void setDate(java.lang.String parameterName, java.sql.Date x, java.util.Calendar cal) throws java.sql.SQLExceptionSets the designated parameter to the givenjava.sql.Datevalue, using the givenCalendarobject. The driver uses theCalendarobject to construct an SQLDATEvalue, which the driver then sends to the database. With a aCalendarobject, the driver can calculate the date taking into account a custom time zone. If noCalendarobject is specified, the driver uses the default time zone, which is that of the virtual machine running the application.- Specified by:
setDatein interfacejava.sql.CallableStatement- Parameters:
parameterName- the name of the stored procedure formal parameterx- the parameter valuecal- theCalendarobject the driver will use to construct the date- Throws:
java.sql.SQLException- if a database access error occurs- Since:
- 9.0.2
- See Also:
CallableStatement.getDate(int)
-
setTime
void setTime(java.lang.String parameterName, java.sql.Time x, java.util.Calendar cal) throws java.sql.SQLExceptionSets the designated parameter to the givenjava.sql.Timevalue, using the givenCalendarobject. The driver uses theCalendarobject to construct an SQLTIMEvalue, which the driver then sends to the database. With a aCalendarobject, the driver can calculate the time taking into account a custom time zone. If noCalendarobject is specified, the driver uses the default time zone, which is that of the virtual machine running the application.- Specified by:
setTimein interfacejava.sql.CallableStatement- Parameters:
parameterName- the name of the stored procedure formal parameterx- the parameter valuecal- theCalendarobject the driver will use to construct the time- Throws:
java.sql.SQLException- if a database access error occurs- Since:
- 9.0.2
- See Also:
CallableStatement.getTime(int)
-
setTimestamp
void setTimestamp(java.lang.String parameterName, java.sql.Timestamp x, java.util.Calendar cal) throws java.sql.SQLExceptionSets the designated parameter to the givenjava.sql.Timestampvalue, using the givenCalendarobject. The driver uses theCalendarobject to construct an SQLTIMESTAMPvalue, which the driver then sends to the database. With a aCalendarobject, the driver can calculate the timestamp taking into account a custom time zone. If noCalendarobject is specified, the driver uses the default time zone, which is that of the virtual machine running the application.- Specified by:
setTimestampin interfacejava.sql.CallableStatement- Parameters:
parameterName- the name of the stored procedure formal parameterx- the parameter valuecal- theCalendarobject the driver will use to construct the timestamp- Throws:
java.sql.SQLException- if a database access error occurs- Since:
- 9.0.2
- See Also:
CallableStatement.getTimestamp(int)
-
setURL
void setURL(java.lang.String parameterName, java.net.URL x) throws java.sql.SQLExceptionSets the designated parameter to the givenjava.net.URLobject. The driver converts this to an SQLDATALINKvalue when it sends it to the database.- Specified by:
setURLin interfacejava.sql.CallableStatement- Parameters:
parameterName- the name of the stored procedure formal parameterx- the parameter value- Throws:
java.sql.SQLException- if a database access error occurs, or if a URL is malformed- Since:
- 9.0.2
- See Also:
CallableStatement.getURL(int)
-
setArray
void setArray(java.lang.String parameterName, java.sql.Array x) throws java.sql.SQLExceptionSets the designated parameter to anjava.sql.Arrayvalue.- Parameters:
parameterName- the name of the stored procedure formal parameterx- the parameter value- Throws:
java.sql.SQLException- if a database access error occurs
-
setARRAY
void setARRAY(java.lang.String parameterName, ARRAY x) throws java.sql.SQLExceptionSets the designated parameter to anoracle.sql.ARRAYvalue.- Parameters:
parameterName- the name of the stored procedure formal parameterx- the parameter value- Throws:
java.sql.SQLException- if a database access error occurs
-
setOPAQUE
void setOPAQUE(java.lang.String parameterName, OPAQUE x) throws java.sql.SQLExceptionSets the designated parameter to anoracle.sql.OPAQUEvalue.- Parameters:
parameterName- the name of the stored procedure formal parameterx- the parameter value- Throws:
java.sql.SQLException- if a database access error occurs
-
setStructDescriptor
void setStructDescriptor(java.lang.String parameterName, StructDescriptor x) throws java.sql.SQLException- Throws:
java.sql.SQLException
-
setSTRUCT
void setSTRUCT(java.lang.String parameterName, STRUCT x) throws java.sql.SQLExceptionSets the designated parameter to anoracle.sql.STRUCTvalue.- Parameters:
parameterName- the name of the stored procedure formal parameterx- the parameter value- Throws:
java.sql.SQLException- if a database access error occurs
-
setCustomDatum
void setCustomDatum(java.lang.String parameterName, CustomDatum x) throws java.sql.SQLExceptionSets the designated parameter to anoracle.sql.CustomDatumvalue.- Parameters:
parameterName- the name of the stored procedure formal parameterx- the parameter value- Throws:
java.sql.SQLException- if a database access error occurs
-
setORAData
void setORAData(java.lang.String parameterName, ORAData x) throws java.sql.SQLExceptionSets the designated parameter to anoracle.sql.ORADatavalue.- Parameters:
parameterName- the name of the stored procedure formal parameterx- the parameter value- Throws:
java.sql.SQLException- if a database access error occurs
-
setObject
void setObject(java.lang.String parameterName, java.lang.Object x, int targetSqlType, int scale) throws java.sql.SQLExceptionSets the value of the designated parameter with the given object. The second argument must be an object type; for integral values, thejava.langequivalent objects should be used.The given Java object will be converted to the given targetSqlType before being sent to the database. If the object has a custom mapping (is of a class implementing the interface
SQLData), the JDBC driver should call the methodSQLData.writeSQLto write it to the SQL data stream. If, on the other hand, the object is of a class implementingRef,Blob,Clob,Struct, orArray, the driver should pass it to the database as a value of the corresponding SQL type.Note that this method may be used to pass database- specific abstract data types.
- Specified by:
setObjectin interfacejava.sql.CallableStatement- Parameters:
parameterName- the name of the stored procedure formal parameterx- the object containing the input parameter valuetargetSqlType- the SQL type (as defined in java.sql.Types) to be sent to the database. The scale argument may further qualify this type.scale- for java.sql.Types.DECIMAL or java.sql.Types.NUMERIC types, this is the number of digits after the decimal point. For all other types, this value will be ignored.- Throws:
java.sql.SQLException- if a database access error occurs- Since:
- 9.0.2
- See Also:
Types,getObject(int, oracle.jdbc.OracleDataFactory)
-
setObject
void setObject(java.lang.String parameterName, java.lang.Object x, int y) throws java.sql.SQLExceptionSets the value of the designated parameter with the given object. This method is like the methodsetObjectabove, except that it assumes a scale of zero.- Specified by:
setObjectin interfacejava.sql.CallableStatement- Parameters:
parameterName- the name of the stored procedure formal parameterx- the object containing the input parameter valuey- the SQL type (as defined in java.sql.Types) to be sent to the database- Throws:
java.sql.SQLException- if a database access error occurs- Since:
- 9.0.2
- See Also:
getObject(int, oracle.jdbc.OracleDataFactory)
-
setRefType
void setRefType(java.lang.String parameterName, REF x) throws java.sql.SQLExceptionSets the designated parameter to anoracle.sql.REFvalue.- Parameters:
parameterName- the name of the stored procedure formal parameterx- the parameter value- Throws:
java.sql.SQLException- if a database access error occurs
-
setRef
void setRef(java.lang.String parameterName, java.sql.Ref x) throws java.sql.SQLExceptionSets the designated parameter to anjdbc.sql.Refvalue.- Parameters:
parameterName- the name of the stored procedure formal parameterx- the parameter value- Throws:
java.sql.SQLException- if a database access error occurs
-
setREF
void setREF(java.lang.String parameterName, REF x) throws java.sql.SQLExceptionSets the designated parameter to anoracle.sql.REFvalue.- Parameters:
parameterName- the name of the stored procedure formal parameterx- the parameter value- Throws:
java.sql.SQLException- if a database access error occurs
-
setObject
void setObject(java.lang.String parameterName, java.lang.Object x) throws java.sql.SQLExceptionSets the value of the designated parameter with the given object. The second parameter must be of typeObject; therefore, thejava.langequivalent objects should be used for built-in types.The JDBC specification specifies a standard mapping from Java
Objecttypes to SQL types. The given argument will be converted to the corresponding SQL type before being sent to the database.Note that this method may be used to pass database- specific abstract data types, by using a driver-specific Java type. If the object is of a class implementing the interface
SQLData, the JDBC driver should call the methodSQLData.writeSQLto write it to the SQL data stream. If, on the other hand, the object is of a class implementingRef,Blob,Clob,Struct, orArray, the driver should pass it to the database as a value of the corresponding SQL type.This method throws an exception if there is an ambiguity, for example, if the object is of a class implementing more than one of the interfaces named above.
- Specified by:
setObjectin interfacejava.sql.CallableStatement- Parameters:
parameterName- the name of the stored procedure formal parameterx- the object containing the input parameter value- Throws:
java.sql.SQLException- if a database access error occurs or if the givenObjectparameter is ambiguous- Since:
- 9.0.2
- See Also:
getObject(int, oracle.jdbc.OracleDataFactory)
-
setOracleObject
void setOracleObject(java.lang.String parameterName, Datum x) throws java.sql.SQLExceptionSets the designated parameter to anoracle.sql.Datumvalue.- Parameters:
parameterName- the name of the stored procedure formal parameterx- the parameter value- Throws:
java.sql.SQLException- if a database access error occurs
-
registerOutParameterAtName
void registerOutParameterAtName(java.lang.String parameterMarkerName, int sqlType) throws java.sql.SQLExceptionSpecial Oracle method to registerOutParameter by the parameterMarkerName of oracle style parameter markers instead of parameterIndex. Please note that it takes the name of the parameter marker and not the name of the parameter.- Parameters:
parameterMarkerName- The name of the oracle style parameter markersqlType- a value fromTypes- Throws:
java.sql.SQLException
-
registerOutParameterAtName
void registerOutParameterAtName(java.lang.String parameterMarkerName, int sqlType, int scale) throws java.sql.SQLExceptionSpecial Oracle method to registerOutParameter by the parameterMarkerName of oracle style parameter markers instead of parameterIndex. Please note that it takes the name of the parameter marker and not the name of the parameter.- Parameters:
parameterMarkerName- The name of the oracle style parameter markersqlType- a value fromTypesscale- the desired number of digits to the right of the decimal point. It must be greater than or equal to zero.- Throws:
java.sql.SQLException
-
registerOutParameterAtName
void registerOutParameterAtName(java.lang.String parameterMarkerName, int sqlType, java.lang.String typeName) throws java.sql.SQLExceptionSpecial Oracle method to registerOutParameter by the parameterMarkerName of oracle style parameter markers instead of parameterIndex. Please note that it takes the name of the parameter marker and not the name of the parameter.- Parameters:
parameterMarkerName- The name of the oracle style parameter markersqlType- a value fromTypestypeName- the fully-qualified name of an SQL structured type- Throws:
java.sql.SQLException
-
-