Interface CallableStatement
- All Superinterfaces:
AutoCloseable,PreparedStatement,Statement,Wrapper
{?= call <procedure-name>[(<arg1>,<arg2>, ...)]}
{call <procedure-name>[(<arg1>,<arg2>, ...)]}
IN parameter values are set using the set methods inherited from
PreparedStatement. The type of all OUT parameters must be
registered prior to executing the stored procedure; their values
are retrieved after execution via the get methods provided here.
A CallableStatement can return one ResultSet object or
multiple ResultSet objects. Multiple
ResultSet objects are handled using operations
inherited from Statement.
For maximum portability, a call's ResultSet objects and
update counts should be processed prior to getting the values of output
parameters.
- Since:
- 1.1
- See Also:
-
Field Summary
Fields declared in 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 TypeMethodDescriptiongetArray(int parameterIndex) Retrieves the value of the designated JDBCARRAYparameter as anArrayobject in the Java programming language.Retrieves the value of a JDBCARRAYparameter as anArrayobject in the Java programming language.getBigDecimal(int parameterIndex) Retrieves the value of the designated JDBCNUMERICparameter as ajava.math.BigDecimalobject with as many digits to the right of the decimal point as the value contains.getBigDecimal(int parameterIndex, int scale) Deprecated.getBigDecimal(String parameterName) Retrieves the value of a JDBCNUMERICparameter as ajava.math.BigDecimalobject with as many digits to the right of the decimal point as the value contains.getBlob(int parameterIndex) Retrieves the value of the designated JDBCBLOBparameter as aBlobobject in the Java programming language.Retrieves the value of a JDBCBLOBparameter as aBlobobject in the Java programming language.booleangetBoolean(int parameterIndex) Retrieves the value of the designated JDBCBITorBOOLEANparameter as abooleanin the Java programming language.booleangetBoolean(String parameterName) Retrieves the value of a JDBCBITorBOOLEANparameter as abooleanin the Java programming language.bytegetByte(int parameterIndex) Retrieves the value of the designated JDBCTINYINTparameter as abytein the Java programming language.byteRetrieves the value of a JDBCTINYINTparameter as abytein the Java programming language.byte[]getBytes(int parameterIndex) Retrieves the value of the designated JDBCBINARYorVARBINARYparameter as an array ofbytevalues in the Java programming language.byte[]Retrieves the value of a JDBCBINARYorVARBINARYparameter as an array ofbytevalues in the Java programming language.getCharacterStream(int parameterIndex) Retrieves the value of the designated parameter as ajava.io.Readerobject in the Java programming language.getCharacterStream(String parameterName) Retrieves the value of the designated parameter as ajava.io.Readerobject in the Java programming language.getClob(int parameterIndex) Retrieves the value of the designated JDBCCLOBparameter as ajava.sql.Clobobject in the Java programming language.Retrieves the value of a JDBCCLOBparameter as ajava.sql.Clobobject in the Java programming language.getDate(int parameterIndex) Retrieves the value of the designated JDBCDATEparameter as ajava.sql.Dateobject.Retrieves the value of the designated JDBCDATEparameter as ajava.sql.Dateobject, using the givenCalendarobject to construct the date.Retrieves the value of a JDBCDATEparameter as ajava.sql.Dateobject.Retrieves the value of a JDBCDATEparameter as ajava.sql.Dateobject, using the givenCalendarobject to construct the date.doublegetDouble(int parameterIndex) Retrieves the value of the designated JDBCDOUBLEparameter as adoublein the Java programming language.doubleRetrieves the value of a JDBCDOUBLEparameter as adoublein the Java programming language.floatgetFloat(int parameterIndex) Retrieves the value of the designated JDBCFLOATparameter as afloatin the Java programming language.floatRetrieves the value of a JDBCFLOATparameter as afloatin the Java programming language.intgetInt(int parameterIndex) Retrieves the value of the designated JDBCINTEGERparameter as anintin the Java programming language.intRetrieves the value of a JDBCINTEGERparameter as anintin the Java programming language.longgetLong(int parameterIndex) Retrieves the value of the designated JDBCBIGINTparameter as alongin the Java programming language.longRetrieves the value of a JDBCBIGINTparameter as alongin the Java programming language.getNCharacterStream(int parameterIndex) Retrieves the value of the designated parameter as ajava.io.Readerobject in the Java programming language.getNCharacterStream(String parameterName) Retrieves the value of the designated parameter as ajava.io.Readerobject in the Java programming language.getNClob(int parameterIndex) Retrieves the value of the designated JDBCNCLOBparameter as ajava.sql.NClobobject in the Java programming language.Retrieves the value of a JDBCNCLOBparameter as ajava.sql.NClobobject in the Java programming language.getNString(int parameterIndex) Retrieves the value of the designatedNCHAR,NVARCHARorLONGNVARCHARparameter as aStringin the Java programming language.getNString(String parameterName) Retrieves the value of the designatedNCHAR,NVARCHARorLONGNVARCHARparameter as aStringin the Java programming language.getObject(int parameterIndex) Retrieves the value of the designated parameter as anObjectin the Java programming language.<T> TReturns an object representing the value of OUT parameterparameterIndexand will convert from the SQL type of the parameter to the requested Java data type, if the conversion is supported.Returns an object representing the value of OUT parameterparameterIndexand usesmapfor the custom mapping of the parameter value.Retrieves the value of a parameter as anObjectin the Java programming language.<T> TReturns an object representing the value of OUT parameterparameterNameand will convert from the SQL type of the parameter to the requested Java data type, if the conversion is supported.Returns an object representing the value of OUT parameterparameterNameand usesmapfor the custom mapping of the parameter value.getRef(int parameterIndex) Retrieves the value of the designated JDBCREF(<structured-type>)parameter as aRefobject in the Java programming language.Retrieves the value of a JDBCREF(<structured-type>)parameter as aRefobject in the Java programming language.getRowId(int parameterIndex) Retrieves the value of the designated JDBCROWIDparameter as ajava.sql.RowIdobject.Retrieves the value of the designated JDBCROWIDparameter as ajava.sql.RowIdobject.shortgetShort(int parameterIndex) Retrieves the value of the designated JDBCSMALLINTparameter as ashortin the Java programming language.shortRetrieves the value of a JDBCSMALLINTparameter as ashortin the Java programming language.getSQLXML(int parameterIndex) Retrieves the value of the designatedSQL XMLparameter as ajava.sql.SQLXMLobject in the Java programming language.Retrieves the value of the designatedSQL XMLparameter as ajava.sql.SQLXMLobject in the Java programming language.getString(int parameterIndex) Retrieves the value of the designated JDBCCHAR,VARCHAR, orLONGVARCHARparameter as aStringin the Java programming language.Retrieves the value of a JDBCCHAR,VARCHAR, orLONGVARCHARparameter as aStringin the Java programming language.getTime(int parameterIndex) Retrieves the value of the designated JDBCTIMEparameter as ajava.sql.Timeobject.Retrieves the value of the designated JDBCTIMEparameter as ajava.sql.Timeobject, using the givenCalendarobject to construct the time.Retrieves the value of a JDBCTIMEparameter as ajava.sql.Timeobject.Retrieves the value of a JDBCTIMEparameter as ajava.sql.Timeobject, using the givenCalendarobject to construct the time.getTimestamp(int parameterIndex) Retrieves the value of the designated JDBCTIMESTAMPparameter as ajava.sql.Timestampobject.getTimestamp(int parameterIndex, Calendar cal) Retrieves the value of the designated JDBCTIMESTAMPparameter as ajava.sql.Timestampobject, using the givenCalendarobject to construct theTimestampobject.getTimestamp(String parameterName) Retrieves the value of a JDBCTIMESTAMPparameter as ajava.sql.Timestampobject.getTimestamp(String parameterName, Calendar cal) Retrieves the value of a JDBCTIMESTAMPparameter as ajava.sql.Timestampobject, using the givenCalendarobject to construct theTimestampobject.getURL(int parameterIndex) Retrieves the value of the designated JDBCDATALINKparameter as ajava.net.URLobject.Retrieves the value of a JDBCDATALINKparameter as ajava.net.URLobject.voidregisterOutParameter(int parameterIndex, int sqlType) Registers the OUT parameter in ordinal positionparameterIndexto the JDBC typesqlType.voidregisterOutParameter(int parameterIndex, int sqlType, int scale) Registers the parameter in ordinal positionparameterIndexto be of JDBC typesqlType.voidregisterOutParameter(int parameterIndex, int sqlType, String typeName) Registers the designated output parameter.default voidregisterOutParameter(int parameterIndex, SQLType sqlType) Registers the OUT parameter in ordinal positionparameterIndexto the JDBC typesqlType.default voidregisterOutParameter(int parameterIndex, SQLType sqlType, int scale) Registers the parameter in ordinal positionparameterIndexto be of JDBC typesqlType.default voidregisterOutParameter(int parameterIndex, SQLType sqlType, String typeName) Registers the designated output parameter.voidregisterOutParameter(String parameterName, int sqlType) Registers the OUT parameter namedparameterNameto the JDBC typesqlType.voidregisterOutParameter(String parameterName, int sqlType, int scale) Registers the parameter namedparameterNameto be of JDBC typesqlType.voidregisterOutParameter(String parameterName, int sqlType, String typeName) Registers the designated output parameter.default voidregisterOutParameter(String parameterName, SQLType sqlType) Registers the OUT parameter namedparameterNameto the JDBC typesqlType.default voidregisterOutParameter(String parameterName, SQLType sqlType, int scale) Registers the parameter namedparameterNameto be of JDBC typesqlType.default voidregisterOutParameter(String parameterName, SQLType sqlType, String typeName) Registers the designated output parameter.voidsetAsciiStream(String parameterName, InputStream x) Sets the designated parameter to the given input stream.voidsetAsciiStream(String parameterName, InputStream x, int length) Sets the designated parameter to the given input stream, which will have the specified number of bytes.voidsetAsciiStream(String parameterName, InputStream x, long length) Sets the designated parameter to the given input stream, which will have the specified number of bytes.voidsetBigDecimal(String parameterName, BigDecimal x) Sets the designated parameter to the givenjava.math.BigDecimalvalue.voidsetBinaryStream(String parameterName, InputStream x) Sets the designated parameter to the given input stream.voidsetBinaryStream(String parameterName, InputStream x, int length) Sets the designated parameter to the given input stream, which will have the specified number of bytes.voidsetBinaryStream(String parameterName, InputStream x, long length) Sets the designated parameter to the given input stream, which will have the specified number of bytes.voidsetBlob(String parameterName, InputStream inputStream) Sets the designated parameter to anInputStreamobject.voidsetBlob(String parameterName, InputStream inputStream, long length) Sets the designated parameter to anInputStreamobject.voidSets the designated parameter to the givenjava.sql.Blobobject.voidsetBoolean(String parameterName, boolean x) Sets the designated parameter to the given Javabooleanvalue.voidSets the designated parameter to the given Javabytevalue.voidSets the designated parameter to the given Java array of bytes.voidsetCharacterStream(String parameterName, Reader reader) Sets the designated parameter to the givenReaderobject.voidsetCharacterStream(String parameterName, Reader reader, int length) Sets the designated parameter to the givenReaderobject, which is the given number of characters long.voidsetCharacterStream(String parameterName, Reader reader, long length) Sets the designated parameter to the givenReaderobject, which is the given number of characters long.voidSets the designated parameter to aReaderobject.voidSets the designated parameter to aReaderobject.voidSets the designated parameter to the givenjava.sql.Clobobject.voidSets the designated parameter to the givenjava.sql.Datevalue using the default time zone of the virtual machine that is running the application.voidSets the designated parameter to the givenjava.sql.Datevalue, using the givenCalendarobject.voidSets the designated parameter to the given Javadoublevalue.voidSets the designated parameter to the given Javafloatvalue.voidSets the designated parameter to the given Javaintvalue.voidSets the designated parameter to the given Javalongvalue.voidsetNCharacterStream(String parameterName, Reader value) Sets the designated parameter to aReaderobject.voidsetNCharacterStream(String parameterName, Reader value, long length) Sets the designated parameter to aReaderobject.voidSets the designated parameter to aReaderobject.voidSets the designated parameter to aReaderobject.voidSets the designated parameter to ajava.sql.NClobobject.voidsetNString(String parameterName, String value) Sets the designated parameter to the givenStringobject.voidSets the designated parameter to SQLNULL.voidSets the designated parameter to SQLNULL.voidSets the value of the designated parameter with the given object.voidSets the value of the designated parameter with the given object.voidSets the value of the designated parameter with the given object.default voidSets the value of the designated parameter with the given object.default voidSets the value of the designated parameter with the given object.voidSets the designated parameter to the givenjava.sql.RowIdobject.voidSets the designated parameter to the given Javashortvalue.voidSets the designated parameter to the givenjava.sql.SQLXMLobject.voidSets the designated parameter to the given JavaStringvalue.voidSets the designated parameter to the givenjava.sql.Timevalue.voidSets the designated parameter to the givenjava.sql.Timevalue, using the givenCalendarobject.voidsetTimestamp(String parameterName, Timestamp x) Sets the designated parameter to the givenjava.sql.Timestampvalue.voidsetTimestamp(String parameterName, Timestamp x, Calendar cal) Sets the designated parameter to the givenjava.sql.Timestampvalue, using the givenCalendarobject.voidSets the designated parameter to the givenjava.net.URLobject.booleanwasNull()Retrieves whether the last OUT parameter read had the value of SQLNULL.Methods declared in 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 declared in interface java.sql.Statement
addBatch, cancel, clearBatch, clearWarnings, close, closeOnCompletion, enquoteIdentifier, enquoteLiteral, enquoteNCharLiteral, 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, isSimpleIdentifier, setCursorName, setEscapeProcessing, setFetchDirection, setFetchSize, setLargeMaxRows, setMaxFieldSize, setMaxRows, setPoolable, setQueryTimeoutMethods declared in interface java.sql.Wrapper
isWrapperFor, unwrap
-
Method Details
-
registerOutParameter
Registers the OUT parameter in ordinal positionparameterIndexto the JDBC typesqlType. All OUT parameters must be registered before a stored procedure is executed.The JDBC type specified by
sqlTypefor an OUT parameter determines the Java type that must be used in thegetmethod to read the value of that parameter.If the JDBC type expected to be returned to this output parameter is specific to this particular database,
sqlTypeshould bejava.sql.Types.OTHER. The methodgetObject(int)retrieves the value.- Parameters:
parameterIndex- the first parameter is 1, the second is 2, and so onsqlType- the JDBC type code defined byjava.sql.Types. If the parameter is of JDBC typeNUMERICorDECIMAL, the version ofregisterOutParameterthat accepts a scale value should be used.- Throws:
SQLException- if the parameterIndex is not valid; if a database access error occurs or this method is called on a closedCallableStatementSQLFeatureNotSupportedException- ifsqlTypeis aARRAY,BLOB,CLOB,DATALINK,JAVA_OBJECT,NCHAR,NCLOB,NVARCHAR,LONGNVARCHAR,REF,ROWID,SQLXMLorSTRUCTdata type and the JDBC driver does not support this data type- See Also:
-
registerOutParameter
Registers the parameter in ordinal positionparameterIndexto be of JDBC typesqlType. All OUT parameters must be registered before a stored procedure is executed.The JDBC type specified by
sqlTypefor an OUT parameter determines the Java type that must be used in thegetmethod to read the value of that parameter.This version of
registerOutParametershould be used when the parameter is of JDBC typeNUMERICorDECIMAL.- Parameters:
parameterIndex- the first parameter is 1, the second is 2, and so onsqlType- the 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.- Throws:
SQLException- if the parameterIndex is not valid; if a database access error occurs or this method is called on a closedCallableStatementSQLFeatureNotSupportedException- ifsqlTypeis aARRAY,BLOB,CLOB,DATALINK,JAVA_OBJECT,NCHAR,NCLOB,NVARCHAR,LONGNVARCHAR,REF,ROWID,SQLXMLorSTRUCTdata type and the JDBC driver does not support this data type- See Also:
-
wasNull
Retrieves whether the last OUT parameter read had the value of SQLNULL. Note that this method should be called only after calling a getter method; otherwise, there is no value to use in determining whether it isnullor not.- Returns:
trueif the last parameter read was SQLNULL;falseotherwise- Throws:
SQLException- if a database access error occurs or this method is called on a closedCallableStatement
-
getString
Retrieves the value of the designated JDBCCHAR,VARCHAR, orLONGVARCHARparameter as aStringin the Java programming language.For the fixed-length type JDBC
CHAR, theStringobject returned has exactly the same value the SQLCHARvalue had in the database, including any padding added by the database.- Parameters:
parameterIndex- the first parameter is 1, the second is 2, and so on- Returns:
- the parameter value. If the value is SQL
NULL, the result isnull. - Throws:
SQLException- if the parameterIndex is not valid; if a database access error occurs or this method is called on a closedCallableStatement- See Also:
-
getBoolean
Retrieves the value of the designated JDBCBITorBOOLEANparameter as abooleanin the Java programming language.- Parameters:
parameterIndex- the first parameter is 1, the second is 2, and so on- Returns:
- the parameter value. If the value is SQL
NULL, the result isfalse. - Throws:
SQLException- if the parameterIndex is not valid; if a database access error occurs or this method is called on a closedCallableStatement- See Also:
-
getByte
Retrieves the value of the designated JDBCTINYINTparameter as abytein the Java programming language.- Parameters:
parameterIndex- the first parameter is 1, the second is 2, and so on- Returns:
- the parameter value. If the value is SQL
NULL, the result is0. - Throws:
SQLException- if the parameterIndex is not valid; if a database access error occurs or this method is called on a closedCallableStatement- See Also:
-
getShort
Retrieves the value of the designated JDBCSMALLINTparameter as ashortin the Java programming language.- Parameters:
parameterIndex- the first parameter is 1, the second is 2, and so on- Returns:
- the parameter value. If the value is SQL
NULL, the result is0. - Throws:
SQLException- if the parameterIndex is not valid; if a database access error occurs or this method is called on a closedCallableStatement- See Also:
-
getInt
Retrieves the value of the designated JDBCINTEGERparameter as anintin the Java programming language.- Parameters:
parameterIndex- the first parameter is 1, the second is 2, and so on- Returns:
- the parameter value. If the value is SQL
NULL, the result is0. - Throws:
SQLException- if the parameterIndex is not valid; if a database access error occurs or this method is called on a closedCallableStatement- See Also:
-
getLong
Retrieves the value of the designated JDBCBIGINTparameter as alongin the Java programming language.- Parameters:
parameterIndex- the first parameter is 1, the second is 2, and so on- Returns:
- the parameter value. If the value is SQL
NULL, the result is0. - Throws:
SQLException- if the parameterIndex is not valid; if a database access error occurs or this method is called on a closedCallableStatement- See Also:
-
getFloat
Retrieves the value of the designated JDBCFLOATparameter as afloatin the Java programming language.- Parameters:
parameterIndex- the first parameter is 1, the second is 2, and so on- Returns:
- the parameter value. If the value is SQL
NULL, the result is0. - Throws:
SQLException- if the parameterIndex is not valid; if a database access error occurs or this method is called on a closedCallableStatement- See Also:
-
getDouble
Retrieves the value of the designated JDBCDOUBLEparameter as adoublein the Java programming language.- Parameters:
parameterIndex- the first parameter is 1, the second is 2, and so on- Returns:
- the parameter value. If the value is SQL
NULL, the result is0. - Throws:
SQLException- if the parameterIndex is not valid; if a database access error occurs or this method is called on a closedCallableStatement- See Also:
-
getBigDecimal
@Deprecated(since="1.2") BigDecimal getBigDecimal(int parameterIndex, int scale) throws SQLException Deprecated.usegetBigDecimal(int parameterIndex)orgetBigDecimal(String parameterName)Retrieves the value of the designated JDBCNUMERICparameter as ajava.math.BigDecimalobject with scale digits to the right of the decimal point.- Parameters:
parameterIndex- the first parameter is 1, the second is 2, and so onscale- the number of digits to the right of the decimal point- Returns:
- the parameter value. If the value is SQL
NULL, the result isnull. - Throws:
SQLException- if the parameterIndex is not valid; if a database access error occurs or this method is called on a closedCallableStatementSQLFeatureNotSupportedException- if the JDBC driver does not support this method- See Also:
-
getBytes
Retrieves the value of the designated JDBCBINARYorVARBINARYparameter as an array ofbytevalues in the Java programming language.- Parameters:
parameterIndex- the first parameter is 1, the second is 2, and so on- Returns:
- the parameter value. If the value is SQL
NULL, the result isnull. - Throws:
SQLException- if the parameterIndex is not valid; if a database access error occurs or this method is called on a closedCallableStatement- See Also:
-
getDate
Retrieves the value of the designated JDBCDATEparameter as ajava.sql.Dateobject.- Parameters:
parameterIndex- the first parameter is 1, the second is 2, and so on- Returns:
- the parameter value. If the value is SQL
NULL, the result isnull. - Throws:
SQLException- if the parameterIndex is not valid; if a database access error occurs or this method is called on a closedCallableStatement- See Also:
-
getTime
Retrieves the value of the designated JDBCTIMEparameter as ajava.sql.Timeobject.- Parameters:
parameterIndex- the first parameter is 1, the second is 2, and so on- Returns:
- the parameter value. If the value is SQL
NULL, the result isnull. - Throws:
SQLException- if the parameterIndex is not valid; if a database access error occurs or this method is called on a closedCallableStatement- See Also:
-
getTimestamp
Retrieves the value of the designated JDBCTIMESTAMPparameter as ajava.sql.Timestampobject.- Parameters:
parameterIndex- the first parameter is 1, the second is 2, and so on- Returns:
- the parameter value. If the value is SQL
NULL, the result isnull. - Throws:
SQLException- if the parameterIndex is not valid; if a database access error occurs or this method is called on a closedCallableStatement- See Also:
-
getObject
Retrieves the value of the designated parameter as anObjectin the Java programming language. If the value is an SQLNULL, the driver returns a Javanull.This method returns a Java object whose type corresponds to the JDBC type that was registered for this parameter using the method
registerOutParameter. By registering the target JDBC type asjava.sql.Types.OTHER, this method can be used to read database-specific abstract data types.- Parameters:
parameterIndex- the first parameter is 1, the second is 2, and so on- Returns:
- A
java.lang.Objectholding the OUT parameter value - Throws:
SQLException- if the parameterIndex is not valid; if a database access error occurs or this method is called on a closedCallableStatement- See Also:
-
getBigDecimal
Retrieves the value of the designated JDBCNUMERICparameter as ajava.math.BigDecimalobject with as many digits to the right of the decimal point as the value contains.- Parameters:
parameterIndex- the first parameter is 1, the second is 2, and so on- Returns:
- the parameter value in full precision. If the value is
SQL
NULL, the result isnull. - Throws:
SQLException- if the parameterIndex is not valid; if a database access error occurs or this method is called on a closedCallableStatement- Since:
- 1.2
- See Also:
-
getObject
Returns an object representing the value of OUT parameterparameterIndexand usesmapfor the custom mapping of the parameter value.This method returns a Java object whose type corresponds to the JDBC type that was registered for this parameter using the method
registerOutParameter. By registering the target JDBC type asjava.sql.Types.OTHER, this method can be used to read database-specific abstract data types.- Parameters:
parameterIndex- the first parameter is 1, the second is 2, and so onmap- the mapping from SQL type names to Java classes- Returns:
- a
java.lang.Objectholding the OUT parameter value - Throws:
SQLException- if the parameterIndex is not valid; if a database access error occurs or this method is called on a closedCallableStatementSQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- 1.2
- See Also:
-
getRef
Retrieves the value of the designated JDBCREF(<structured-type>)parameter as aRefobject in the Java programming language.- Parameters:
parameterIndex- the first parameter is 1, the second is 2, and so on- Returns:
- the parameter value as a
Refobject in the Java programming language. If the value was SQLNULL, the valuenullis returned. - Throws:
SQLException- if the parameterIndex is not valid; if a database access error occurs or this method is called on a closedCallableStatementSQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- 1.2
-
getBlob
Retrieves the value of the designated JDBCBLOBparameter as aBlobobject in the Java programming language.- Parameters:
parameterIndex- the first parameter is 1, the second is 2, and so on- Returns:
- the parameter value as a
Blobobject in the Java programming language. If the value was SQLNULL, the valuenullis returned. - Throws:
SQLException- if the parameterIndex is not valid; if a database access error occurs or this method is called on a closedCallableStatementSQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- 1.2
-
getClob
Retrieves the value of the designated JDBCCLOBparameter as ajava.sql.Clobobject in the Java programming language.- Parameters:
parameterIndex- the first parameter is 1, the second is 2, and so on- Returns:
- the parameter value as a
Clobobject in the Java programming language. If the value was SQLNULL, the valuenullis returned. - Throws:
SQLException- if the parameterIndex is not valid; if a database access error occurs or this method is called on a closedCallableStatementSQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- 1.2
-
getArray
Retrieves the value of the designated JDBCARRAYparameter as anArrayobject in the Java programming language.- Parameters:
parameterIndex- the first parameter is 1, the second is 2, and so on- Returns:
- the parameter value as an
Arrayobject in the Java programming language. If the value was SQLNULL, the valuenullis returned. - Throws:
SQLException- if the parameterIndex is not valid; if a database access error occurs or this method is called on a closedCallableStatementSQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- 1.2
-
getDate
Retrieves the value of the designated JDBCDATEparameter as ajava.sql.Dateobject, using the givenCalendarobject to construct the date. With aCalendarobject, the driver can calculate the date taking into account a custom timezone and locale. If noCalendarobject is specified, the driver uses the default timezone and locale.- Parameters:
parameterIndex- the first parameter is 1, the second is 2, and so oncal- theCalendarobject the driver will use to construct the date- Returns:
- the parameter value. If the value is SQL
NULL, the result isnull. - Throws:
SQLException- if the parameterIndex is not valid; if a database access error occurs or this method is called on a closedCallableStatement- Since:
- 1.2
- See Also:
-
getTime
Retrieves the value of the designated JDBCTIMEparameter as ajava.sql.Timeobject, using the givenCalendarobject to construct the time. With aCalendarobject, the driver can calculate the time taking into account a custom timezone and locale. If noCalendarobject is specified, the driver uses the default timezone and locale.- Parameters:
parameterIndex- the first parameter is 1, the second is 2, and so oncal- theCalendarobject the driver will use to construct the time- Returns:
- the parameter value; if the value is SQL
NULL, the result isnull. - Throws:
SQLException- if the parameterIndex is not valid; if a database access error occurs or this method is called on a closedCallableStatement- Since:
- 1.2
- See Also:
-
getTimestamp
Retrieves the value of the designated JDBCTIMESTAMPparameter as ajava.sql.Timestampobject, using the givenCalendarobject to construct theTimestampobject. With aCalendarobject, the driver can calculate the timestamp taking into account a custom timezone and locale. If noCalendarobject is specified, the driver uses the default timezone and locale.- Parameters:
parameterIndex- the first parameter is 1, the second is 2, and so oncal- theCalendarobject the driver will use to construct the timestamp- Returns:
- the parameter value. If the value is SQL
NULL, the result isnull. - Throws:
SQLException- if the parameterIndex is not valid; if a database access error occurs or this method is called on a closedCallableStatement- Since:
- 1.2
- See Also:
-
registerOutParameter
Registers the designated output parameter. This version of the methodregisterOutParametershould be used for a user-defined orREFoutput parameter. Examples of user-defined types include:STRUCT,DISTINCT,JAVA_OBJECT, and named array types.All OUT parameters must be registered before a stored procedure is executed.
For a user-defined parameter, the fully-qualified SQL type name of the parameter should also be given, while a
REFparameter requires that the fully-qualified type name of the referenced type be given. A JDBC driver that does not need the type code and type name information may ignore it. To be portable, however, applications should always provide these values for user-defined andREFparameters. Although it is intended for user-defined andREFparameters, this method may be used to register a parameter of any JDBC type. If the parameter does not have a user-defined orREFtype, the typeName parameter is ignored.Note: When reading the value of an out parameter, you must use the getter method whose Java type corresponds to the parameter's registered SQL type.
- Parameters:
parameterIndex- the first parameter is 1, the second is 2,...sqlType- a value fromTypestypeName- the fully-qualified name of an SQL structured type- Throws:
SQLException- if the parameterIndex is not valid; if a database access error occurs or this method is called on a closedCallableStatementSQLFeatureNotSupportedException- ifsqlTypeis aARRAY,BLOB,CLOB,DATALINK,JAVA_OBJECT,NCHAR,NCLOB,NVARCHAR,LONGNVARCHAR,REF,ROWID,SQLXMLorSTRUCTdata type and the JDBC driver does not support this data type- Since:
- 1.2
- See Also:
-
registerOutParameter
Registers the OUT parameter namedparameterNameto the JDBC typesqlType. All OUT parameters must be registered before a stored procedure is executed.The JDBC type specified by
sqlTypefor an OUT parameter determines the Java type that must be used in thegetmethod to read the value of that parameter.If the JDBC type expected to be returned to this output parameter is specific to this particular database,
sqlTypeshould bejava.sql.Types.OTHER. The methodgetObject(int)retrieves the value.- Parameters:
parameterName- the name of the parametersqlType- the JDBC type code defined byjava.sql.Types. If the parameter is of JDBC typeNUMERICorDECIMAL, the version ofregisterOutParameterthat accepts a scale value should be used.- Throws:
SQLException- if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closedCallableStatementSQLFeatureNotSupportedException- ifsqlTypeis aARRAY,BLOB,CLOB,DATALINK,JAVA_OBJECT,NCHAR,NCLOB,NVARCHAR,LONGNVARCHAR,REF,ROWID,SQLXMLorSTRUCTdata type and the JDBC driver does not support this data type or if the JDBC driver does not support this method- Since:
- 1.4
- See Also:
-
registerOutParameter
Registers the parameter namedparameterNameto be of JDBC typesqlType. All OUT parameters must be registered before a stored procedure is executed.The JDBC type specified by
sqlTypefor an OUT parameter determines the Java type that must be used in thegetmethod to read the value of that parameter.This version of
registerOutParametershould be used when the parameter is of JDBC typeNUMERICorDECIMAL.- 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.- Throws:
SQLException- if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closedCallableStatementSQLFeatureNotSupportedException- ifsqlTypeis aARRAY,BLOB,CLOB,DATALINK,JAVA_OBJECT,NCHAR,NCLOB,NVARCHAR,LONGNVARCHAR,REF,ROWID,SQLXMLorSTRUCTdata type and the JDBC driver does not support this data type or if the JDBC driver does not support this method- Since:
- 1.4
- See Also:
-
registerOutParameter
Registers the designated output parameter. This version of the methodregisterOutParametershould be used for a user-named or REF output parameter. Examples of user-named types include: STRUCT, DISTINCT, JAVA_OBJECT, and named array types.All OUT parameters must be registered before a stored procedure is executed.
For a user-named parameter the fully-qualified SQL type name of the parameter should also be given, while a REF parameter requires that the fully-qualified type name of the referenced type be given. A JDBC driver that does not need the type code and type name information may ignore it. To be portable, however, applications should always provide these values for user-named and REF parameters. Although it is intended for user-named and REF parameters, this method may be used to register a parameter of any JDBC type. If the parameter does not have a user-named or REF type, the typeName parameter is ignored.
Note: When reading the value of an out parameter, you must use the
getXXXmethod whose Java type XXX corresponds to the parameter's registered SQL type.- Parameters:
parameterName- the name of the parametersqlType- a value fromTypestypeName- the fully-qualified name of an SQL structured type- Throws:
SQLException- if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closedCallableStatementSQLFeatureNotSupportedException- ifsqlTypeis aARRAY,BLOB,CLOB,DATALINK,JAVA_OBJECT,NCHAR,NCLOB,NVARCHAR,LONGNVARCHAR,REF,ROWID,SQLXMLorSTRUCTdata type and the JDBC driver does not support this data type or if the JDBC driver does not support this method- Since:
- 1.4
- See Also:
-
getURL
Retrieves the value of the designated JDBCDATALINKparameter as ajava.net.URLobject.- Parameters:
parameterIndex- the first parameter is 1, the second is 2,...- Returns:
- a
java.net.URLobject that represents the JDBCDATALINKvalue used as the designated parameter - Throws:
SQLException- if the parameterIndex is not valid; if a database access error occurs, this method is called on a closedCallableStatement, or if the URL being returned is not a valid URL on the Java platformSQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- 1.4
- See Also:
-
setURL
Sets the designated parameter to the givenjava.net.URLobject. The driver converts this to an SQLDATALINKvalue when it sends it to the database.- Parameters:
parameterName- the name of the parameterval- the parameter value- Throws:
SQLException- if parameterName does not correspond to a named parameter; if a database access error occurs; this method is called on a closedCallableStatementor if a URL is malformedSQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- 1.4
- See Also:
-
setNull
Sets the designated parameter to SQLNULL.Note: You must specify the parameter's SQL type.
- Parameters:
parameterName- the name of the parametersqlType- the SQL type code defined injava.sql.Types- Throws:
SQLException- if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closedCallableStatementSQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- 1.4
-
setBoolean
Sets the designated parameter to the given Javabooleanvalue. The driver converts this to an SQLBITorBOOLEANvalue when it sends it to the database.- Parameters:
parameterName- the name of the parameterx- the parameter value- Throws:
SQLException- if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closedCallableStatementSQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- 1.4
- See Also:
-
setByte
Sets the designated parameter to the given Javabytevalue. The driver converts this to an SQLTINYINTvalue when it sends it to the database.- Parameters:
parameterName- the name of the parameterx- the parameter value- Throws:
SQLException- if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closedCallableStatementSQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- 1.4
- See Also:
-
setShort
Sets the designated parameter to the given Javashortvalue. The driver converts this to an SQLSMALLINTvalue when it sends it to the database.- Parameters:
parameterName- the name of the parameterx- the parameter value- Throws:
SQLException- if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closedCallableStatementSQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- 1.4
- See Also:
-
setInt
Sets the designated parameter to the given Javaintvalue. The driver converts this to an SQLINTEGERvalue when it sends it to the database.- Parameters:
parameterName- the name of the parameterx- the parameter value- Throws:
SQLException- if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closedCallableStatementSQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- 1.4
- See Also:
-
setLong
Sets the designated parameter to the given Javalongvalue. The driver converts this to an SQLBIGINTvalue when it sends it to the database.- Parameters:
parameterName- the name of the parameterx- the parameter value- Throws:
SQLException- if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closedCallableStatementSQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- 1.4
- See Also:
-
setFloat
Sets the designated parameter to the given Javafloatvalue. The driver converts this to an SQLFLOATvalue when it sends it to the database.- Parameters:
parameterName- the name of the parameterx- the parameter value- Throws:
SQLException- if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closedCallableStatementSQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- 1.4
- See Also:
-
setDouble
Sets the designated parameter to the given Javadoublevalue. The driver converts this to an SQLDOUBLEvalue when it sends it to the database.- Parameters:
parameterName- the name of the parameterx- the parameter value- Throws:
SQLException- if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closedCallableStatementSQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- 1.4
- See Also:
-
setBigDecimal
Sets the designated parameter to the givenjava.math.BigDecimalvalue. The driver converts this to an SQLNUMERICvalue when it sends it to the database.- Parameters:
parameterName- the name of the parameterx- the parameter value- Throws:
SQLException- if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closedCallableStatementSQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- 1.4
- See Also:
-
setString
Sets 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.- Parameters:
parameterName- the name of the parameterx- the parameter value- Throws:
SQLException- if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closedCallableStatementSQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- 1.4
- See Also:
-
setBytes
Sets 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.- Parameters:
parameterName- the name of the parameterx- the parameter value- Throws:
SQLException- if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closedCallableStatementSQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- 1.4
- See Also:
-
setDate
Sets the designated parameter to the givenjava.sql.Datevalue using the default time zone of the virtual machine that is running the application. The driver converts this to an SQLDATEvalue when it sends it to the database.- Parameters:
parameterName- the name of the parameterx- the parameter value- Throws:
SQLException- if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closedCallableStatementSQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- 1.4
- See Also:
-
setTime
Sets the designated parameter to the givenjava.sql.Timevalue. The driver converts this to an SQLTIMEvalue when it sends it to the database.- Parameters:
parameterName- the name of the parameterx- the parameter value- Throws:
SQLException- if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closedCallableStatementSQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- 1.4
- See Also:
-
setTimestamp
Sets the designated parameter to the givenjava.sql.Timestampvalue. The driver converts this to an SQLTIMESTAMPvalue when it sends it to the database.- Parameters:
parameterName- the name of the parameterx- the parameter value- Throws:
SQLException- if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closedCallableStatementSQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- 1.4
- See Also:
-
setAsciiStream
Sets 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.
- Parameters:
parameterName- the name of the parameterx- the Java input stream that contains the ASCII parameter valuelength- the number of bytes in the stream- Throws:
SQLException- if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closedCallableStatementSQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- 1.4
-
setBinaryStream
Sets 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.
- Parameters:
parameterName- the name of the parameterx- the java input stream which contains the binary parameter valuelength- the number of bytes in the stream- Throws:
SQLException- if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closedCallableStatementSQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- 1.4
-
setObject
Sets the value of the designated parameter with the given object.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,NClob,Struct,java.net.URL, 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 datatabase- specific abstract data types.
- Parameters:
parameterName- the name of the 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:
SQLException- if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closedCallableStatementSQLFeatureNotSupportedException- if the JDBC driver does not support the specified targetSqlType- Since:
- 1.4
- See Also:
-
setObject
Sets the value of the designated parameter with the given object. This method is similar tosetObject(String parameterName, Object x, int targetSqlType, int scaleOrLength), except that it assumes a scale of zero.- Parameters:
parameterName- the name of the parameterx- the object containing the input parameter valuetargetSqlType- the SQL type (as defined in java.sql.Types) to be sent to the database- Throws:
SQLException- if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closedCallableStatementSQLFeatureNotSupportedException- if the JDBC driver does not support the specified targetSqlType- Since:
- 1.4
- See Also:
-
setObject
Sets the value of the designated parameter with the given object.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,NClob,Struct,java.net.URL, 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.
Note: Not all databases allow for a non-typed Null to be sent to the backend. For maximum portability, the
setNullor thesetObject(String parameterName, Object x, int sqlType)method should be used instead ofsetObject(String parameterName, Object x).- Parameters:
parameterName- the name of the parameterx- the object containing the input parameter value- Throws:
SQLException- if parameterName does not correspond to a named parameter; if a database access error occurs, this method is called on a closedCallableStatementor if the givenObjectparameter is ambiguousSQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- 1.4
- See Also:
-
setCharacterStream
Sets 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.
- Parameters:
parameterName- the name of the parameterreader- thejava.io.Readerobject that contains the UNICODE data used as the designated parameterlength- the number of characters in the stream- Throws:
SQLException- if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closedCallableStatementSQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- 1.4
-
setDate
Sets 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 timezone. If noCalendarobject is specified, the driver uses the default timezone, which is that of the virtual machine running the application.- Parameters:
parameterName- the name of the parameterx- the parameter valuecal- theCalendarobject the driver will use to construct the date- Throws:
SQLException- if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closedCallableStatementSQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- 1.4
- See Also:
-
setTime
Sets 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 timezone. If noCalendarobject is specified, the driver uses the default timezone, which is that of the virtual machine running the application.- Parameters:
parameterName- the name of the parameterx- the parameter valuecal- theCalendarobject the driver will use to construct the time- Throws:
SQLException- if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closedCallableStatementSQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- 1.4
- See Also:
-
setTimestamp
Sets 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 timezone. If noCalendarobject is specified, the driver uses the default timezone, which is that of the virtual machine running the application.- Parameters:
parameterName- the name of the parameterx- the parameter valuecal- theCalendarobject the driver will use to construct the timestamp- Throws:
SQLException- if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closedCallableStatementSQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- 1.4
- See Also:
-
setNull
Sets 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.
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.
- Parameters:
parameterName- the name of the 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:
SQLException- if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closedCallableStatementSQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- 1.4
-
getString
Retrieves the value of a JDBCCHAR,VARCHAR, orLONGVARCHARparameter as aStringin the Java programming language.For the fixed-length type JDBC
CHAR, theStringobject returned has exactly the same value the SQLCHARvalue had in the database, including any padding added by the database.- Parameters:
parameterName- the name of the parameter- Returns:
- the parameter value. If the value is SQL
NULL, the result isnull. - Throws:
SQLException- if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closedCallableStatementSQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- 1.4
- See Also:
-
getBoolean
Retrieves the value of a JDBCBITorBOOLEANparameter as abooleanin the Java programming language.- Parameters:
parameterName- the name of the parameter- Returns:
- the parameter value. If the value is SQL
NULL, the result isfalse. - Throws:
SQLException- if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closedCallableStatementSQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- 1.4
- See Also:
-
getByte
Retrieves the value of a JDBCTINYINTparameter as abytein the Java programming language.- Parameters:
parameterName- the name of the parameter- Returns:
- the parameter value. If the value is SQL
NULL, the result is0. - Throws:
SQLException- if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closedCallableStatementSQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- 1.4
- See Also:
-
getShort
Retrieves the value of a JDBCSMALLINTparameter as ashortin the Java programming language.- Parameters:
parameterName- the name of the parameter- Returns:
- the parameter value. If the value is SQL
NULL, the result is0. - Throws:
SQLException- if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closedCallableStatementSQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- 1.4
- See Also:
-
getInt
Retrieves the value of a JDBCINTEGERparameter as anintin the Java programming language.- Parameters:
parameterName- the name of the parameter- Returns:
- the parameter value. If the value is SQL
NULL, the result is0. - Throws:
SQLException- if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closedCallableStatementSQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- 1.4
- See Also:
-
getLong
Retrieves the value of a JDBCBIGINTparameter as alongin the Java programming language.- Parameters:
parameterName- the name of the parameter- Returns:
- the parameter value. If the value is SQL
NULL, the result is0. - Throws:
SQLException- if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closedCallableStatementSQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- 1.4
- See Also:
-
getFloat
Retrieves the value of a JDBCFLOATparameter as afloatin the Java programming language.- Parameters:
parameterName- the name of the parameter- Returns:
- the parameter value. If the value is SQL
NULL, the result is0. - Throws:
SQLException- if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closedCallableStatementSQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- 1.4
- See Also:
-
getDouble
Retrieves the value of a JDBCDOUBLEparameter as adoublein the Java programming language.- Parameters:
parameterName- the name of the parameter- Returns:
- the parameter value. If the value is SQL
NULL, the result is0. - Throws:
SQLException- if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closedCallableStatementSQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- 1.4
- See Also:
-
getBytes
Retrieves the value of a JDBCBINARYorVARBINARYparameter as an array ofbytevalues in the Java programming language.- Parameters:
parameterName- the name of the parameter- Returns:
- the parameter value. If the value is SQL
NULL, the result isnull. - Throws:
SQLException- if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closedCallableStatementSQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- 1.4
- See Also:
-
getDate
Retrieves the value of a JDBCDATEparameter as ajava.sql.Dateobject.- Parameters:
parameterName- the name of the parameter- Returns:
- the parameter value. If the value is SQL
NULL, the result isnull. - Throws:
SQLException- if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closedCallableStatementSQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- 1.4
- See Also:
-
getTime
Retrieves the value of a JDBCTIMEparameter as ajava.sql.Timeobject.- Parameters:
parameterName- the name of the parameter- Returns:
- the parameter value. If the value is SQL
NULL, the result isnull. - Throws:
SQLException- if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closedCallableStatementSQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- 1.4
- See Also:
-
getTimestamp
Retrieves the value of a JDBCTIMESTAMPparameter as ajava.sql.Timestampobject.- Parameters:
parameterName- the name of the parameter- Returns:
- the parameter value. If the value is SQL
NULL, the result isnull. - Throws:
SQLException- if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closedCallableStatementSQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- 1.4
- See Also:
-
getObject
Retrieves the value of a parameter as anObjectin the Java programming language. If the value is an SQLNULL, the driver returns a Javanull.This method returns a Java object whose type corresponds to the JDBC type that was registered for this parameter using the method
registerOutParameter. By registering the target JDBC type asjava.sql.Types.OTHER, this method can be used to read database-specific abstract data types.- Parameters:
parameterName- the name of the parameter- Returns:
- A
java.lang.Objectholding the OUT parameter value. - Throws:
SQLException- if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closedCallableStatementSQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- 1.4
- See Also:
-
getBigDecimal
Retrieves the value of a JDBCNUMERICparameter as ajava.math.BigDecimalobject with as many digits to the right of the decimal point as the value contains.- Parameters:
parameterName- the name of the parameter- Returns:
- the parameter value in full precision. If the value is
SQL
NULL, the result isnull. - Throws:
SQLException- if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closedCallableStatementSQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- 1.4
- See Also:
-
getObject
Returns an object representing the value of OUT parameterparameterNameand usesmapfor the custom mapping of the parameter value.This method returns a Java object whose type corresponds to the JDBC type that was registered for this parameter using the method
registerOutParameter. By registering the target JDBC type asjava.sql.Types.OTHER, this method can be used to read database-specific abstract data types.- Parameters:
parameterName- the name of the parametermap- the mapping from SQL type names to Java classes- Returns:
- a
java.lang.Objectholding the OUT parameter value - Throws:
SQLException- if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closedCallableStatementSQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- 1.4
- See Also:
-
getRef
Retrieves the value of a JDBCREF(<structured-type>)parameter as aRefobject in the Java programming language.- Parameters:
parameterName- the name of the parameter- Returns:
- the parameter value as a
Refobject in the Java programming language. If the value was SQLNULL, the valuenullis returned. - Throws:
SQLException- if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closedCallableStatementSQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- 1.4
-
getBlob
Retrieves the value of a JDBCBLOBparameter as aBlobobject in the Java programming language.- Parameters:
parameterName- the name of the parameter- Returns:
- the parameter value as a
Blobobject in the Java programming language. If the value was SQLNULL, the valuenullis returned. - Throws:
SQLException- if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closedCallableStatementSQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- 1.4
-
getClob
Retrieves the value of a JDBCCLOBparameter as ajava.sql.Clobobject in the Java programming language.- Parameters:
parameterName- the name of the parameter- Returns:
- the parameter value as a
Clobobject in the Java programming language. If the value was SQLNULL, the valuenullis returned. - Throws:
SQLException- if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closedCallableStatementSQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- 1.4
-
getArray
Retrieves the value of a JDBCARRAYparameter as anArrayobject in the Java programming language.- Parameters:
parameterName- the name of the parameter- Returns:
- the parameter value as an
Arrayobject in Java programming language. If the value was SQLNULL, the valuenullis returned. - Throws:
SQLException- if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closedCallableStatementSQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- 1.4
-
getDate
Retrieves the value of a JDBCDATEparameter as ajava.sql.Dateobject, using the givenCalendarobject to construct the date. With aCalendarobject, the driver can calculate the date taking into account a custom timezone and locale. If noCalendarobject is specified, the driver uses the default timezone and locale.- Parameters:
parameterName- the name of the parametercal- theCalendarobject the driver will use to construct the date- Returns:
- the parameter value. If the value is SQL
NULL, the result isnull. - Throws:
SQLException- if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closedCallableStatementSQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- 1.4
- See Also:
-
getTime
Retrieves the value of a JDBCTIMEparameter as ajava.sql.Timeobject, using the givenCalendarobject to construct the time. With aCalendarobject, the driver can calculate the time taking into account a custom timezone and locale. If noCalendarobject is specified, the driver uses the default timezone and locale.- Parameters:
parameterName- the name of the parametercal- theCalendarobject the driver will use to construct the time- Returns:
- the parameter value; if the value is SQL
NULL, the result isnull. - Throws:
SQLException- if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closedCallableStatementSQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- 1.4
- See Also:
-
getTimestamp
Retrieves the value of a JDBCTIMESTAMPparameter as ajava.sql.Timestampobject, using the givenCalendarobject to construct theTimestampobject. With aCalendarobject, the driver can calculate the timestamp taking into account a custom timezone and locale. If noCalendarobject is specified, the driver uses the default timezone and locale.- Parameters:
parameterName- the name of the parametercal- theCalendarobject the driver will use to construct the timestamp- Returns:
- the parameter value. If the value is SQL
NULL, the result isnull. - Throws:
SQLException- if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closedCallableStatementSQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- 1.4
- See Also:
-
getURL
Retrieves the value of a JDBCDATALINKparameter as ajava.net.URLobject.- Parameters:
parameterName- the name of the parameter- Returns:
- the parameter value as a
java.net.URLobject in the Java programming language. If the value was SQLNULL, the valuenullis returned. - Throws:
SQLException- if parameterName does not correspond to a named parameter; if a database access error occurs, this method is called on a closedCallableStatement, or if there is a problem with the URLSQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- 1.4
- See Also:
-
getRowId
Retrieves the value of the designated JDBCROWIDparameter as ajava.sql.RowIdobject.- Parameters:
parameterIndex- the first parameter is 1, the second is 2,...- Returns:
- a
RowIdobject that represents the JDBCROWIDvalue is used as the designated parameter. If the parameter contains a SQLNULL, then anullvalue is returned. - Throws:
SQLException- if the parameterIndex is not valid; if a database access error occurs or this method is called on a closedCallableStatementSQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- 1.6
-
getRowId
Retrieves the value of the designated JDBCROWIDparameter as ajava.sql.RowIdobject.- Parameters:
parameterName- the name of the parameter- Returns:
- a
RowIdobject that represents the JDBCROWIDvalue is used as the designated parameter. If the parameter contains a SQLNULL, then anullvalue is returned. - Throws:
SQLException- if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closedCallableStatementSQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- 1.6
-
setRowId
Sets the designated parameter to the givenjava.sql.RowIdobject. The driver converts this to a SQLROWIDwhen it sends it to the database.- Parameters:
parameterName- the name of the parameterx- the parameter value- Throws:
SQLException- if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closedCallableStatementSQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- 1.6
-
setNString
Sets the designated parameter to the givenStringobject. The driver converts this to a SQLNCHARorNVARCHARorLONGNVARCHAR- Parameters:
parameterName- the name of the parameter to be setvalue- the parameter value- Throws:
SQLException- if parameterName does not correspond to a named parameter; if the driver does not support national character sets; if the driver can detect that a data conversion error could occur; if a database access error occurs or this method is called on a closedCallableStatementSQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- 1.6
-
setNCharacterStream
Sets the designated parameter to aReaderobject. TheReaderreads the data till end-of-file is reached. The driver does the necessary conversion from Java character format to the national character set in the database.- Parameters:
parameterName- the name of the parameter to be setvalue- the parameter valuelength- the number of characters in the parameter data.- Throws:
SQLException- if parameterName does not correspond to a named parameter; if the driver does not support national character sets; if the driver can detect that a data conversion error could occur; if a database access error occurs or this method is called on a closedCallableStatementSQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- 1.6
-
setNClob
Sets the designated parameter to ajava.sql.NClobobject. The object implements thejava.sql.NClobinterface. ThisNClobobject maps to a SQLNCLOB.- Parameters:
parameterName- the name of the parameter to be setvalue- the parameter value- Throws:
SQLException- if parameterName does not correspond to a named parameter; if the driver does not support national character sets; if the driver can detect that a data conversion error could occur; if a database access error occurs or this method is called on a closedCallableStatementSQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- 1.6
-
setClob
Sets the designated parameter to aReaderobject. Thereadermust contain the number of characters specified by length otherwise aSQLExceptionwill be generated when theCallableStatementis executed. This method differs from thesetCharacterStream (int, Reader, int)method because it informs the driver that the parameter value should be sent to the server as aCLOB. When thesetCharacterStreammethod is used, the driver may have to do extra work to determine whether the parameter data should be send to the server as aLONGVARCHARor aCLOB- Parameters:
parameterName- the name of the parameter to be setreader- An object that contains the data to set the parameter value to.length- the number of characters in the parameter data.- Throws:
SQLException- if parameterName does not correspond to a named parameter; if the length specified is less than zero; a database access error occurs or this method is called on a closedCallableStatementSQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- 1.6
-
setBlob
Sets the designated parameter to anInputStreamobject. TheInputstreammust contain the number of characters specified by length, otherwise aSQLExceptionwill be generated when theCallableStatementis executed. This method differs from thesetBinaryStream (int, InputStream, int)method because it informs the driver that the parameter value should be sent to the server as aBLOB. When thesetBinaryStreammethod is used, the driver may have to do extra work to determine whether the parameter data should be sent to the server as aLONGVARBINARYor aBLOB- Parameters:
parameterName- the name of the parameter to be set the second is 2, ...inputStream- An object that contains the data to set the parameter value to.length- the number of bytes in the parameter data.- Throws:
SQLException- if parameterName does not correspond to a named parameter; if the length specified is less than zero; if the number of bytes in theInputStreamdoes not match the specified length; if a database access error occurs or this method is called on a closedCallableStatementSQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- 1.6
-
setNClob
Sets the designated parameter to aReaderobject. Thereadermust contain the number of characters specified by length otherwise aSQLExceptionwill be generated when theCallableStatementis executed. This method differs from thesetCharacterStream (int, Reader, int)method because it informs the driver that the parameter value should be sent to the server as aNCLOB. When thesetCharacterStreammethod is used, the driver may have to do extra work to determine whether the parameter data should be send to the server as aLONGNVARCHARor aNCLOB- Parameters:
parameterName- the name of the parameter to be setreader- An object that contains the data to set the parameter value to.length- the number of characters in the parameter data.- Throws:
SQLException- if parameterName does not correspond to a named parameter; if the length specified is less than zero; if the driver does not support national character sets; if the driver can detect that a data conversion error could occur; if a database access error occurs or this method is called on a closedCallableStatementSQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- 1.6
-
getNClob
Retrieves the value of the designated JDBCNCLOBparameter as ajava.sql.NClobobject in the Java programming language.- Parameters:
parameterIndex- the first parameter is 1, the second is 2, and so on- Returns:
- the parameter value as a
NClobobject in the Java programming language. If the value was SQLNULL, the valuenullis returned. - Throws:
SQLException- if the parameterIndex is not valid; if the driver does not support national character sets; if the driver can detect that a data conversion error could occur; if a database access error occurs or this method is called on a closedCallableStatementSQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- 1.6
-
getNClob
Retrieves the value of a JDBCNCLOBparameter as ajava.sql.NClobobject in the Java programming language.- Parameters:
parameterName- the name of the parameter- Returns:
- the parameter value as a
NClobobject in the Java programming language. If the value was SQLNULL, the valuenullis returned. - Throws:
SQLException- if parameterName does not correspond to a named parameter; if the driver does not support national character sets; if the driver can detect that a data conversion error could occur; if a database access error occurs or this method is called on a closedCallableStatementSQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- 1.6
-
setSQLXML
Sets the designated parameter to the givenjava.sql.SQLXMLobject. The driver converts this to anSQL XMLvalue when it sends it to the database.- Parameters:
parameterName- the name of the parameterxmlObject- aSQLXMLobject that maps anSQL XMLvalue- Throws:
SQLException- if parameterName does not correspond to a named parameter; if a database access error occurs; this method is called on a closedCallableStatementor thejava.xml.transform.Result,WriterorOutputStreamhas not been closed for theSQLXMLobjectSQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- 1.6
-
getSQLXML
Retrieves the value of the designatedSQL XMLparameter as ajava.sql.SQLXMLobject in the Java programming language.- Parameters:
parameterIndex- index of the first parameter is 1, the second is 2, ...- Returns:
- a
SQLXMLobject that maps anSQL XMLvalue - Throws:
SQLException- if the parameterIndex is not valid; if a database access error occurs or this method is called on a closedCallableStatementSQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- 1.6
-
getSQLXML
Retrieves the value of the designatedSQL XMLparameter as ajava.sql.SQLXMLobject in the Java programming language.- Parameters:
parameterName- the name of the parameter- Returns:
- a
SQLXMLobject that maps anSQL XMLvalue - Throws:
SQLException- if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closedCallableStatementSQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- 1.6
-
getNString
Retrieves the value of the designatedNCHAR,NVARCHARorLONGNVARCHARparameter as aStringin the Java programming language.For the fixed-length type JDBC
NCHAR, theStringobject returned has exactly the same value the SQLNCHARvalue had in the database, including any padding added by the database.- Parameters:
parameterIndex- index of the first parameter is 1, the second is 2, ...- Returns:
- a
Stringobject that maps anNCHAR,NVARCHARorLONGNVARCHARvalue - Throws:
SQLException- if the parameterIndex is not valid; if a database access error occurs or this method is called on a closedCallableStatementSQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- 1.6
- See Also:
-
getNString
Retrieves the value of the designatedNCHAR,NVARCHARorLONGNVARCHARparameter as aStringin the Java programming language.For the fixed-length type JDBC
NCHAR, theStringobject returned has exactly the same value the SQLNCHARvalue had in the database, including any padding added by the database.- Parameters:
parameterName- the name of the parameter- Returns:
- a
Stringobject that maps anNCHAR,NVARCHARorLONGNVARCHARvalue - Throws:
SQLException- if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closedCallableStatementSQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- 1.6
- See Also:
-
getNCharacterStream
Retrieves the value of the designated parameter as ajava.io.Readerobject in the Java programming language. It is intended for use when accessingNCHAR,NVARCHARandLONGNVARCHARparameters.- Parameters:
parameterIndex- the first parameter is 1, the second is 2, ...- Returns:
- a
java.io.Readerobject that contains the parameter value; if the value is SQLNULL, the value returned isnullin the Java programming language. - Throws:
SQLException- if the parameterIndex is not valid; if a database access error occurs or this method is called on a closedCallableStatementSQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- 1.6
-
getNCharacterStream
Retrieves the value of the designated parameter as ajava.io.Readerobject in the Java programming language. It is intended for use when accessingNCHAR,NVARCHARandLONGNVARCHARparameters.- Parameters:
parameterName- the name of the parameter- Returns:
- a
java.io.Readerobject that contains the parameter value; if the value is SQLNULL, the value returned isnullin the Java programming language - Throws:
SQLException- if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closedCallableStatementSQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- 1.6
-
getCharacterStream
Retrieves the value of the designated parameter as ajava.io.Readerobject in the Java programming language.- Parameters:
parameterIndex- the first parameter is 1, the second is 2, ...- Returns:
- a
java.io.Readerobject that contains the parameter value; if the value is SQLNULL, the value returned isnullin the Java programming language. - Throws:
SQLException- if the parameterIndex is not valid; if a database access error occurs or this method is called on a closedCallableStatement- Since:
- 1.6
-
getCharacterStream
Retrieves the value of the designated parameter as ajava.io.Readerobject in the Java programming language.- Parameters:
parameterName- the name of the parameter- Returns:
- a
java.io.Readerobject that contains the parameter value; if the value is SQLNULL, the value returned isnullin the Java programming language - Throws:
SQLException- if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closedCallableStatementSQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- 1.6
-
setBlob
Sets the designated parameter to the givenjava.sql.Blobobject. The driver converts this to an SQLBLOBvalue when it sends it to the database.- Parameters:
parameterName- the name of the parameterx- aBlobobject that maps an SQLBLOBvalue- Throws:
SQLException- if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closedCallableStatementSQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- 1.6
-
setClob
Sets the designated parameter to the givenjava.sql.Clobobject. The driver converts this to an SQLCLOBvalue when it sends it to the database.- Parameters:
parameterName- the name of the parameterx- aClobobject that maps an SQLCLOBvalue- Throws:
SQLException- if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closedCallableStatementSQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- 1.6
-
setAsciiStream
Sets 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.
- Parameters:
parameterName- the name of the parameterx- the Java input stream that contains the ASCII parameter valuelength- the number of bytes in the stream- Throws:
SQLException- if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closedCallableStatementSQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- 1.6
-
setBinaryStream
Sets 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.
- Parameters:
parameterName- the name of the parameterx- the java input stream which contains the binary parameter valuelength- the number of bytes in the stream- Throws:
SQLException- if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closedCallableStatementSQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- 1.6
-
setCharacterStream
Sets 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.
- Parameters:
parameterName- the name of the parameterreader- thejava.io.Readerobject that contains the UNICODE data used as the designated parameterlength- the number of characters in the stream- Throws:
SQLException- if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closedCallableStatementSQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- 1.6
-
setAsciiStream
Sets the designated parameter to the given input stream. 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.
Note: Consult your JDBC driver documentation to determine if it might be more efficient to use a version of
setAsciiStreamwhich takes a length parameter.- Parameters:
parameterName- the name of the parameterx- the Java input stream that contains the ASCII parameter value- Throws:
SQLException- if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closedCallableStatementSQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- 1.6
-
setBinaryStream
Sets the designated parameter to the given input stream. 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.
Note: Consult your JDBC driver documentation to determine if it might be more efficient to use a version of
setBinaryStreamwhich takes a length parameter.- Parameters:
parameterName- the name of the parameterx- the java input stream which contains the binary parameter value- Throws:
SQLException- if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closedCallableStatementSQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- 1.6
-
setCharacterStream
Sets the designated parameter to the givenReaderobject. 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.
Note: Consult your JDBC driver documentation to determine if it might be more efficient to use a version of
setCharacterStreamwhich takes a length parameter.- Parameters:
parameterName- the name of the parameterreader- thejava.io.Readerobject that contains the Unicode data- Throws:
SQLException- if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closedCallableStatementSQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- 1.6
-
setNCharacterStream
Sets the designated parameter to aReaderobject. TheReaderreads the data till end-of-file is reached. The driver does the necessary conversion from Java character format to the national character set in the database.Note: This stream object can either be a standard Java stream object or your own subclass that implements the standard interface.
Note: Consult your JDBC driver documentation to determine if it might be more efficient to use a version of
setNCharacterStreamwhich takes a length parameter.- Parameters:
parameterName- the name of the parametervalue- the parameter value- Throws:
SQLException- if parameterName does not correspond to a named parameter; if the driver does not support national character sets; if the driver can detect that a data conversion error could occur; if a database access error occurs; or this method is called on a closedCallableStatementSQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- 1.6
-
setClob
Sets the designated parameter to aReaderobject. This method differs from thesetCharacterStream (int, Reader)method because it informs the driver that the parameter value should be sent to the server as aCLOB. When thesetCharacterStreammethod is used, the driver may have to do extra work to determine whether the parameter data should be send to the server as aLONGVARCHARor aCLOBNote: Consult your JDBC driver documentation to determine if it might be more efficient to use a version of
setClobwhich takes a length parameter.- Parameters:
parameterName- the name of the parameterreader- An object that contains the data to set the parameter value to.- Throws:
SQLException- if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closedCallableStatementSQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- 1.6
-
setBlob
Sets the designated parameter to anInputStreamobject. This method differs from thesetBinaryStream (int, InputStream)method because it informs the driver that the parameter value should be sent to the server as aBLOB. When thesetBinaryStreammethod is used, the driver may have to do extra work to determine whether the parameter data should be send to the server as aLONGVARBINARYor aBLOBNote: Consult your JDBC driver documentation to determine if it might be more efficient to use a version of
setBlobwhich takes a length parameter.- Parameters:
parameterName- the name of the parameterinputStream- An object that contains the data to set the parameter value to.- Throws:
SQLException- if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closedCallableStatementSQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- 1.6
-
setNClob
Sets the designated parameter to aReaderobject. This method differs from thesetCharacterStream (int, Reader)method because it informs the driver that the parameter value should be sent to the server as aNCLOB. When thesetCharacterStreammethod is used, the driver may have to do extra work to determine whether the parameter data should be send to the server as aLONGNVARCHARor aNCLOBNote: Consult your JDBC driver documentation to determine if it might be more efficient to use a version of
setNClobwhich takes a length parameter.- Parameters:
parameterName- the name of the parameterreader- An object that contains the data to set the parameter value to.- Throws:
SQLException- if parameterName does not correspond to a named parameter; if the driver does not support national character sets; if the driver can detect that a data conversion error could occur; if a database access error occurs or this method is called on a closedCallableStatementSQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- 1.6
-
getObject
Returns an object representing the value of OUT parameterparameterIndexand will convert from the SQL type of the parameter to the requested Java data type, if the conversion is supported. If the conversion is not supported or null is specified for the type, aSQLExceptionis thrown.At a minimum, an implementation must support the conversions defined in Appendix B, Table B-3 and conversion of appropriate user defined SQL types to a Java type which implements
SQLData, orStruct. Additional conversions may be supported and are vendor defined.- Type Parameters:
T- the type of the class modeled by this Class object- Parameters:
parameterIndex- the first parameter is 1, the second is 2, and so ontype- Class representing the Java data type to convert the designated parameter to.- Returns:
- an instance of
typeholding the OUT parameter value - Throws:
SQLException- if conversion is not supported, type is null or another error occurs. The getCause() method of the exception may provide a more detailed exception, for example, if a conversion error occursSQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- 1.7
-
getObject
Returns an object representing the value of OUT parameterparameterNameand will convert from the SQL type of the parameter to the requested Java data type, if the conversion is supported. If the conversion is not supported or null is specified for the type, aSQLExceptionis thrown.At a minimum, an implementation must support the conversions defined in Appendix B, Table B-3 and conversion of appropriate user defined SQL types to a Java type which implements
SQLData, orStruct. Additional conversions may be supported and are vendor defined.- Type Parameters:
T- the type of the class modeled by this Class object- Parameters:
parameterName- the name of the parametertype- Class representing the Java data type to convert the designated parameter to.- Returns:
- an instance of
typeholding the OUT parameter value - Throws:
SQLException- if conversion is not supported, type is null or another error occurs. The getCause() method of the exception may provide a more detailed exception, for example, if a conversion error occursSQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- 1.7
-
setObject
default void setObject(String parameterName, Object x, SQLType targetSqlType, int scaleOrLength) throws SQLException Sets the value of the designated parameter with the given object. If the second argument is anInputStreamthen the stream must contain the number of bytes specified by scaleOrLength. If the second argument is aReaderthen the reader must contain the number of characters specified by scaleOrLength. If these conditions are not true the driver will generate aSQLExceptionwhen the prepared statement is executed.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,NClob,Struct,java.net.URL, 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.
The default implementation will throw
SQLFeatureNotSupportedException- Parameters:
parameterName- the name of the parameterx- the object containing the input parameter valuetargetSqlType- the SQL type to be sent to the database. The scale argument may further qualify this type.scaleOrLength- forjava.sql.JDBCType.DECIMALorjava.sql.JDBCType.NUMERIC types, this is the number of digits after the decimal point. For Java Object typesInputStreamandReader, this is the length of the data in the stream or reader. For all other types, this value will be ignored.- Throws:
SQLException- if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closedCallableStatementor if the Java Object specified by x is an InputStream or Reader object and the value of the scale parameter is less than zeroSQLFeatureNotSupportedException- if the JDBC driver does not support the specified targetSqlType- Since:
- 1.8
- See Also:
-
setObject
Sets the value of the designated parameter with the given object. This method is similar tosetObject(String parameterName, Object x, SQLType targetSqlType, int scaleOrLength), except that it assumes a scale of zero.The default implementation will throw
SQLFeatureNotSupportedException- Parameters:
parameterName- the name of the parameterx- the object containing the input parameter valuetargetSqlType- the SQL type to be sent to the database- Throws:
SQLException- if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closedCallableStatementSQLFeatureNotSupportedException- if the JDBC driver does not support the specified targetSqlType- Since:
- 1.8
- See Also:
-
registerOutParameter
Registers the OUT parameter in ordinal positionparameterIndexto the JDBC typesqlType. All OUT parameters must be registered before a stored procedure is executed.The JDBC type specified by
sqlTypefor an OUT parameter determines the Java type that must be used in thegetmethod to read the value of that parameter.If the JDBC type expected to be returned to this output parameter is specific to this particular database,
sqlTypemay beJDBCType.OTHERor aSQLTypethat is supported by the JDBC driver. The methodgetObject(int)retrieves the value.The default implementation will throw
SQLFeatureNotSupportedException- Parameters:
parameterIndex- the first parameter is 1, the second is 2, and so onsqlType- the JDBC type code defined bySQLTypeto use to register the OUT Parameter. If the parameter is of JDBC typeJDBCType.NUMERICorJDBCType.DECIMAL, the version ofregisterOutParameterthat accepts a scale value should be used.- Throws:
SQLException- if the parameterIndex is not valid; if a database access error occurs or this method is called on a closedCallableStatementSQLFeatureNotSupportedException- if the JDBC driver does not support the specified sqlType- Since:
- 1.8
- See Also:
-
registerOutParameter
default void registerOutParameter(int parameterIndex, SQLType sqlType, int scale) throws SQLException Registers the parameter in ordinal positionparameterIndexto be of JDBC typesqlType. All OUT parameters must be registered before a stored procedure is executed.The JDBC type specified by
sqlTypefor an OUT parameter determines the Java type that must be used in thegetmethod to read the value of that parameter.This version of
registerOutParametershould be used when the parameter is of JDBC typeJDBCType.NUMERICorJDBCType.DECIMAL.The default implementation will throw
SQLFeatureNotSupportedException- Parameters:
parameterIndex- the first parameter is 1, the second is 2, and so onsqlType- the JDBC type code defined bySQLTypeto use to register the OUT Parameter.scale- the desired number of digits to the right of the decimal point. It must be greater than or equal to zero.- Throws:
SQLException- if the parameterIndex is not valid; if a database access error occurs or this method is called on a closedCallableStatementSQLFeatureNotSupportedException- if the JDBC driver does not support the specified sqlType- Since:
- 1.8
- See Also:
-
registerOutParameter
default void registerOutParameter(int parameterIndex, SQLType sqlType, String typeName) throws SQLException Registers the designated output parameter. This version of the methodregisterOutParametershould be used for a user-defined orREFoutput parameter. Examples of user-defined types include:STRUCT,DISTINCT,JAVA_OBJECT, and named array types.All OUT parameters must be registered before a stored procedure is executed.
For a user-defined parameter, the fully-qualified SQL type name of the parameter should also be given, while a
REFparameter requires that the fully-qualified type name of the referenced type be given. A JDBC driver that does not need the type code and type name information may ignore it. To be portable, however, applications should always provide these values for user-defined andREFparameters. Although it is intended for user-defined andREFparameters, this method may be used to register a parameter of any JDBC type. If the parameter does not have a user-defined orREFtype, the typeName parameter is ignored.Note: When reading the value of an out parameter, you must use the getter method whose Java type corresponds to the parameter's registered SQL type.
The default implementation will throw
SQLFeatureNotSupportedException- Parameters:
parameterIndex- the first parameter is 1, the second is 2,...sqlType- the JDBC type code defined bySQLTypeto use to register the OUT Parameter.typeName- the fully-qualified name of an SQL structured type- Throws:
SQLException- if the parameterIndex is not valid; if a database access error occurs or this method is called on a closedCallableStatementSQLFeatureNotSupportedException- if the JDBC driver does not support the specified sqlType- Since:
- 1.8
- See Also:
-
registerOutParameter
Registers the OUT parameter namedparameterNameto the JDBC typesqlType. All OUT parameters must be registered before a stored procedure is executed.The JDBC type specified by
sqlTypefor an OUT parameter determines the Java type that must be used in thegetmethod to read the value of that parameter.If the JDBC type expected to be returned to this output parameter is specific to this particular database,
sqlTypeshould beJDBCType.OTHERor aSQLTypethat is supported by the JDBC driver.. The methodgetObject(int)retrieves the value.The default implementation will throw
SQLFeatureNotSupportedException- Parameters:
parameterName- the name of the parametersqlType- the JDBC type code defined bySQLTypeto use to register the OUT Parameter. If the parameter is of JDBC typeJDBCType.NUMERICorJDBCType.DECIMAL, the version ofregisterOutParameterthat accepts a scale value should be used.- Throws:
SQLException- if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closedCallableStatementSQLFeatureNotSupportedException- if the JDBC driver does not support the specified sqlType or if the JDBC driver does not support this method- Since:
- 1.8
- See Also:
-
registerOutParameter
default void registerOutParameter(String parameterName, SQLType sqlType, int scale) throws SQLException Registers the parameter namedparameterNameto be of JDBC typesqlType. All OUT parameters must be registered before a stored procedure is executed.The JDBC type specified by
sqlTypefor an OUT parameter determines the Java type that must be used in thegetmethod to read the value of that parameter.This version of
registerOutParametershould be used when the parameter is of JDBC typeJDBCType.NUMERICorJDBCType.DECIMAL.The default implementation will throw
SQLFeatureNotSupportedException- Parameters:
parameterName- the name of the parametersqlType- the JDBC type code defined bySQLTypeto use to register the OUT Parameter.scale- the desired number of digits to the right of the decimal point. It must be greater than or equal to zero.- Throws:
SQLException- if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closedCallableStatementSQLFeatureNotSupportedException- if the JDBC driver does not support the specified sqlType or if the JDBC driver does not support this method- Since:
- 1.8
- See Also:
-
registerOutParameter
default void registerOutParameter(String parameterName, SQLType sqlType, String typeName) throws SQLException Registers the designated output parameter. This version of the methodregisterOutParametershould be used for a user-named or REF output parameter. Examples of user-named types include: STRUCT, DISTINCT, JAVA_OBJECT, and named array types.All OUT parameters must be registered before a stored procedure is executed.
For a user-named parameter the fully-qualified SQL type name of the parameter should also be given, while a REF parameter requires that the fully-qualified type name of the referenced type be given. A JDBC driver that does not need the type code and type name information may ignore it. To be portable, however, applications should always provide these values for user-named and REF parameters. Although it is intended for user-named and REF parameters, this method may be used to register a parameter of any JDBC type. If the parameter does not have a user-named or REF type, the typeName parameter is ignored.Note: When reading the value of an out parameter, you must use the
getXXXmethod whose Java type XXX corresponds to the parameter's registered SQL type.The default implementation will throw
SQLFeatureNotSupportedException- Parameters:
parameterName- the name of the parametersqlType- the JDBC type code defined bySQLTypeto use to register the OUT Parameter.typeName- the fully-qualified name of an SQL structured type- Throws:
SQLException- if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closedCallableStatementSQLFeatureNotSupportedException- if the JDBC driver does not support the specified sqlType or if the JDBC driver does not support this method- Since:
- 1.8
- See Also:
-
getBigDecimal(int parameterIndex)orgetBigDecimal(String parameterName)