public interface CallableStatement extends PreparedStatement
{?= 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.
CLOSE_ALL_RESULTS, CLOSE_CURRENT_RESULT, EXECUTE_FAILED, KEEP_CURRENT_RESULT, NO_GENERATED_KEYS, RETURN_GENERATED_KEYS, SUCCESS_NO_INFO| Modifier and Type | Method and Description |
|---|---|
Array |
getArray(int parameterIndex)
Retrieves the value of the designated JDBC
ARRAY parameter as an
Array object in the Java programming language. |
Array |
getArray(String parameterName)
Retrieves the value of a JDBC
ARRAY parameter as an
Array object in the Java programming language. |
BigDecimal |
getBigDecimal(int parameterIndex)
Retrieves the value of the designated JDBC
NUMERIC parameter as a
java.math.BigDecimal object with as many digits to the
right of the decimal point as the value contains. |
BigDecimal |
getBigDecimal(int parameterIndex,
int scale)
Deprecated.
use
getBigDecimal(int parameterIndex)
or getBigDecimal(String parameterName) |
BigDecimal |
getBigDecimal(String parameterName)
Retrieves the value of a JDBC
NUMERIC parameter as a
java.math.BigDecimal object with as many digits to the
right of the decimal point as the value contains. |
Blob |
getBlob(int parameterIndex)
Retrieves the value of the designated JDBC
BLOB parameter as a
Blob object in the Java programming language. |
Blob |
getBlob(String parameterName)
Retrieves the value of a JDBC
BLOB parameter as a
Blob object in the Java programming language. |
boolean |
getBoolean(int parameterIndex)
Retrieves the value of the designated JDBC
BIT
or BOOLEAN parameter as a
boolean in the Java programming language. |
boolean |
getBoolean(String parameterName)
Retrieves the value of a JDBC
BIT or BOOLEAN
parameter as a
boolean in the Java programming language. |
byte |
getByte(int parameterIndex)
Retrieves the value of the designated JDBC
TINYINT parameter
as a byte in the Java programming language. |
byte |
getByte(String parameterName)
Retrieves the value of a JDBC
TINYINT parameter as a byte
in the Java programming language. |
byte[] |
getBytes(int parameterIndex)
Retrieves the value of the designated JDBC
BINARY or
VARBINARY parameter as an array of byte
values in the Java programming language. |
byte[] |
getBytes(String parameterName)
Retrieves the value of a JDBC
BINARY or VARBINARY
parameter as an array of byte values in the Java
programming language. |
Reader |
getCharacterStream(int parameterIndex)
Retrieves the value of the designated parameter as a
java.io.Reader object in the Java programming language. |
Reader |
getCharacterStream(String parameterName)
Retrieves the value of the designated parameter as a
java.io.Reader object in the Java programming language. |
Clob |
getClob(int parameterIndex)
Retrieves the value of the designated JDBC
CLOB parameter as a
java.sql.Clob object in the Java programming language. |
Clob |
getClob(String parameterName)
Retrieves the value of a JDBC
CLOB parameter as a
java.sql.Clob object in the Java programming language. |
Date |
getDate(int parameterIndex)
Retrieves the value of the designated JDBC
DATE parameter as a
java.sql.Date object. |
Date |
getDate(int parameterIndex,
Calendar cal)
Retrieves the value of the designated JDBC
DATE parameter as a
java.sql.Date object, using
the given Calendar object
to construct the date. |
Date |
getDate(String parameterName)
Retrieves the value of a JDBC
DATE parameter as a
java.sql.Date object. |
Date |
getDate(String parameterName,
Calendar cal)
Retrieves the value of a JDBC
DATE parameter as a
java.sql.Date object, using
the given Calendar object
to construct the date. |
double |
getDouble(int parameterIndex)
Retrieves the value of the designated JDBC
DOUBLE parameter as a double
in the Java programming language. |
double |
getDouble(String parameterName)
Retrieves the value of a JDBC
DOUBLE parameter as a double
in the Java programming language. |
float |
getFloat(int parameterIndex)
Retrieves the value of the designated JDBC
FLOAT parameter
as a float in the Java programming language. |
float |
getFloat(String parameterName)
Retrieves the value of a JDBC
FLOAT parameter as a float
in the Java programming language. |
int |
getInt(int parameterIndex)
Retrieves the value of the designated JDBC
INTEGER parameter
as an int in the Java programming language. |
int |
getInt(String parameterName)
Retrieves the value of a JDBC
INTEGER parameter as an int
in the Java programming language. |
long |
getLong(int parameterIndex)
Retrieves the value of the designated JDBC
BIGINT parameter
as a long in the Java programming language. |
long |
getLong(String parameterName)
Retrieves the value of a JDBC
BIGINT parameter as a long
in the Java programming language. |
Reader |
getNCharacterStream(int parameterIndex)
Retrieves the value of the designated parameter as a
java.io.Reader object in the Java programming language. |
Reader |
getNCharacterStream(String parameterName)
Retrieves the value of the designated parameter as a
java.io.Reader object in the Java programming language. |
NClob |
getNClob(int parameterIndex)
Retrieves the value of the designated JDBC
NCLOB parameter as a
java.sql.NClob object in the Java programming language. |
NClob |
getNClob(String parameterName)
Retrieves the value of a JDBC
NCLOB parameter as a
java.sql.NClob object in the Java programming language. |
String |
getNString(int parameterIndex)
Retrieves the value of the designated
NCHAR,
NVARCHAR
or LONGNVARCHAR parameter as
a String in the Java programming language. |
String |
getNString(String parameterName)
Retrieves the value of the designated
NCHAR,
NVARCHAR
or LONGNVARCHAR parameter as
a String in the Java programming language. |
Object |
getObject(int parameterIndex)
Retrieves the value of the designated parameter as an
Object
in the Java programming language. |
<T> T |
getObject(int parameterIndex,
Class<T> type)
Returns an object representing the value of OUT parameter
parameterIndex and will convert from the
SQL type of the parameter to the requested Java data type, if the
conversion is supported. |
Object |
getObject(int parameterIndex,
Map<String,Class<?>> map)
Returns an object representing the value of OUT parameter
parameterIndex and uses map for the custom
mapping of the parameter value. |
Object |
getObject(String parameterName)
Retrieves the value of a parameter as an
Object in the Java
programming language. |
<T> T |
getObject(String parameterName,
Class<T> type)
Returns an object representing the value of OUT parameter
parameterName and will convert from the
SQL type of the parameter to the requested Java data type, if the
conversion is supported. |
Object |
getObject(String parameterName,
Map<String,Class<?>> map)
Returns an object representing the value of OUT parameter
parameterName and uses map for the custom
mapping of the parameter value. |
Ref |
getRef(int parameterIndex)
Retrieves the value of the designated JDBC
REF(<structured-type>)
parameter as a Ref object in the Java programming language. |
Ref |
getRef(String parameterName)
Retrieves the value of a JDBC
REF(<structured-type>)
parameter as a Ref object in the Java programming language. |
RowId |
getRowId(int parameterIndex)
Retrieves the value of the designated JDBC
ROWID parameter as a
java.sql.RowId object. |
RowId |
getRowId(String parameterName)
Retrieves the value of the designated JDBC
ROWID parameter as a
java.sql.RowId object. |
short |
getShort(int parameterIndex)
Retrieves the value of the designated JDBC
SMALLINT parameter
as a short in the Java programming language. |
short |
getShort(String parameterName)
Retrieves the value of a JDBC
SMALLINT parameter as a short
in the Java programming language. |
SQLXML |
getSQLXML(int parameterIndex)
Retrieves the value of the designated
SQL XML parameter as a
java.sql.SQLXML object in the Java programming language. |
SQLXML |
getSQLXML(String parameterName)
Retrieves the value of the designated
SQL XML parameter as a
java.sql.SQLXML object in the Java programming language. |
String |
getString(int parameterIndex)
Retrieves the value of the designated JDBC
CHAR,
VARCHAR, or LONGVARCHAR parameter as a
String in the Java programming language. |
String |
getString(String parameterName)
Retrieves the value of a JDBC
CHAR, VARCHAR,
or LONGVARCHAR parameter as a String in
the Java programming language. |
Time |
getTime(int parameterIndex)
Retrieves the value of the designated JDBC
TIME parameter as a
java.sql.Time object. |
Time |
getTime(int parameterIndex,
Calendar cal)
Retrieves the value of the designated JDBC
TIME parameter as a
java.sql.Time object, using
the given Calendar object
to construct the time. |
Time |
getTime(String parameterName)
Retrieves the value of a JDBC
TIME parameter as a
java.sql.Time object. |
Time |
getTime(String parameterName,
Calendar cal)
Retrieves the value of a JDBC
TIME parameter as a
java.sql.Time object, using
the given Calendar object
to construct the time. |
Timestamp |
getTimestamp(int parameterIndex)
Retrieves the value of the designated JDBC
TIMESTAMP parameter as a
java.sql.Timestamp object. |
Timestamp |
getTimestamp(int parameterIndex,
Calendar cal)
Retrieves the value of the designated JDBC
TIMESTAMP parameter as a
java.sql.Timestamp object, using
the given Calendar object to construct
the Timestamp object. |
Timestamp |
getTimestamp(String parameterName)
Retrieves the value of a JDBC
TIMESTAMP parameter as a
java.sql.Timestamp object. |
Timestamp |
getTimestamp(String parameterName,
Calendar cal)
Retrieves the value of a JDBC
TIMESTAMP parameter as a
java.sql.Timestamp object, using
the given Calendar object to construct
the Timestamp object. |
URL |
getURL(int parameterIndex)
Retrieves the value of the designated JDBC
DATALINK parameter as a
java.net.URL object. |
URL |
getURL(String parameterName)
Retrieves the value of a JDBC
DATALINK parameter as a
java.net.URL object. |
void |
registerOutParameter(int parameterIndex,
int sqlType)
Registers the OUT parameter in ordinal position
parameterIndex to the JDBC type
sqlType. |
void |
registerOutParameter(int parameterIndex,
int sqlType,
int scale)
Registers the parameter in ordinal position
parameterIndex to be of JDBC type
sqlType. |
void |
registerOutParameter(int parameterIndex,
int sqlType,
String typeName)
Registers the designated output parameter.
|
default void |
registerOutParameter(int parameterIndex,
SQLType sqlType)
Registers the OUT parameter in ordinal position
parameterIndex to the JDBC type
sqlType. |
default void |
registerOutParameter(int parameterIndex,
SQLType sqlType,
int scale)
Registers the parameter in ordinal position
parameterIndex to be of JDBC type
sqlType. |
default void |
registerOutParameter(int parameterIndex,
SQLType sqlType,
String typeName)
Registers the designated output parameter.
|
void |
registerOutParameter(String parameterName,
int sqlType)
Registers the OUT parameter named
parameterName to the JDBC type
sqlType. |
void |
registerOutParameter(String parameterName,
int sqlType,
int scale)
Registers the parameter named
parameterName to be of JDBC type
sqlType. |
void |
registerOutParameter(String parameterName,
int sqlType,
String typeName)
Registers the designated output parameter.
|
default void |
registerOutParameter(String parameterName,
SQLType sqlType)
Registers the OUT parameter named
parameterName to the JDBC type
sqlType. |
default void |
registerOutParameter(String parameterName,
SQLType sqlType,
int scale)
Registers the parameter named
parameterName to be of JDBC type
sqlType. |
default void |
registerOutParameter(String parameterName,
SQLType sqlType,
String typeName)
Registers the designated output parameter.
|
void |
setAsciiStream(String parameterName,
InputStream x)
Sets the designated parameter to the given input stream.
|
void |
setAsciiStream(String parameterName,
InputStream x,
int length)
Sets the designated parameter to the given input stream, which will have
the specified number of bytes.
|
void |
setAsciiStream(String parameterName,
InputStream x,
long length)
Sets the designated parameter to the given input stream, which will have
the specified number of bytes.
|
void |
setBigDecimal(String parameterName,
BigDecimal x)
Sets the designated parameter to the given
java.math.BigDecimal value. |
void |
setBinaryStream(String parameterName,
InputStream x)
Sets the designated parameter to the given input stream.
|
void |
setBinaryStream(String parameterName,
InputStream x,
int length)
Sets the designated parameter to the given input stream, which will have
the specified number of bytes.
|
void |
setBinaryStream(String parameterName,
InputStream x,
long length)
Sets the designated parameter to the given input stream, which will have
the specified number of bytes.
|
void |
setBlob(String parameterName,
Blob x)
Sets the designated parameter to the given
java.sql.Blob object. |
void |
setBlob(String parameterName,
InputStream inputStream)
Sets the designated parameter to a
InputStream object. |
void |
setBlob(String parameterName,
InputStream inputStream,
long length)
Sets the designated parameter to a
InputStream object. |
void |
setBoolean(String parameterName,
boolean x)
Sets the designated parameter to the given Java
boolean value. |
void |
setByte(String parameterName,
byte x)
Sets the designated parameter to the given Java
byte value. |
void |
setBytes(String parameterName,
byte[] x)
Sets the designated parameter to the given Java array of bytes.
|
void |
setCharacterStream(String parameterName,
Reader reader)
Sets the designated parameter to the given
Reader
object. |
void |
setCharacterStream(String parameterName,
Reader reader,
int length)
Sets the designated parameter to the given
Reader
object, which is the given number of characters long. |
void |
setCharacterStream(String parameterName,
Reader reader,
long length)
Sets the designated parameter to the given
Reader
object, which is the given number of characters long. |
void |
setClob(String parameterName,
Clob x)
Sets the designated parameter to the given
java.sql.Clob object. |
void |
setClob(String parameterName,
Reader reader)
Sets the designated parameter to a
Reader object. |
void |
setClob(String parameterName,
Reader reader,
long length)
Sets the designated parameter to a
Reader object. |
void |
setDate(String parameterName,
Date x)
Sets the designated parameter to the given
java.sql.Date value
using the default time zone of the virtual machine that is running
the application. |
void |
setDate(String parameterName,
Date x,
Calendar cal)
Sets the designated parameter to the given
java.sql.Date value,
using the given Calendar object. |
void |
setDouble(String parameterName,
double x)
Sets the designated parameter to the given Java
double value. |
void |
setFloat(String parameterName,
float x)
Sets the designated parameter to the given Java
float value. |
void |
setInt(String parameterName,
int x)
Sets the designated parameter to the given Java
int value. |
void |
setLong(String parameterName,
long x)
Sets the designated parameter to the given Java
long value. |
void |
setNCharacterStream(String parameterName,
Reader value)
Sets the designated parameter to a
Reader object. |
void |
setNCharacterStream(String parameterName,
Reader value,
long length)
Sets the designated parameter to a
Reader object. |
void |
setNClob(String parameterName,
NClob value)
Sets the designated parameter to a
java.sql.NClob object. |
void |
setNClob(String parameterName,
Reader reader)
Sets the designated parameter to a
Reader object. |
void |
setNClob(String parameterName,
Reader reader,
long length)
Sets the designated parameter to a
Reader object. |
void |
setNString(String parameterName,
String value)
Sets the designated parameter to the given
String object. |
void |
setNull(String parameterName,
int sqlType)
Sets the designated parameter to SQL
NULL. |
void |
setNull(String parameterName,
int sqlType,
String typeName)
Sets the designated parameter to SQL
NULL. |
void |
setObject(String parameterName,
Object x)
Sets the value of the designated parameter with the given object.
|
void |
setObject(String parameterName,
Object x,
int targetSqlType)
Sets the value of the designated parameter with the given object.
|
void |
setObject(String parameterName,
Object x,
int targetSqlType,
int scale)
Sets the value of the designated parameter with the given object.
|
default void |
setObject(String parameterName,
Object x,
SQLType targetSqlType)
Sets the value of the designated parameter with the given object.
|
default void |
setObject(String parameterName,
Object x,
SQLType targetSqlType,
int scaleOrLength)
Sets the value of the designated parameter with the given object.
|
void |
setRowId(String parameterName,
RowId x)
Sets the designated parameter to the given
java.sql.RowId object. |
void |
setShort(String parameterName,
short x)
Sets the designated parameter to the given Java
short value. |
void |
setSQLXML(String parameterName,
SQLXML xmlObject)
Sets the designated parameter to the given
java.sql.SQLXML object. |
void |
setString(String parameterName,
String x)
Sets the designated parameter to the given Java
String value. |
void |
setTime(String parameterName,
Time x)
Sets the designated parameter to the given
java.sql.Time value. |
void |
setTime(String parameterName,
Time x,
Calendar cal)
Sets the designated parameter to the given
java.sql.Time value,
using the given Calendar object. |
void |
setTimestamp(String parameterName,
Timestamp x)
Sets the designated parameter to the given
java.sql.Timestamp value. |
void |
setTimestamp(String parameterName,
Timestamp x,
Calendar cal)
Sets the designated parameter to the given
java.sql.Timestamp value,
using the given Calendar object. |
void |
setURL(String parameterName,
URL val)
Sets the designated parameter to the given
java.net.URL object. |
boolean |
wasNull()
Retrieves whether the last OUT parameter read had the value of
SQL
NULL. |
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, setURLaddBatch, cancel, clearBatch, clearWarnings, close, closeOnCompletion, execute, execute, execute, execute, executeBatch, executeLargeBatch, executeLargeUpdate, executeLargeUpdate, executeLargeUpdate, executeLargeUpdate, executeQuery, executeUpdate, executeUpdate, executeUpdate, executeUpdate, getConnection, getFetchDirection, getFetchSize, getGeneratedKeys, getLargeMaxRows, getLargeUpdateCount, getMaxFieldSize, getMaxRows, getMoreResults, getMoreResults, getQueryTimeout, getResultSet, getResultSetConcurrency, getResultSetHoldability, getResultSetType, getUpdateCount, getWarnings, isClosed, isCloseOnCompletion, isPoolable, setCursorName, setEscapeProcessing, setFetchDirection, setFetchSize, setLargeMaxRows, setMaxFieldSize, setMaxRows, setPoolable, setQueryTimeoutisWrapperFor, unwrapvoid registerOutParameter(int parameterIndex,
int sqlType)
throws SQLException
parameterIndex to the JDBC type
sqlType. All OUT parameters must be registered
before a stored procedure is executed.
The JDBC type specified by sqlType for an OUT
parameter determines the Java type that must be used
in the get method 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, sqlType
should be java.sql.Types.OTHER. The method
getObject(int) retrieves the value.
SQLException - if the parameterIndex is not valid;
if a database access error occurs or
this method is called on a closed CallableStatementSQLFeatureNotSupportedException - if sqlType is
a ARRAY, BLOB, CLOB,
DATALINK, JAVA_OBJECT, NCHAR,
NCLOB, NVARCHAR, LONGNVARCHAR,
REF, ROWID, SQLXML
or STRUCT data type and the JDBC driver does not support
this data typeparameterIndex - the first parameter is 1, the second is 2,
and so onsqlType - the JDBC type code defined by java.sql.Types.
If the parameter is of JDBC type NUMERIC
or DECIMAL, the version of
registerOutParameter that accepts a scale value
should be used.Typesvoid registerOutParameter(int parameterIndex,
int sqlType,
int scale)
throws SQLException
parameterIndex to be of JDBC type
sqlType. All OUT parameters must be registered
before a stored procedure is executed.
The JDBC type specified by sqlType for an OUT
parameter determines the Java type that must be used
in the get method to read the value of that parameter.
This version of registerOutParameter should be
used when the parameter is of JDBC type NUMERIC
or DECIMAL.
SQLException - if the parameterIndex is not valid;
if a database access error occurs or
this method is called on a closed CallableStatementSQLFeatureNotSupportedException - if sqlType is
a ARRAY, BLOB, CLOB,
DATALINK, JAVA_OBJECT, NCHAR,
NCLOB, NVARCHAR, LONGNVARCHAR,
REF, ROWID, SQLXML
or STRUCT data type and the JDBC driver does not support
this data typeparameterIndex - the first parameter is 1, the second is 2,
and so onsqlType - the SQL type code defined by java.sql.Types.scale - the desired number of digits to the right of the
decimal point. It must be greater than or equal to zero.Typesboolean wasNull()
throws SQLException
NULL. Note that this method should be called only after
calling a getter method; otherwise, there is no value to use in
determining whether it is null or not.SQLException - if a database access error occurs or
this method is called on a closed CallableStatementtrue if the last parameter read was SQL
NULL; false otherwiseString getString(int parameterIndex) throws SQLException
CHAR,
VARCHAR, or LONGVARCHAR parameter as a
String in the Java programming language.
For the fixed-length type JDBC CHAR,
the String object
returned has exactly the same value the SQL
CHAR value had in the
database, including any padding added by the database.
SQLException - if the parameterIndex is not valid;
if a database access error occurs or
this method is called on a closed CallableStatementparameterIndex - the first parameter is 1, the second is 2,
and so onNULL,
the result
is null.setString(java.lang.String, java.lang.String)boolean getBoolean(int parameterIndex)
throws SQLException
BIT
or BOOLEAN parameter as a
boolean in the Java programming language.SQLException - if the parameterIndex is not valid;
if a database access error occurs or
this method is called on a closed CallableStatementparameterIndex - the first parameter is 1, the second is 2,
and so onNULL,
the result is false.setBoolean(java.lang.String, boolean)byte getByte(int parameterIndex)
throws SQLException
TINYINT parameter
as a byte in the Java programming language.SQLException - if the parameterIndex is not valid;
if a database access error occurs or
this method is called on a closed CallableStatementparameterIndex - the first parameter is 1, the second is 2,
and so onNULL, the result
is 0.setByte(java.lang.String, byte)short getShort(int parameterIndex)
throws SQLException
SMALLINT parameter
as a short in the Java programming language.SQLException - if the parameterIndex is not valid;
if a database access error occurs or
this method is called on a closed CallableStatementparameterIndex - the first parameter is 1, the second is 2,
and so onNULL, the result
is 0.setShort(java.lang.String, short)int getInt(int parameterIndex)
throws SQLException
INTEGER parameter
as an int in the Java programming language.SQLException - if the parameterIndex is not valid;
if a database access error occurs or
this method is called on a closed CallableStatementparameterIndex - the first parameter is 1, the second is 2,
and so onNULL, the result
is 0.setInt(java.lang.String, int)long getLong(int parameterIndex)
throws SQLException
BIGINT parameter
as a long in the Java programming language.SQLException - if the parameterIndex is not valid;
if a database access error occurs or
this method is called on a closed CallableStatementparameterIndex - the first parameter is 1, the second is 2,
and so onNULL, the result
is 0.setLong(java.lang.String, long)float getFloat(int parameterIndex)
throws SQLException
FLOAT parameter
as a float in the Java programming language.SQLException - if the parameterIndex is not valid;
if a database access error occurs or
this method is called on a closed CallableStatementparameterIndex - the first parameter is 1, the second is 2,
and so onNULL, the result
is 0.setFloat(java.lang.String, float)double getDouble(int parameterIndex)
throws SQLException
DOUBLE parameter as a double
in the Java programming language.SQLException - if the parameterIndex is not valid;
if a database access error occurs or
this method is called on a closed CallableStatementparameterIndex - the first parameter is 1, the second is 2,
and so onNULL, the result
is 0.setDouble(java.lang.String, double)@Deprecated BigDecimal getBigDecimal(int parameterIndex, int scale) throws SQLException
getBigDecimal(int parameterIndex)
or getBigDecimal(String parameterName)NUMERIC parameter as a
java.math.BigDecimal object with scale digits to
the right of the decimal point.SQLException - if the parameterIndex is not valid;
if a database access error occurs or
this method is called on a closed CallableStatementSQLFeatureNotSupportedException - if the JDBC driver does not support
this methodparameterIndex - the first parameter is 1, the second is 2,
and so onscale - the number of digits to the right of the decimal pointNULL, the result
is null.setBigDecimal(java.lang.String, java.math.BigDecimal)byte[] getBytes(int parameterIndex)
throws SQLException
BINARY or
VARBINARY parameter as an array of byte
values in the Java programming language.SQLException - if the parameterIndex is not valid;
if a database access error occurs or
this method is called on a closed CallableStatementparameterIndex - the first parameter is 1, the second is 2,
and so onNULL, the result
is null.setBytes(java.lang.String, byte[])Date getDate(int parameterIndex) throws SQLException
DATE parameter as a
java.sql.Date object.SQLException - if the parameterIndex is not valid;
if a database access error occurs or
this method is called on a closed CallableStatementparameterIndex - the first parameter is 1, the second is 2,
and so onNULL, the result
is null.setDate(java.lang.String, java.sql.Date)Time getTime(int parameterIndex) throws SQLException
TIME parameter as a
java.sql.Time object.SQLException - if the parameterIndex is not valid;
if a database access error occurs or
this method is called on a closed CallableStatementparameterIndex - the first parameter is 1, the second is 2,
and so onNULL, the result
is null.setTime(java.lang.String, java.sql.Time)Timestamp getTimestamp(int parameterIndex) throws SQLException
TIMESTAMP parameter as a
java.sql.Timestamp object.SQLException - if the parameterIndex is not valid;
if a database access error occurs or
this method is called on a closed CallableStatementparameterIndex - the first parameter is 1, the second is 2,
and so onNULL, the result
is null.setTimestamp(java.lang.String, java.sql.Timestamp)Object getObject(int parameterIndex) throws SQLException
Object
in the Java programming language. If the value is an SQL NULL,
the driver returns a Java null.
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 as java.sql.Types.OTHER, this method can be used
to read database-specific abstract data types.
SQLException - if the parameterIndex is not valid;
if a database access error occurs or
this method is called on a closed CallableStatementparameterIndex - the first parameter is 1, the second is 2,
and so onjava.lang.Object holding the OUT parameter valueTypes,
setObject(java.lang.String, java.lang.Object, int, int)BigDecimal getBigDecimal(int parameterIndex) throws SQLException
NUMERIC parameter as a
java.math.BigDecimal object with as many digits to the
right of the decimal point as the value contains.SQLException - if the parameterIndex is not valid;
if a database access error occurs or
this method is called on a closed CallableStatementparameterIndex - the first parameter is 1, the second is 2,
and so onNULL, the result is null.setBigDecimal(java.lang.String, java.math.BigDecimal)Object getObject(int parameterIndex, Map<String,Class<?>> map) throws SQLException
parameterIndex and uses map for 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 as java.sql.Types.OTHER, this method can
be used to read database-specific abstract data types.
SQLException - if the parameterIndex is not valid;
if a database access error occurs or
this method is called on a closed CallableStatementSQLFeatureNotSupportedException - if the JDBC driver does not support
this methodparameterIndex - the first parameter is 1, the second is 2, and so onmap - the mapping from SQL type names to Java classesjava.lang.Object holding the OUT parameter valuesetObject(java.lang.String, java.lang.Object, int, int)Ref getRef(int parameterIndex) throws SQLException
REF(<structured-type>)
parameter as a Ref object in the Java programming language.SQLException - if the parameterIndex is not valid;
if a database access error occurs or
this method is called on a closed CallableStatementSQLFeatureNotSupportedException - if the JDBC driver does not support
this methodparameterIndex - the first parameter is 1, the second is 2,
and so onRef object in the
Java programming language. If the value was SQL NULL, the value
null is returned.Blob getBlob(int parameterIndex) throws SQLException
BLOB parameter as a
Blob object in the Java programming language.SQLException - if the parameterIndex is not valid;
if a database access error occurs or
this method is called on a closed CallableStatementSQLFeatureNotSupportedException - if the JDBC driver does not support
this methodparameterIndex - the first parameter is 1, the second is 2, and so onBlob object in the
Java programming language. If the value was SQL NULL, the value
null is returned.Clob getClob(int parameterIndex) throws SQLException
CLOB parameter as a
java.sql.Clob object in the Java programming language.SQLException - if the parameterIndex is not valid;
if a database access error occurs or
this method is called on a closed CallableStatementSQLFeatureNotSupportedException - if the JDBC driver does not support
this methodparameterIndex - the first parameter is 1, the second is 2, and
so onClob object in the
Java programming language. If the value was SQL NULL, the
value null is returned.Array getArray(int parameterIndex) throws SQLException
ARRAY parameter as an
Array object in the Java programming language.SQLException - if the parameterIndex is not valid;
if a database access error occurs or
this method is called on a closed CallableStatementSQLFeatureNotSupportedException - if the JDBC driver does not support
this methodparameterIndex - the first parameter is 1, the second is 2, and
so onArray object in
the Java programming language. If the value was SQL NULL, the
value null is returned.Date getDate(int parameterIndex, Calendar cal) throws SQLException
DATE parameter as a
java.sql.Date object, using
the given Calendar object
to construct the date.
With a Calendar object, the driver
can calculate the date taking into account a custom timezone and locale.
If no Calendar object is specified, the driver uses the
default timezone and locale.SQLException - if the parameterIndex is not valid;
if a database access error occurs or
this method is called on a closed CallableStatementparameterIndex - the first parameter is 1, the second is 2,
and so oncal - the Calendar object the driver will use
to construct the dateNULL, the result
is null.setDate(java.lang.String, java.sql.Date)Time getTime(int parameterIndex, Calendar cal) throws SQLException
TIME parameter as a
java.sql.Time object, using
the given Calendar object
to construct the time.
With a Calendar object, the driver
can calculate the time taking into account a custom timezone and locale.
If no Calendar object is specified, the driver uses the
default timezone and locale.SQLException - if the parameterIndex is not valid;
if a database access error occurs or
this method is called on a closed CallableStatementparameterIndex - the first parameter is 1, the second is 2,
and so oncal - the Calendar object the driver will use
to construct the timeNULL, the result
is null.setTime(java.lang.String, java.sql.Time)Timestamp getTimestamp(int parameterIndex, Calendar cal) throws SQLException
TIMESTAMP parameter as a
java.sql.Timestamp object, using
the given Calendar object to construct
the Timestamp object.
With a Calendar object, the driver
can calculate the timestamp taking into account a custom timezone and locale.
If no Calendar object is specified, the driver uses the
default timezone and locale.SQLException - if the parameterIndex is not valid;
if a database access error occurs or
this method is called on a closed CallableStatementparameterIndex - the first parameter is 1, the second is 2,
and so oncal - the Calendar object the driver will use
to construct the timestampNULL, the result
is null.setTimestamp(java.lang.String, java.sql.Timestamp)void registerOutParameter(int parameterIndex,
int sqlType,
String typeName)
throws SQLException
registerOutParameter
should be used for a user-defined or REF output 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 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-defined and REF parameters.
Although it is intended for user-defined and REF parameters,
this method may be used to register a parameter of any JDBC type.
If the parameter does not have a user-defined or REF type, 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.
SQLException - if the parameterIndex is not valid;
if a database access error occurs or
this method is called on a closed CallableStatementSQLFeatureNotSupportedException - if sqlType is
a ARRAY, BLOB, CLOB,
DATALINK, JAVA_OBJECT, NCHAR,
NCLOB, NVARCHAR, LONGNVARCHAR,
REF, ROWID, SQLXML
or STRUCT data type and the JDBC driver does not support
this data typeparameterIndex - the first parameter is 1, the second is 2,...sqlType - a value from TypestypeName - the fully-qualified name of an SQL structured typeTypesvoid registerOutParameter(String parameterName, int sqlType) throws SQLException
parameterName to the JDBC type
sqlType. All OUT parameters must be registered
before a stored procedure is executed.
The JDBC type specified by sqlType for an OUT
parameter determines the Java type that must be used
in the get method 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, sqlType
should be java.sql.Types.OTHER. The method
getObject(int) retrieves the value.
SQLException - if parameterName does not correspond to a named
parameter; if a database access error occurs or
this method is called on a closed CallableStatementSQLFeatureNotSupportedException - if sqlType is
a ARRAY, BLOB, CLOB,
DATALINK, JAVA_OBJECT, NCHAR,
NCLOB, NVARCHAR, LONGNVARCHAR,
REF, ROWID, SQLXML
or STRUCT data type and the JDBC driver does not support
this data type or if the JDBC driver does not support
this methodparameterName - the name of the parametersqlType - the JDBC type code defined by java.sql.Types.
If the parameter is of JDBC type NUMERIC
or DECIMAL, the version of
registerOutParameter that accepts a scale value
should be used.Typesvoid registerOutParameter(String parameterName, int sqlType, int scale) throws SQLException
parameterName to be of JDBC type
sqlType. All OUT parameters must be registered
before a stored procedure is executed.
The JDBC type specified by sqlType for an OUT
parameter determines the Java type that must be used
in the get method to read the value of that parameter.
This version of registerOutParameter should be
used when the parameter is of JDBC type NUMERIC
or DECIMAL.
SQLException - if parameterName does not correspond to a named
parameter; if a database access error occurs or
this method is called on a closed CallableStatementSQLFeatureNotSupportedException - if sqlType is
a ARRAY, BLOB, CLOB,
DATALINK, JAVA_OBJECT, NCHAR,
NCLOB, NVARCHAR, LONGNVARCHAR,
REF, ROWID, SQLXML
or STRUCT data type and the JDBC driver does not support
this data type or if the JDBC driver does not support
this methodparameterName - the name of the parametersqlType - SQL type code defined by java.sql.Types.scale - the desired number of digits to the right of the
decimal point. It must be greater than or equal to zero.Typesvoid registerOutParameter(String parameterName, int sqlType, String typeName) throws SQLException
registerOutParameter
should 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 getXXX method whose Java type XXX corresponds to the
parameter's registered SQL type.
SQLException - if parameterName does not correspond to a named
parameter; if a database access error occurs or
this method is called on a closed CallableStatementSQLFeatureNotSupportedException - if sqlType is
a ARRAY, BLOB, CLOB,
DATALINK, JAVA_OBJECT, NCHAR,
NCLOB, NVARCHAR, LONGNVARCHAR,
REF, ROWID, SQLXML
or STRUCT data type and the JDBC driver does not support
this data type or if the JDBC driver does not support
this methodparameterName - the name of the parametersqlType - a value from TypestypeName - the fully-qualified name of an SQL structured typeTypesURL getURL(int parameterIndex) throws SQLException
DATALINK parameter as a
java.net.URL object.SQLException - if the parameterIndex is not valid;
if a database access error occurs,
this method is called on a closed CallableStatement,
or if the URL being returned is
not a valid URL on the Java platformSQLFeatureNotSupportedException - if the JDBC driver does not support
this methodparameterIndex - the first parameter is 1, the second is 2,...java.net.URL object that represents the
JDBC DATALINK value used as the designated
parametersetURL(java.lang.String, java.net.URL)void setURL(String parameterName, URL val) throws SQLException
java.net.URL object.
The driver converts this to an SQL DATALINK value when
it sends it to the database.SQLException - if parameterName does not correspond to a named
parameter; if a database access error occurs;
this method is called on a closed CallableStatement
or if a URL is malformedSQLFeatureNotSupportedException - if the JDBC driver does not support
this methodparameterName - the name of the parameterval - the parameter valuegetURL(int)void setNull(String parameterName, int sqlType) throws SQLException
NULL.
Note: You must specify the parameter's SQL type.
SQLException - if parameterName does not correspond to a named
parameter; if a database access error occurs or
this method is called on a closed CallableStatementSQLFeatureNotSupportedException - if the JDBC driver does not support
this methodparameterName - the name of the parametersqlType - the SQL type code defined in java.sql.Typesvoid setBoolean(String parameterName, boolean x) throws SQLException
boolean value.
The driver converts this
to an SQL BIT or BOOLEAN value when it sends it to the database.SQLException - if parameterName does not correspond to a named
parameter; if a database access error occurs or
this method is called on a closed CallableStatementSQLFeatureNotSupportedException - if the JDBC driver does not support
this methodparameterName - the name of the parameterx - the parameter valuegetBoolean(int)void setByte(String parameterName, byte x) throws SQLException
byte value.
The driver converts this
to an SQL TINYINT value when it sends it to the database.SQLException - if parameterName does not correspond to a named
parameter; if a database access error occurs or
this method is called on a closed CallableStatementSQLFeatureNotSupportedException - if the JDBC driver does not support
this methodparameterName - the name of the parameterx - the parameter valuegetByte(int)void setShort(String parameterName, short x) throws SQLException
short value.
The driver converts this
to an SQL SMALLINT value when it sends it to the database.SQLException - if parameterName does not correspond to a named
parameter; if a database access error occurs or
this method is called on a closed CallableStatementSQLFeatureNotSupportedException - if the JDBC driver does not support
this methodparameterName - the name of the parameterx - the parameter valuegetShort(int)void setInt(String parameterName, int x) throws SQLException
int value.
The driver converts this
to an SQL INTEGER value when it sends it to the database.SQLException - if parameterName does not correspond to a named
parameter; if a database access error occurs or
this method is called on a closed CallableStatementSQLFeatureNotSupportedException - if the JDBC driver does not support
this methodparameterName - the name of the parameterx - the parameter valuegetInt(int)void setLong(String parameterName, long x) throws SQLException
long value.
The driver converts this
to an SQL BIGINT value when it sends it to the database.SQLException - if parameterName does not correspond to a named
parameter; if a database access error occurs or
this method is called on a closed CallableStatementSQLFeatureNotSupportedException - if the JDBC driver does not support
this methodparameterName - the name of the parameterx - the parameter valuegetLong(int)void setFloat(String parameterName, float x) throws SQLException
float value.
The driver converts this
to an SQL FLOAT value when it sends it to the database.SQLException - if parameterName does not correspond to a named
parameter; if a database access error occurs or
this method is called on a closed CallableStatementSQLFeatureNotSupportedException - if the JDBC driver does not support
this methodparameterName - the name of the parameterx - the parameter valuegetFloat(int)void setDouble(String parameterName, double x) throws SQLException
double value.
The driver converts this
to an SQL DOUBLE value when it sends it to the database.SQLException - if parameterName does not correspond to a named
parameter; if a database access error occurs or
this method is called on a closed CallableStatementSQLFeatureNotSupportedException - if the JDBC driver does not support
this methodparameterName - the name of the parameterx - the parameter valuegetDouble(int)void setBigDecimal(String parameterName, BigDecimal x) throws SQLException
java.math.BigDecimal value.
The driver converts this to an SQL NUMERIC value when
it sends it to the database.SQLException - if parameterName does not correspond to a named
parameter; if a database access error occurs or
this method is called on a closed CallableStatementSQLFeatureNotSupportedException - if the JDBC driver does not support
this methodparameterName - the name of the parameterx - the parameter valuegetBigDecimal(int, int)void setString(String parameterName, String x) throws SQLException
String value.
The driver converts this
to an SQL VARCHAR or LONGVARCHAR value
(depending on the argument's
size relative to the driver's limits on VARCHAR values)
when it sends it to the database.SQLException - if parameterName does not correspond to a named
parameter; if a database access error occurs or
this method is called on a closed CallableStatementSQLFeatureNotSupportedException - if the JDBC driver does not support
this methodparameterName - the name of the parameterx - the parameter valuegetString(int)void setBytes(String parameterName, byte[] x) throws SQLException
VARBINARY or
LONGVARBINARY (depending on the argument's size relative
to the driver's limits on VARBINARY values) when it sends
it to the database.SQLException - if parameterName does not correspond to a named
parameter; if a database access error occurs or
this method is called on a closed CallableStatementSQLFeatureNotSupportedException - if the JDBC driver does not support
this methodparameterName - the name of the parameterx - the parameter valuegetBytes(int)void setDate(String parameterName, Date x) throws SQLException
java.sql.Date value
using the default time zone of the virtual machine that is running
the application.
The driver converts this
to an SQL DATE value when it sends it to the database.SQLException - if parameterName does not correspond to a named
parameter; if a database access error occurs or
this method is called on a closed CallableStatementSQLFeatureNotSupportedException - if the JDBC driver does not support
this methodparameterName - the name of the parameterx - the parameter valuegetDate(int)void setTime(String parameterName, Time x) throws SQLException
java.sql.Time value.
The driver converts this
to an SQL TIME value when it sends it to the database.SQLException - if parameterName does not correspond to a named
parameter; if a database access error occurs or
this method is called on a closed CallableStatementSQLFeatureNotSupportedException - if the JDBC driver does not support
this methodparameterName - the name of the parameterx - the parameter valuegetTime(int)void setTimestamp(String parameterName, Timestamp x) throws SQLException
java.sql.Timestamp value.
The driver
converts this to an SQL TIMESTAMP value when it sends it to the
database.SQLException - if parameterName does not correspond to a named
parameter; if a database access error occurs or
this method is called on a closed CallableStatementSQLFeatureNotSupportedException - if the JDBC driver does not support
this methodparameterName - the name of the parameterx - the parameter valuegetTimestamp(int)void setAsciiStream(String parameterName, InputStream x, int length) throws SQLException
LONGVARCHAR
parameter, it may be more practical to send it via a
java.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.
SQLException - if parameterName does not correspond to a named
parameter; if a database access error occurs or
this method is called on a closed CallableStatementSQLFeatureNotSupportedException - if the JDBC driver does not support
this methodparameterName - the name of the parameterx - the Java input stream that contains the ASCII parameter valuelength - the number of bytes in the streamvoid setBinaryStream(String parameterName, InputStream x, int length) throws SQLException
LONGVARBINARY
parameter, it may be more practical to send it via a
java.io.InputStream object. 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.
SQLException - if parameterName does not correspond to a named
parameter; if a database access error occurs or
this method is called on a closed CallableStatementSQLFeatureNotSupportedException - if the JDBC driver does not support
this methodparameterName - the name of the parameterx - the java input stream which contains the binary parameter valuelength - the number of bytes in the streamvoid setObject(String parameterName, Object x, int targetSqlType, int scale) throws SQLException
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 method SQLData.writeSQL to write it
to the SQL data stream.
If, on the other hand, the object is of a class implementing
Ref, Blob, Clob, NClob,
Struct, java.net.URL,
or Array, 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.
SQLException - if parameterName does not correspond to a named
parameter; if a database access error occurs or
this method is called on a closed CallableStatementSQLFeatureNotSupportedException - if
the JDBC driver does not support the specified targetSqlTypeparameterName - 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.Types,
getObject(int)void setObject(String parameterName, Object x, int targetSqlType) throws SQLException
setObject(String parameterName,
Object x, int targetSqlType, int scaleOrLength),
except that it assumes a scale of zero.SQLException - if parameterName does not correspond to a named
parameter; if a database access error occurs or
this method is called on a closed CallableStatementSQLFeatureNotSupportedException - if
the JDBC driver does not support the specified targetSqlTypeparameterName - 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 databasegetObject(int)void setObject(String parameterName, Object x) throws SQLException
The JDBC specification specifies a standard mapping from
Java Object types 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 datatabase-
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 method SQLData.writeSQL
to write it to the SQL data stream.
If, on the other hand, the object is of a class implementing
Ref, Blob, Clob, NClob,
Struct, java.net.URL,
or Array, 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 setNull or the
setObject(String parameterName, Object x, int sqlType)
method should be used
instead of setObject(String parameterName, Object x).
SQLException - if parameterName does not correspond to a named
parameter; if a database access error occurs,
this method is called on a closed CallableStatement or if the given
Object parameter is ambiguousSQLFeatureNotSupportedException - if the JDBC driver does not support
this methodparameterName - the name of the parameterx - the object containing the input parameter valuegetObject(int)void setCharacterStream(String parameterName, Reader reader, int length) throws SQLException
Reader
object, which is the given number of characters long.
When a very large UNICODE value is input to a LONGVARCHAR
parameter, it may be more practical to send it via a
java.io.Reader object. 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.
SQLException - if parameterName does not correspond to a named
parameter; if a database access error occurs or
this method is called on a closed CallableStatementSQLFeatureNotSupportedException - if the JDBC driver does not support
this methodparameterName - the name of the parameterreader - the java.io.Reader object that
contains the UNICODE data used as the designated parameterlength - the number of characters in the streamvoid setDate(String parameterName, Date x, Calendar cal) throws SQLException
java.sql.Date value,
using the given Calendar object. The driver uses
the Calendar object to construct an SQL DATE value,
which the driver then sends to the database. With a
a Calendar object, the driver can calculate the date
taking into account a custom timezone. If no
Calendar object is specified, the driver uses the default
timezone, which is that of the virtual machine running the application.SQLException - if parameterName does not correspond to a named
parameter; if a database access error occurs or
this method is called on a closed CallableStatementSQLFeatureNotSupportedException - if the JDBC driver does not support
this methodparameterName - the name of the parameterx - the parameter valuecal - the Calendar object the driver will use
to construct the dategetDate(int)void setTime(String parameterName, Time x, Calendar cal) throws SQLException
java.sql.Time value,
using the given Calendar object. The driver uses
the Calendar object to construct an SQL TIME value,
which the driver then sends to the database. With a
a Calendar object, the driver can calculate the time
taking into account a custom timezone. If no
Calendar object is specified, the driver uses the default
timezone, which is that of the virtual machine running the application.SQLException - if parameterName does not correspond to a named
parameter; if a database access error occurs or
this method is called on a closed CallableStatementSQLFeatureNotSupportedException - if the JDBC driver does not support
this methodparameterName - the name of the parameterx - the parameter valuecal - the Calendar object the driver will use
to construct the timegetTime(int)void setTimestamp(String parameterName, Timestamp x, Calendar cal) throws SQLException
java.sql.Timestamp value,
using the given Calendar object. The driver uses
the Calendar object to construct an SQL TIMESTAMP value,
which the driver then sends to the database. With a
a Calendar object, the driver can calculate the timestamp
taking into account a custom timezone. If no
Calendar object is specified, the driver uses the default
timezone, which is that of the virtual machine running the application.SQLException - if parameterName does not correspond to a named
parameter; if a database access error occurs or
this method is called on a closed CallableStatementSQLFeatureNotSupportedException - if the JDBC driver does not support
this methodparameterName - the name of the parameterx - the parameter valuecal - the Calendar object the driver will use
to construct the timestampgetTimestamp(int)void setNull(String parameterName, int sqlType, String typeName) throws SQLException
NULL.
This version of the method setNull should
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.
SQLException - if parameterName does not correspond to a named
parameter; if a database access error occurs or
this method is called on a closed CallableStatementSQLFeatureNotSupportedException - if the JDBC driver does not support
this methodparameterName - the name of the parametersqlType - a value from java.sql.TypestypeName - the fully-qualified name of an SQL user-defined type;
ignored if the parameter is not a user-defined type or
SQL REF valueString getString(String parameterName) throws SQLException
CHAR, VARCHAR,
or LONGVARCHAR parameter as a String in
the Java programming language.
For the fixed-length type JDBC CHAR,
the String object
returned has exactly the same value the SQL
CHAR value had in the
database, including any padding added by the database.
SQLException - if parameterName does not correspond to a named
parameter; if a database access error occurs or
this method is called on a closed CallableStatementSQLFeatureNotSupportedException - if the JDBC driver does not support
this methodparameterName - the name of the parameterNULL, the result
is null.setString(java.lang.String, java.lang.String)boolean getBoolean(String parameterName) throws SQLException
BIT or BOOLEAN
parameter as a
boolean in the Java programming language.SQLException - if parameterName does not correspond to a named
parameter; if a database access error occurs or
this method is called on a closed CallableStatementSQLFeatureNotSupportedException - if the JDBC driver does not support
this methodparameterName - the name of the parameterNULL, the result
is false.setBoolean(java.lang.String, boolean)byte getByte(String parameterName) throws SQLException
TINYINT parameter as a byte
in the Java programming language.SQLException - if parameterName does not correspond to a named
parameter; if a database access error occurs or
this method is called on a closed CallableStatementSQLFeatureNotSupportedException - if the JDBC driver does not support
this methodparameterName - the name of the parameterNULL, the result
is 0.setByte(java.lang.String, byte)short getShort(String parameterName) throws SQLException
SMALLINT parameter as a short
in the Java programming language.SQLException - if parameterName does not correspond to a named
parameter; if a database access error occurs or
this method is called on a closed CallableStatementSQLFeatureNotSupportedException - if the JDBC driver does not support
this methodparameterName - the name of the parameterNULL, the result
is 0.setShort(java.lang.String, short)int getInt(String parameterName) throws SQLException
INTEGER parameter as an int
in the Java programming language.SQLException - if parameterName does not correspond to a named
parameter; if a database access error occurs or
this method is called on a closed CallableStatementSQLFeatureNotSupportedException - if the JDBC driver does not support
this methodparameterName - the name of the parameterNULL,
the result is 0.setInt(java.lang.String, int)long getLong(String parameterName) throws SQLException
BIGINT parameter as a long
in the Java programming language.SQLException - if parameterName does not correspond to a named
parameter; if a database access error occurs or
this method is called on a closed CallableStatementSQLFeatureNotSupportedException - if the JDBC driver does not support
this methodparameterName - the name of the parameterNULL,
the result is 0.setLong(java.lang.String, long)float getFloat(String parameterName) throws SQLException
FLOAT parameter as a float
in the Java programming language.SQLException - if parameterName does not correspond to a named
parameter; if a database access error occurs or
this method is called on a closed CallableStatementSQLFeatureNotSupportedException - if the JDBC driver does not support
this methodparameterName - the name of the parameterNULL,
the result is 0.setFloat(java.lang.String, float)double getDouble(String parameterName) throws SQLException
DOUBLE parameter as a double
in the Java programming language.SQLException - if parameterName does not correspond to a named
parameter; if a database access error occurs or
this method is called on a closed CallableStatementSQLFeatureNotSupportedException - if the JDBC driver does not support
this methodparameterName - the name of the parameterNULL,
the result is 0.setDouble(java.lang.String, double)byte[] getBytes(String parameterName) throws SQLException
BINARY or VARBINARY
parameter as an array of byte values in the Java
programming language.SQLException - if parameterName does not correspond to a named
parameter; if a database access error occurs or
this method is called on a closed CallableStatementSQLFeatureNotSupportedException - if the JDBC driver does not support
this methodparameterName - the name of the parameterNULL, the result is
null.setBytes(java.lang.String, byte[])Date getDate(String parameterName) throws SQLException
DATE parameter as a
java.sql.Date object.SQLException - if parameterName does not correspond to a named
parameter; if a database access error occurs or
this method is called on a closed CallableStatementSQLFeatureNotSupportedException - if the JDBC driver does not support
this methodparameterName - the name of the parameterNULL, the result
is null.setDate(java.lang.String, java.sql.Date)Time getTime(String parameterName) throws SQLException
TIME parameter as a
java.sql.Time object.SQLException - if parameterName does not correspond to a named
parameter; if a database access error occurs or
this method is called on a closed CallableStatementSQLFeatureNotSupportedException - if the JDBC driver does not support
this methodparameterName - the name of the parameterNULL, the result
is null.setTime(java.lang.String, java.sql.Time)Timestamp getTimestamp(String parameterName) throws SQLException
TIMESTAMP parameter as a
java.sql.Timestamp object.SQLException - if parameterName does not correspond to a named
parameter; if a database access error occurs or
this method is called on a closed CallableStatementSQLFeatureNotSupportedException - if the JDBC driver does not support
this methodparameterName - the name of the parameterNULL, the result
is null.setTimestamp(java.lang.String, java.sql.Timestamp)Object getObject(String parameterName) throws SQLException
Object in the Java
programming language. If the value is an SQL NULL, the
driver returns a Java null.
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 as java.sql.Types.OTHER, this method can be used
to read database-specific abstract data types.
SQLException - if parameterName does not correspond to a named
parameter; if a database access error occurs or
this method is called on a closed CallableStatementSQLFeatureNotSupportedException - if the JDBC driver does not support
this methodparameterName - the name of the parameterjava.lang.Object holding the OUT parameter value.Types,
setObject(java.lang.String, java.lang.Object, int, int)BigDecimal getBigDecimal(String parameterName) throws SQLException
NUMERIC parameter as a
java.math.BigDecimal object with as many digits to the
right of the decimal point as the value contains.SQLException - if parameterName does not correspond to a named
parameter; if a database access error occurs or
this method is called on a closed CallableStatementSQLFeatureNotSupportedException - if the JDBC driver does not support
this methodparameterName - the name of the parameterNULL, the result is null.setBigDecimal(java.lang.String, java.math.BigDecimal)Object getObject(String parameterName, Map<String,Class<?>> map) throws SQLException
parameterName and uses map for 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 as java.sql.Types.OTHER, this method can
be used to read database-specific abstract data types.
SQLException - if parameterName does not correspond to a named
parameter; if a database access error occurs or
this method is called on a closed CallableStatementSQLFeatureNotSupportedException - if the JDBC driver does not support
this methodparameterName - the name of the parametermap - the mapping from SQL type names to Java classesjava.lang.Object holding the OUT parameter valuesetObject(java.lang.String, java.lang.Object, int, int)Ref getRef(String parameterName) throws SQLException
REF(<structured-type>)
parameter as a Ref object in the Java programming language.SQLException - if parameterName does not correspond to a named
parameter; if a database access error occurs or
this method is called on a closed CallableStatementSQLFeatureNotSupportedException - if the JDBC driver does not support
this methodparameterName - the name of the parameterRef object in the
Java programming language. If the value was SQL NULL,
the value null is returned.Blob getBlob(String parameterName) throws SQLException
BLOB parameter as a
Blob object in the Java programming language.SQLException - if parameterName does not correspond to a named
parameter; if a database access error occurs or
this method is called on a closed CallableStatementSQLFeatureNotSupportedException - if the JDBC driver does not support
this methodparameterName - the name of the parameterBlob object in the
Java programming language. If the value was SQL NULL,
the value null is returned.Clob getClob(String parameterName) throws SQLException
CLOB parameter as a
java.sql.Clob object in the Java programming language.SQLException - if parameterName does not correspond to a named
parameter; if a database access error occurs or
this method is called on a closed CallableStatementSQLFeatureNotSupportedException - if the JDBC driver does not support
this methodparameterName - the name of the parameterClob object in the
Java programming language. If the value was SQL NULL,
the value null is returned.Array getArray(String parameterName) throws SQLException
ARRAY parameter as an
Array object in the Java programming language.SQLException - if parameterName does not correspond to a named
parameter; if a database access error occurs or
this method is called on a closed CallableStatementSQLFeatureNotSupportedException - if the JDBC driver does not support
this methodparameterName - the name of the parameterArray object in
Java programming language. If the value was SQL NULL,
the value null is returned.Date getDate(String parameterName, Calendar cal) throws SQLException
DATE parameter as a
java.sql.Date object, using
the given Calendar object
to construct the date.
With a Calendar object, the driver
can calculate the date taking into account a custom timezone and locale.
If no Calendar object is specified, the driver uses the
default timezone and locale.SQLException - if parameterName does not correspond to a named
parameter; if a database access error occurs or
this method is called on a closed CallableStatementSQLFeatureNotSupportedException - if the JDBC driver does not support
this methodparameterName - the name of the parametercal - the Calendar object the driver will use
to construct the dateNULL,
the result is null.setDate(java.lang.String, java.sql.Date)Time getTime(String parameterName, Calendar cal) throws SQLException
TIME parameter as a
java.sql.Time object, using
the given Calendar object
to construct the time.
With a Calendar object, the driver
can calculate the time taking into account a custom timezone and locale.
If no Calendar object is specified, the driver uses the
default timezone and locale.SQLException - if parameterName does not correspond to a named
parameter; if a database access error occurs or
this method is called on a closed CallableStatementSQLFeatureNotSupportedException - if the JDBC driver does not support
this methodparameterName - the name of the parametercal - the Calendar object the driver will use
to construct the timeNULL, the result is
null.setTime(java.lang.String, java.sql.Time)Timestamp getTimestamp(String parameterName, Calendar cal) throws SQLException
TIMESTAMP parameter as a
java.sql.Timestamp object, using
the given Calendar object to construct
the Timestamp object.
With a Calendar object, the driver
can calculate the timestamp taking into account a custom timezone and locale.
If no Calendar object is specified, the driver uses the
default timezone and locale.SQLException - if parameterName does not correspond to a named
parameter; if a database access error occurs or
this method is called on a closed CallableStatementSQLFeatureNotSupportedException - if the JDBC driver does not support
this methodparameterName - the name of the parametercal - the Calendar object the driver will use
to construct the timestampNULL, the result is
null.setTimestamp(java.lang.String, java.sql.Timestamp)URL getURL(String parameterName) throws SQLException
DATALINK parameter as a
java.net.URL object.SQLException - if parameterName does not correspond to a named
parameter; if a database access error occurs,
this method is called on a closed CallableStatement,
or if there is a problem with the URLSQLFeatureNotSupportedException - if the JDBC driver does not support
this methodparameterName - the name of the parameterjava.net.URL object in the
Java programming language. If the value was SQL NULL, the
value null is returned.setURL(java.lang.String, java.net.URL)RowId getRowId(int parameterIndex) throws SQLException
ROWID parameter as a
java.sql.RowId object.SQLException - if the parameterIndex is not valid;
if a database access error occurs or
this method is called on a closed CallableStatementSQLFeatureNotSupportedException - if the JDBC driver does not support
this methodparameterIndex - the first parameter is 1, the second is 2,...RowId object that represents the JDBC ROWID
value is used as the designated parameter. If the parameter contains
a SQL NULL, then a null value is returned.RowId getRowId(String parameterName) throws SQLException
ROWID parameter as a
java.sql.RowId object.SQLException - if parameterName does not correspond to a named
parameter; if a database access error occurs or
this method is called on a closed CallableStatementSQLFeatureNotSupportedException - if the JDBC driver does not support
this methodparameterName - the name of the parameterRowId object that represents the JDBC ROWID
value is used as the designated parameter. If the parameter contains
a SQL NULL, then a null value is returned.void setRowId(String parameterName, RowId x) throws SQLException
java.sql.RowId object. The
driver converts this to a SQL ROWID when it sends it to the
database.SQLException - if parameterName does not correspond to a named
parameter; if a database access error occurs or
this method is called on a closed CallableStatementSQLFeatureNotSupportedException - if the JDBC driver does not support
this methodparameterName - the name of the parameterx - the parameter valuevoid setNString(String parameterName, String value) throws SQLException
String object.
The driver converts this to a SQL NCHAR or
NVARCHAR or LONGNVARCHARSQLException - 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 closed CallableStatementSQLFeatureNotSupportedException - if the JDBC driver does not support
this methodparameterName - the name of the parameter to be setvalue - the parameter valuevoid setNCharacterStream(String parameterName, Reader value, long length) throws SQLException
Reader object. The
Reader reads 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.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 closed CallableStatementSQLFeatureNotSupportedException - if the JDBC driver does not support
this methodparameterName - the name of the parameter to be setvalue - the parameter valuelength - the number of characters in the parameter data.void setNClob(String parameterName, NClob value) throws SQLException
java.sql.NClob object. The object
implements the java.sql.NClob interface. This NClob
object maps to a SQL NCLOB.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 closed CallableStatementSQLFeatureNotSupportedException - if the JDBC driver does not support
this methodparameterName - the name of the parameter to be setvalue - the parameter valuevoid setClob(String parameterName, Reader reader, long length) throws SQLException
Reader object. The reader must contain the number
of characters specified by length otherwise a SQLException will be
generated when the CallableStatement is executed.
This method differs from the setCharacterStream (int, Reader, int) method
because it informs the driver that the parameter value should be sent to
the server as a CLOB. When the setCharacterStream method is used, the
driver may have to do extra work to determine whether the parameter
data should be send to the server as a LONGVARCHAR or a CLOBSQLException - 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 closed CallableStatementSQLFeatureNotSupportedException - if the JDBC driver does not support
this methodparameterName - 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.void setBlob(String parameterName, InputStream inputStream, long length) throws SQLException
InputStream object. The inputstream must contain the number
of characters specified by length, otherwise a SQLException will be
generated when the CallableStatement is executed.
This method differs from the setBinaryStream (int, InputStream, int)
method because it informs the driver that the parameter value should be
sent to the server as a BLOB. When the setBinaryStream method is used,
the driver may have to do extra work to determine whether the parameter
data should be sent to the server as a LONGVARBINARY or a BLOBSQLException - if parameterName does not correspond to a named
parameter; if the length specified
is less than zero; if the number of bytes in the inputstream does not match
the specified length; if a database access error occurs or
this method is called on a closed CallableStatementSQLFeatureNotSupportedException - if the JDBC driver does not support
this methodparameterName - 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.void setNClob(String parameterName, Reader reader, long length) throws SQLException
Reader object. The reader must contain the number
of characters specified by length otherwise a SQLException will be
generated when the CallableStatement is executed.
This method differs from the setCharacterStream (int, Reader, int) method
because it informs the driver that the parameter value should be sent to
the server as a NCLOB. When the setCharacterStream method is used, the
driver may have to do extra work to determine whether the parameter
data should be send to the server as a LONGNVARCHAR or a NCLOBSQLException - 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 closed CallableStatementSQLFeatureNotSupportedException - if the JDBC driver does not support
this methodparameterName - 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.NClob getNClob(int parameterIndex) throws SQLException
NCLOB parameter as a
java.sql.NClob object in the Java programming language.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 closed CallableStatementSQLFeatureNotSupportedException - if the JDBC driver does not support
this methodparameterIndex - the first parameter is 1, the second is 2, and
so onNClob object in the
Java programming language. If the value was SQL NULL, the
value null is returned.NClob getNClob(String parameterName) throws SQLException
NCLOB parameter as a
java.sql.NClob object in the Java programming language.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 closed CallableStatementSQLFeatureNotSupportedException - if the JDBC driver does not support
this methodparameterName - the name of the parameterNClob object in the
Java programming language. If the value was SQL NULL,
the value null is returned.void setSQLXML(String parameterName, SQLXML xmlObject) throws SQLException
java.sql.SQLXML object. The driver converts this to an
SQL XML value when it sends it to the database.SQLException - if parameterName does not correspond to a named
parameter; if a database access error occurs;
this method is called on a closed CallableStatement or
the java.xml.transform.Result,
Writer or OutputStream has not been closed for the SQLXML objectSQLFeatureNotSupportedException - if the JDBC driver does not support
this methodparameterName - the name of the parameterxmlObject - a SQLXML object that maps an SQL XML valueSQLXML getSQLXML(int parameterIndex) throws SQLException
SQL XML parameter as a
java.sql.SQLXML object in the Java programming language.SQLException - if the parameterIndex is not valid;
if a database access error occurs or
this method is called on a closed CallableStatementSQLFeatureNotSupportedException - if the JDBC driver does not support
this methodparameterIndex - index of the first parameter is 1, the second is 2, ...SQLXML object that maps an SQL XML valueSQLXML getSQLXML(String parameterName) throws SQLException
SQL XML parameter as a
java.sql.SQLXML object in the Java programming language.SQLException - if parameterName does not correspond to a named
parameter; if a database access error occurs or
this method is called on a closed CallableStatementSQLFeatureNotSupportedException - if the JDBC driver does not support
this methodparameterName - the name of the parameterSQLXML object that maps an SQL XML valueString getNString(int parameterIndex) throws SQLException
NCHAR,
NVARCHAR
or LONGNVARCHAR parameter as
a String in the Java programming language.
For the fixed-length type JDBC NCHAR,
the String object
returned has exactly the same value the SQL
NCHAR value had in the
database, including any padding added by the database.
SQLException - if the parameterIndex is not valid;
if a database access error occurs or
this method is called on a closed CallableStatementSQLFeatureNotSupportedException - if the JDBC driver does not support
this methodparameterIndex - index of the first parameter is 1, the second is 2, ...String object that maps an
NCHAR, NVARCHAR or LONGNVARCHAR valuesetNString(java.lang.String, java.lang.String)String getNString(String parameterName) throws SQLException
NCHAR,
NVARCHAR
or LONGNVARCHAR parameter as
a String in the Java programming language.
For the fixed-length type JDBC NCHAR,
the String object
returned has exactly the same value the SQL
NCHAR value had in the
database, including any padding added by the database.
SQLException - if parameterName does not correspond to a named
parameter;
if a database access error occurs or
this method is called on a closed CallableStatementSQLFeatureNotSupportedException - if the JDBC driver does not support
this methodparameterName - the name of the parameterString object that maps an
NCHAR, NVARCHAR or LONGNVARCHAR valuesetNString(java.lang.String, java.lang.String)Reader getNCharacterStream(int parameterIndex) throws SQLException
java.io.Reader object in the Java programming language.
It is intended for use when
accessing NCHAR,NVARCHAR
and LONGNVARCHAR parameters.SQLException - if the parameterIndex is not valid;
if a database access error occurs or
this method is called on a closed CallableStatementSQLFeatureNotSupportedException - if the JDBC driver does not support
this methodparameterIndex - the first parameter is 1, the second is 2, ...java.io.Reader object that contains the parameter
value; if the value is SQL NULL, the value returned is
null in the Java programming language.Reader getNCharacterStream(String parameterName) throws SQLException
java.io.Reader object in the Java programming language.
It is intended for use when
accessing NCHAR,NVARCHAR
and LONGNVARCHAR parameters.SQLException - if parameterName does not correspond to a named
parameter; if a database access error occurs or
this method is called on a closed CallableStatementSQLFeatureNotSupportedException - if the JDBC driver does not support
this methodparameterName - the name of the parameterjava.io.Reader object that contains the parameter
value; if the value is SQL NULL, the value returned is
null in the Java programming languageReader getCharacterStream(int parameterIndex) throws SQLException
java.io.Reader object in the Java programming language.SQLException - if the parameterIndex is not valid; if a database access error occurs or
this method is called on a closed CallableStatementparameterIndex - the first parameter is 1, the second is 2, ...java.io.Reader object that contains the parameter
value; if the value is SQL NULL, the value returned is
null in the Java programming language.Reader getCharacterStream(String parameterName) throws SQLException
java.io.Reader object in the Java programming language.SQLException - if parameterName does not correspond to a named
parameter; if a database access error occurs or
this method is called on a closed CallableStatementSQLFeatureNotSupportedException - if the JDBC driver does not support
this methodparameterName - the name of the parameterjava.io.Reader object that contains the parameter
value; if the value is SQL NULL, the value returned is
null in the Java programming languagevoid setBlob(String parameterName, Blob x) throws SQLException
java.sql.Blob object.
The driver converts this to an SQL BLOB value when it
sends it to the database.SQLException - if parameterName does not correspond to a named
parameter; if a database access error occurs or
this method is called on a closed CallableStatementSQLFeatureNotSupportedException - if the JDBC driver does not support
this methodparameterName - the name of the parameterx - a Blob object that maps an SQL BLOB valuevoid setClob(String parameterName, Clob x) throws SQLException
java.sql.Clob object.
The driver converts this to an SQL CLOB value when it
sends it to the database.SQLException - if parameterName does not correspond to a named
parameter; if a database access error occurs or
this method is called on a closed CallableStatementSQLFeatureNotSupportedException - if the JDBC driver does not support
this methodparameterName - the name of the parameterx - a Clob object that maps an SQL CLOB valuevoid setAsciiStream(String parameterName, InputStream x, long length) throws SQLException
LONGVARCHAR
parameter, it may be more practical to send it via a
java.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.
SQLException - if parameterName does not correspond to a named
parameter; if a database access error occurs or
this method is called on a closed CallableStatementSQLFeatureNotSupportedException - if the JDBC driver does not support
this methodparameterName - the name of the parameterx - the Java input stream that contains the ASCII parameter valuelength - the number of bytes in the streamvoid setBinaryStream(String parameterName, InputStream x, long length) throws SQLException
LONGVARBINARY
parameter, it may be more practical to send it via a
java.io.InputStream object. 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.
SQLException - if parameterName does not correspond to a named
parameter; if a database access error occurs or
this method is called on a closed CallableStatementSQLFeatureNotSupportedException - if the JDBC driver does not support
this methodparameterName - the name of the parameterx - the java input stream which contains the binary parameter valuelength - the number of bytes in the streamvoid setCharacterStream(String parameterName, Reader reader, long length) throws SQLException
Reader
object, which is the given number of characters long.
When a very large UNICODE value is input to a LONGVARCHAR
parameter, it may be more practical to send it via a
java.io.Reader object. 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.
SQLException - if parameterName does not correspond to a named
parameter; if a database access error occurs or
this method is called on a closed CallableStatementSQLFeatureNotSupportedException - if the JDBC driver does not support
this methodparameterName - the name of the parameterreader - the java.io.Reader object that
contains the UNICODE data used as the designated parameterlength - the number of characters in the streamvoid setAsciiStream(String parameterName, InputStream x) throws SQLException
LONGVARCHAR
parameter, it may be more practical to send it via a
java.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
setAsciiStream which takes a length parameter.
SQLException - if parameterName does not correspond to a named
parameter; if a database access error occurs or
this method is called on a closed CallableStatementSQLFeatureNotSupportedException - if the JDBC driver does not support this methodparameterName - the name of the parameterx - the Java input stream that contains the ASCII parameter valuevoid setBinaryStream(String parameterName, InputStream x) throws SQLException
LONGVARBINARY
parameter, it may be more practical to send it via a
java.io.InputStream object. 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
setBinaryStream which takes a length parameter.
SQLException - if parameterName does not correspond to a named
parameter; if a database access error occurs or
this method is called on a closed CallableStatementSQLFeatureNotSupportedException - if the JDBC driver does not support this methodparameterName - the name of the parameterx - the java input stream which contains the binary parameter valuevoid setCharacterStream(String parameterName, Reader reader) throws SQLException
Reader
object.
When a very large UNICODE value is input to a LONGVARCHAR
parameter, it may be more practical to send it via a
java.io.Reader object. 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
setCharacterStream which takes a length parameter.
SQLException - if parameterName does not correspond to a named
parameter; if a database access error occurs or
this method is called on a closed CallableStatementSQLFeatureNotSupportedException - if the JDBC driver does not support this methodparameterName - the name of the parameterreader - the java.io.Reader object that contains the
Unicode datavoid setNCharacterStream(String parameterName, Reader value) throws SQLException
Reader object. The
Reader reads 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
setNCharacterStream which takes a length parameter.
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 closed CallableStatementSQLFeatureNotSupportedException - if the JDBC driver does not support this methodparameterName - the name of the parametervalue - the parameter valuevoid setClob(String parameterName, Reader reader) throws SQLException
Reader object.
This method differs from the setCharacterStream (int, Reader) method
because it informs the driver that the parameter value should be sent to
the server as a CLOB. When the setCharacterStream method is used, the
driver may have to do extra work to determine whether the parameter
data should be send to the server as a LONGVARCHAR or a CLOB
Note: Consult your JDBC driver documentation to determine if
it might be more efficient to use a version of
setClob which takes a length parameter.
SQLException - if parameterName does not correspond to a named
parameter; if a database access error occurs or this method is called on
a closed CallableStatementSQLFeatureNotSupportedException - if the JDBC driver does not support this methodparameterName - the name of the parameterreader - An object that contains the data to set the parameter value to.void setBlob(String parameterName, InputStream inputStream) throws SQLException
InputStream object.
This method differs from the setBinaryStream (int, InputStream)
method because it informs the driver that the parameter value should be
sent to the server as a BLOB. When the setBinaryStream method is used,
the driver may have to do extra work to determine whether the parameter
data should be send to the server as a LONGVARBINARY or a BLOB
Note: Consult your JDBC driver documentation to determine if
it might be more efficient to use a version of
setBlob which takes a length parameter.
SQLException - if parameterName does not correspond to a named
parameter; if a database access error occurs or
this method is called on a closed CallableStatementSQLFeatureNotSupportedException - if the JDBC driver does not support this methodparameterName - the name of the parameterinputStream - An object that contains the data to set the parameter
value to.void setNClob(String parameterName, Reader reader) throws SQLException
Reader object.
This method differs from the setCharacterStream (int, Reader) method
because it informs the driver that the parameter value should be sent to
the server as a NCLOB. When the setCharacterStream method is used, the
driver may have to do extra work to determine whether the parameter
data should be send to the server as a LONGNVARCHAR or a NCLOB
Note: Consult your JDBC driver documentation to determine if
it might be more efficient to use a version of
setNClob which takes a length parameter.
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 closed CallableStatementSQLFeatureNotSupportedException - if the JDBC driver does not support this methodparameterName - the name of the parameterreader - An object that contains the data to set the parameter value to.<T> T getObject(int parameterIndex,
Class<T> type)
throws SQLException
Returns an object representing the value of OUT parameter
parameterIndex and 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, a
SQLException is 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, or Struct.
Additional conversions may be supported and are vendor defined.
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 methodT - the type of the class modeled by this Class objectparameterIndex - the first parameter is 1, the second is 2, and so ontype - Class representing the Java data type to convert the
designated parameter to.type holding the OUT parameter value<T> T getObject(String parameterName, Class<T> type) throws SQLException
Returns an object representing the value of OUT parameter
parameterName and 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, a
SQLException is 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, or Struct.
Additional conversions may be supported and are vendor defined.
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 methodT - the type of the class modeled by this Class objectparameterName - the name of the parametertype - Class representing the Java data type to convert
the designated parameter to.type holding the OUT parameter
valuedefault 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 an InputStream then the stream
must contain the number of bytes specified by scaleOrLength.
If the second argument is a Reader then the reader must
contain the number of characters specified
by scaleOrLength. If these conditions are not true the driver
will generate a
SQLException when 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 method SQLData.writeSQL to
write it to the SQL data stream.
If, on the other hand, the object is of a class implementing
Ref, Blob, Clob, NClob,
Struct, java.net.URL,
or Array, 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
SQLException - if parameterName does not correspond to a named
parameter; if a database access error occurs
or this method is called on a closed CallableStatement or
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 targetSqlTypeparameterName - 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 - for java.sql.JDBCType.DECIMAL
or java.sql.JDBCType.NUMERIC types,
this is the number of digits after the decimal point. For
Java Object types InputStream and Reader,
this is the length
of the data in the stream or reader. For all other types,
this value will be ignored.JDBCType,
SQLTypedefault void setObject(String parameterName, Object x, SQLType targetSqlType) throws SQLException
setObject(String parameterName,
Object x, SQLType targetSqlType, int scaleOrLength),
except that it assumes a scale of zero.
The default implementation will throw SQLFeatureNotSupportedException
SQLException - if parameterName does not correspond to a named
parameter; if a database access error occurs
or this method is called on a closed CallableStatementSQLFeatureNotSupportedException - if
the JDBC driver does not support the specified targetSqlTypeparameterName - the name of the parameterx - the object containing the input parameter valuetargetSqlType - the SQL type to be sent to the databaseJDBCType,
SQLTypedefault void registerOutParameter(int parameterIndex,
SQLType sqlType)
throws SQLException
parameterIndex to the JDBC type
sqlType. All OUT parameters must be registered
before a stored procedure is executed.
The JDBC type specified by sqlType for an OUT
parameter determines the Java type that must be used
in the get method 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, sqlType
may be JDBCType.OTHER or a SQLType that is supported by
the JDBC driver. The method
getObject(int) retrieves the value.
The default implementation will throw SQLFeatureNotSupportedException
SQLException - if the parameterIndex is not valid;
if a database access error occurs or
this method is called on a closed CallableStatementSQLFeatureNotSupportedException - if
the JDBC driver does not support the specified sqlTypeparameterIndex - the first parameter is 1, the second is 2,
and so onsqlType - the JDBC type code defined by SQLType to use to
register the OUT Parameter.
If the parameter is of JDBC type JDBCType.NUMERIC
or JDBCType.DECIMAL, the version of
registerOutParameter that accepts a scale value
should be used.JDBCType,
SQLTypedefault void registerOutParameter(int parameterIndex,
SQLType sqlType,
int scale)
throws SQLException
parameterIndex to be of JDBC type
sqlType. All OUT parameters must be registered
before a stored procedure is executed.
The JDBC type specified by sqlType for an OUT
parameter determines the Java type that must be used
in the get method to read the value of that parameter.
This version of registerOutParameter should be
used when the parameter is of JDBC type JDBCType.NUMERIC
or JDBCType.DECIMAL.
The default implementation will throw SQLFeatureNotSupportedException
SQLException - if the parameterIndex is not valid;
if a database access error occurs or
this method is called on a closed CallableStatementSQLFeatureNotSupportedException - if
the JDBC driver does not support the specified sqlTypeparameterIndex - the first parameter is 1, the second is 2,
and so onsqlType - the JDBC type code defined by SQLType to 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.JDBCType,
SQLTypedefault void registerOutParameter(int parameterIndex,
SQLType sqlType,
String typeName)
throws SQLException
registerOutParameter
should be used for a user-defined or REF output 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 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-defined and REF parameters.
Although it is intended for user-defined and REF parameters,
this method may be used to register a parameter of any JDBC type.
If the parameter does not have a user-defined or REF type, 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
SQLException - if the parameterIndex is not valid;
if a database access error occurs or
this method is called on a closed CallableStatementSQLFeatureNotSupportedException - if
the JDBC driver does not support the specified sqlTypeparameterIndex - the first parameter is 1, the second is 2,...sqlType - the JDBC type code defined by SQLType to use to
register the OUT Parameter.typeName - the fully-qualified name of an SQL structured typeJDBCType,
SQLTypedefault void registerOutParameter(String parameterName, SQLType sqlType) throws SQLException
parameterName to the JDBC type
sqlType. All OUT parameters must be registered
before a stored procedure is executed.
The JDBC type specified by sqlType for an OUT
parameter determines the Java type that must be used
in the get method 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, sqlType
should be JDBCType.OTHER or a SQLType that is supported
by the JDBC driver.. The method
getObject(int) retrieves the value.
The default implementation will throw SQLFeatureNotSupportedException
SQLException - if parameterName does not correspond to a named
parameter; if a database access error occurs or
this method is called on a closed CallableStatementSQLFeatureNotSupportedException - if
the JDBC driver does not support the specified sqlType
or if the JDBC driver does not support
this methodparameterName - the name of the parametersqlType - the JDBC type code defined by SQLType to use to
register the OUT Parameter.
If the parameter is of JDBC type JDBCType.NUMERIC
or JDBCType.DECIMAL, the version of
registerOutParameter that accepts a scale value
should be used.JDBCType,
SQLTypedefault void registerOutParameter(String parameterName, SQLType sqlType, int scale) throws SQLException
parameterName to be of JDBC type
sqlType. All OUT parameters must be registered
before a stored procedure is executed.
The JDBC type specified by sqlType for an OUT
parameter determines the Java type that must be used
in the get method to read the value of that parameter.
This version of registerOutParameter should be
used when the parameter is of JDBC type JDBCType.NUMERIC
or JDBCType.DECIMAL.
The default implementation will throw SQLFeatureNotSupportedException
SQLException - if parameterName does not correspond to a named
parameter; if a database access error occurs or
this method is called on a closed CallableStatementSQLFeatureNotSupportedException - if
the JDBC driver does not support the specified sqlType
or if the JDBC driver does not support
this methodparameterName - the name of the parametersqlType - the JDBC type code defined by SQLType to 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.JDBCType,
SQLTypedefault void registerOutParameter(String parameterName, SQLType sqlType, String typeName) throws SQLException
registerOutParameter
should 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 getXXX method whose Java type XXX corresponds to the
parameter's registered SQL type.
The default implementation will throw SQLFeatureNotSupportedException
SQLException - if parameterName does not correspond to a named
parameter; if a database access error occurs or
this method is called on a closed CallableStatementSQLFeatureNotSupportedException - if
the JDBC driver does not support the specified sqlType
or if the JDBC driver does not support this methodparameterName - the name of the parametersqlType - the JDBC type code defined by SQLType to use to
register the OUT Parameter.typeName - the fully-qualified name of an SQL structured typeJDBCType,
SQLTypeaicas GmbH, Karlsruhe, Germany —www.aicas.com
Copyright © 2001-2024 aicas GmbH. All Rights Reserved.