CallableStatement
interface CallableStatement : PreparedStatement
java.sql.CallableStatement |
The interface used to execute SQL stored procedures. The JDBC API provides a stored procedure SQL escape syntax that allows stored procedures to be called in a standard way for all RDBMSs. This escape syntax has one form that includes a result parameter and one that does not. If used, the result parameter must be registered as an OUT parameter. The other parameters can be used for input, output or both. Parameters are referred to sequentially, by number, with the first parameter being 1.
{?= 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.
Summary
Inherited constants | |
---|---|
Public methods | |
---|---|
abstract Array! |
Retrieves the value of the designated JDBC |
abstract Array! |
Retrieves the value of a JDBC |
abstract BigDecimal! |
getBigDecimal(parameterIndex: Int, scale: Int) Retrieves the value of the designated JDBC |
abstract BigDecimal! |
getBigDecimal(parameterIndex: Int) Retrieves the value of the designated JDBC |
abstract BigDecimal! |
getBigDecimal(parameterName: String!) Retrieves the value of a JDBC |
abstract Blob! |
Retrieves the value of the designated JDBC |
abstract Blob! |
Retrieves the value of a JDBC |
abstract Boolean |
getBoolean(parameterIndex: Int) Retrieves the value of the designated JDBC |
abstract Boolean |
getBoolean(parameterName: String!) Retrieves the value of a JDBC |
abstract Byte |
Retrieves the value of the designated JDBC |
abstract Byte |
Retrieves the value of a JDBC |
abstract ByteArray! |
Retrieves the value of the designated JDBC |
abstract ByteArray! |
Retrieves the value of a JDBC |
abstract Reader! |
getCharacterStream(parameterIndex: Int) Retrieves the value of the designated parameter as a |
abstract Reader! |
getCharacterStream(parameterName: String!) Retrieves the value of the designated parameter as a |
abstract Clob! |
Retrieves the value of the designated JDBC |
abstract Clob! |
Retrieves the value of a JDBC |
abstract Date! |
Retrieves the value of the designated JDBC |
abstract Date! |
Retrieves the value of the designated JDBC |
abstract Date! |
Retrieves the value of a JDBC |
abstract Date! |
Retrieves the value of a JDBC |
abstract Double |
Retrieves the value of the designated JDBC |
abstract Double |
Retrieves the value of a JDBC |
abstract Float |
Retrieves the value of the designated JDBC |
abstract Float |
Retrieves the value of a JDBC |
abstract Int |
Retrieves the value of the designated JDBC |
abstract Int |
Retrieves the value of a JDBC |
abstract Long |
Retrieves the value of the designated JDBC |
abstract Long |
Retrieves the value of a JDBC |
abstract Reader! |
getNCharacterStream(parameterIndex: Int) Retrieves the value of the designated parameter as a |
abstract Reader! |
getNCharacterStream(parameterName: String!) Retrieves the value of the designated parameter as a |
abstract NClob! |
Retrieves the value of the designated JDBC |
abstract NClob! |
Retrieves the value of a JDBC |
abstract String! |
getNString(parameterIndex: Int) Retrieves the value of the designated |
abstract String! |
getNString(parameterName: String!) Retrieves the value of the designated |
abstract Any! |
Retrieves the value of the designated parameter as an |
abstract Any! |
getObject(parameterIndex: Int, map: MutableMap<String!, Class<*>!>!) Returns an object representing the value of OUT parameter |
abstract Any! |
Retrieves the value of a parameter as an |
abstract Any! |
getObject(parameterName: String!, map: MutableMap<String!, Class<*>!>!) Returns an object representing the value of OUT parameter |
abstract Ref! |
Retrieves the value of the designated JDBC |
abstract Ref! |
Retrieves the value of a JDBC |
abstract RowId! |
Retrieves the value of the designated JDBC |
abstract RowId! |
Retrieves the value of the designated JDBC |
abstract SQLXML! |
Retrieves the value of the designated |
abstract SQLXML! |
Retrieves the value of the designated |
abstract Short |
Retrieves the value of the designated JDBC |
abstract Short |
Retrieves the value of a JDBC |
abstract String! |
Retrieves the value of the designated JDBC |
abstract String! |
Retrieves the value of a JDBC |
abstract Time! |
Retrieves the value of the designated JDBC |
abstract Time! |
Retrieves the value of the designated JDBC |
abstract Time! |
Retrieves the value of a JDBC |
abstract Time! |
Retrieves the value of a JDBC |
abstract Timestamp! |
getTimestamp(parameterIndex: Int) Retrieves the value of the designated JDBC |
abstract Timestamp! |
getTimestamp(parameterIndex: Int, cal: Calendar!) Retrieves the value of the designated JDBC |
abstract Timestamp! |
getTimestamp(parameterName: String!) Retrieves the value of a JDBC |
abstract Timestamp! |
getTimestamp(parameterName: String!, cal: Calendar!) Retrieves the value of a JDBC |
abstract URL! |
Retrieves the value of the designated JDBC |
abstract URL! |
Retrieves the value of a JDBC |
abstract Unit |
registerOutParameter(parameterIndex: Int, sqlType: Int) Registers the OUT parameter in ordinal position |
abstract Unit |
registerOutParameter(parameterIndex: Int, sqlType: Int, scale: Int) Registers the parameter in ordinal position |
abstract Unit |
registerOutParameter(parameterIndex: Int, sqlType: Int, typeName: String!) Registers the designated output parameter. |
abstract Unit |
registerOutParameter(parameterName: String!, sqlType: Int) Registers the OUT parameter named |
abstract Unit |
registerOutParameter(parameterName: String!, sqlType: Int, scale: Int) Registers the parameter named |
abstract Unit |
registerOutParameter(parameterName: String!, sqlType: Int, typeName: String!) Registers the designated output parameter. |
abstract Unit |
setAsciiStream(parameterName: String!, x: InputStream!, length: Int) Sets the designated parameter to the given input stream, which will have the specified number of bytes. |
abstract Unit |
setAsciiStream(parameterName: String!, x: InputStream!, length: Long) Sets the designated parameter to the given input stream, which will have the specified number of bytes. |
abstract Unit |
setAsciiStream(parameterName: String!, x: InputStream!) Sets the designated parameter to the given input stream. |
abstract Unit |
setBigDecimal(parameterName: String!, x: BigDecimal!) Sets the designated parameter to the given |
abstract Unit |
setBinaryStream(parameterName: String!, x: InputStream!, length: Int) Sets the designated parameter to the given input stream, which will have the specified number of bytes. |
abstract Unit |
setBinaryStream(parameterName: String!, x: InputStream!, length: Long) Sets the designated parameter to the given input stream, which will have the specified number of bytes. |
abstract Unit |
setBinaryStream(parameterName: String!, x: InputStream!) Sets the designated parameter to the given input stream. |
abstract Unit |
setBlob(parameterName: String!, inputStream: InputStream!, length: Long) Sets the designated parameter to a |
abstract Unit |
Sets the designated parameter to the given |
abstract Unit |
setBlob(parameterName: String!, inputStream: InputStream!) Sets the designated parameter to a |
abstract Unit |
setBoolean(parameterName: String!, x: Boolean) Sets the designated parameter to the given Java |
abstract Unit |
Sets the designated parameter to the given Java |
abstract Unit |
Sets the designated parameter to the given Java array of bytes. |
abstract Unit |
setCharacterStream(parameterName: String!, reader: Reader!, length: Int) Sets the designated parameter to the given |
abstract Unit |
setCharacterStream(parameterName: String!, reader: Reader!, length: Long) Sets the designated parameter to the given |
abstract Unit |
setCharacterStream(parameterName: String!, reader: Reader!) Sets the designated parameter to the given |
abstract Unit |
Sets the designated parameter to a |
abstract Unit |
Sets the designated parameter to the given |
abstract Unit |
Sets the designated parameter to a |
abstract Unit |
Sets the designated parameter to the given |
abstract Unit |
Sets the designated parameter to the given |
abstract Unit |
Sets the designated parameter to the given Java |
abstract Unit |
Sets the designated parameter to the given Java |
abstract Unit |
Sets the designated parameter to the given Java |
abstract Unit |
Sets the designated parameter to the given Java |
abstract Unit |
setNCharacterStream(parameterName: String!, value: Reader!, length: Long) Sets the designated parameter to a |
abstract Unit |
setNCharacterStream(parameterName: String!, value: Reader!) Sets the designated parameter to a |
abstract Unit |
Sets the designated parameter to a |
abstract Unit |
Sets the designated parameter to a |
abstract Unit |
Sets the designated parameter to a |
abstract Unit |
setNString(parameterName: String!, value: String!) Sets the designated parameter to the given |
abstract Unit |
Sets the designated parameter to SQL |
abstract Unit |
Sets the designated parameter to SQL |
abstract Unit |
Sets the value of the designated parameter with the given object. |
abstract Unit |
Sets the value of the designated parameter with the given object. |
abstract Unit |
Sets the value of the designated parameter with the given object. |
abstract Unit |
Sets the designated parameter to the given |
abstract Unit |
Sets the designated parameter to the given |
abstract Unit |
Sets the designated parameter to the given Java |
abstract Unit |
Sets the designated parameter to the given Java |
abstract Unit |
Sets the designated parameter to the given |
abstract Unit |
Sets the designated parameter to the given |
abstract Unit |
setTimestamp(parameterName: String!, x: Timestamp!) Sets the designated parameter to the given |
abstract Unit |
setTimestamp(parameterName: String!, x: Timestamp!, cal: Calendar!) Sets the designated parameter to the given |
abstract Unit |
Sets the designated parameter to the given |
abstract Boolean |
wasNull() Retrieves whether the last OUT parameter read had the value of SQL |
Inherited functions | |
---|---|
Public methods
getArray
abstract fun getArray(parameterIndex: Int): Array!
Retrieves the value of the designated JDBC ARRAY
parameter as an java.sql.Array
object in the Java programming language.
Parameters | |
---|---|
parameterIndex |
Int: the first parameter is 1, the second is 2, and so on |
Return | |
---|---|
Array! |
the parameter value as an Array object in the Java programming language. If the value was SQL NULL , the value null is returned. |
Exceptions | |
---|---|
java.sql.SQLException |
if the parameterIndex is not valid; if a database access error occurs or this method is called on a closed CallableStatement |
java.sql.SQLFeatureNotSupportedException |
if the JDBC driver does not support this method |
getArray
abstract fun getArray(parameterName: String!): Array!
Retrieves the value of a JDBC ARRAY
parameter as an java.sql.Array
object in the Java programming language.
Parameters | |
---|---|
parameterName |
String!: the name of the parameter |
Return | |
---|---|
Array! |
the parameter value as an Array object in Java programming language. If the value was SQL NULL , the value null is returned. |
Exceptions | |
---|---|
java.sql.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 |
java.sql.SQLFeatureNotSupportedException |
if the JDBC driver does not support this method |
getBigDecimal
abstract fungetBigDecimal(
parameterIndex: Int,
scale: Int
): BigDecimal!
Deprecated: use getBigDecimal(int parameterIndex)
oder getBigDecimal(String parameterName)
Retrieves the value of the designated JDBC NUMERIC
parameter as a java.math.BigDecimal
object with scale digits to the right of the decimal point.
Parameters | |
---|---|
parameterIndex |
Int: the first parameter is 1, the second is 2, and so on |
scale |
Int: the number of digits to the right of the decimal point |
Return | |
---|---|
BigDecimal! |
the parameter value. If the value is SQL NULL , the result is null . |
Exceptions | |
---|---|
java.sql.SQLException |
if the parameterIndex is not valid; if a database access error occurs or this method is called on a closed CallableStatement |
java.sql.SQLFeatureNotSupportedException |
if the JDBC driver does not support this method |
See Also
getBigDecimal
abstract fun getBigDecimal(parameterIndex: Int): BigDecimal!
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.
Parameters | |
---|---|
parameterIndex |
Int: the first parameter is 1, the second is 2, and so on |
Return | |
---|---|
BigDecimal! |
the parameter value in full precision. If the value is SQL NULL , the result is null . |
Exceptions | |
---|---|
java.sql.SQLException |
if the parameterIndex is not valid; if a database access error occurs or this method is called on a closed CallableStatement |
See Also
getBigDecimal
abstract fun getBigDecimal(parameterName: String!): BigDecimal!
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.
Parameters | |
---|---|
parameterName |
String!: the name of the parameter |
Return | |
---|---|
BigDecimal! |
the parameter value in full precision. If the value is SQL NULL , the result is null . |
Exceptions | |
---|---|
SQLExceptionif |
parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closed CallableStatement |
java.sql.SQLFeatureNotSupportedException |
if the JDBC driver does not support this method |
See Also
getBlob
abstract fun getBlob(parameterIndex: Int): Blob!
Retrieves the value of the designated JDBC BLOB
parameter as a java.sql.Blob
object in the Java programming language.
Parameters | |
---|---|
parameterIndex |
Int: the first parameter is 1, the second is 2, and so on |
Return | |
---|---|
Blob! |
the parameter value as a Blob object in the Java programming language. If the value was SQL NULL , the value null is returned. |
Exceptions | |
---|---|
java.sql.SQLException |
if the parameterIndex is not valid; if a database access error occurs or this method is called on a closed CallableStatement |
java.sql.SQLFeatureNotSupportedException |
if the JDBC driver does not support this method |
getBlob
abstract fun getBlob(parameterName: String!): Blob!
Retrieves the value of a JDBC BLOB
parameter as a java.sql.Blob
object in the Java programming language.
Parameters | |
---|---|
parameterName |
String!: the name of the parameter |
Return | |
---|---|
Blob! |
the parameter value as a Blob object in the Java programming language. If the value was SQL NULL , the value null is returned. |
Exceptions | |
---|---|
java.sql.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 |
java.sql.SQLFeatureNotSupportedException |
if the JDBC driver does not support this method |
getBoolean
abstract fun getBoolean(parameterIndex: Int): Boolean
Retrieves the value of the designated JDBC BIT
oder BOOLEAN
parameter as a boolean
in the Java programming language.
Parameters | |
---|---|
parameterIndex |
Int: the first parameter is 1, the second is 2, and so on |
Return | |
---|---|
Boolean |
the parameter value. If the value is SQL NULL , the result is false . |
Exceptions | |
---|---|
java.sql.SQLException |
if the parameterIndex is not valid; if a database access error occurs or this method is called on a closed CallableStatement |
See Also
getBoolean
abstract fun getBoolean(parameterName: String!): Boolean
Retrieves the value of a JDBC BIT
oder BOOLEAN
parameter as a boolean
in the Java programming language.
Parameters | |
---|---|
parameterName |
String!: the name of the parameter |
Return | |
---|---|
Boolean |
the parameter value. If the value is SQL NULL , the result is false . |
Exceptions | |
---|---|
java.sql.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 |
java.sql.SQLFeatureNotSupportedException |
if the JDBC driver does not support this method |
See Also
getByte
abstract fun getByte(parameterIndex: Int): Byte
Retrieves the value of the designated JDBC TINYINT
parameter as a byte
in the Java programming language.
Parameters | |
---|---|
parameterIndex |
Int: the first parameter is 1, the second is 2, and so on |
Return | |
---|---|
Byte |
the parameter value. If the value is SQL NULL , the result is 0 . |
Exceptions | |
---|---|
java.sql.SQLException |
if the parameterIndex is not valid; if a database access error occurs or this method is called on a closed CallableStatement |
See Also
getByte
abstract fun getByte(parameterName: String!): Byte
Retrieves the value of a JDBC TINYINT
parameter as a byte
in the Java programming language.
Parameters | |
---|---|
parameterName |
String!: the name of the parameter |
Return | |
---|---|
Byte |
the parameter value. If the value is SQL NULL , the result is 0 . |
Exceptions | |
---|---|
java.sql.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 |
java.sql.SQLFeatureNotSupportedException |
if the JDBC driver does not support this method |
See Also
getBytes
abstract fun getBytes(parameterIndex: Int): ByteArray!
Retrieves the value of the designated JDBC BINARY
oder VARBINARY
parameter as an array of byte
values in the Java programming language.
Parameters | |
---|---|
parameterIndex |
Int: the first parameter is 1, the second is 2, and so on |
Return | |
---|---|
ByteArray! |
the parameter value. If the value is SQL NULL , the result is null . |
Exceptions | |
---|---|
java.sql.SQLException |
if the parameterIndex is not valid; if a database access error occurs or this method is called on a closed CallableStatement |
See Also
getBytes
abstract fun getBytes(parameterName: String!): ByteArray!
Retrieves the value of a JDBC BINARY
oder VARBINARY
parameter as an array of byte
values in the Java programming language.
Parameters | |
---|---|
parameterName |
String!: the name of the parameter |
Return | |
---|---|
ByteArray! |
the parameter value. If the value is SQL NULL , the result is null . |
Exceptions | |
---|---|
java.sql.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 |
java.sql.SQLFeatureNotSupportedException |
if the JDBC driver does not support this method |
See Also
getCharacterStream
abstract fun getCharacterStream(parameterIndex: Int): Reader!
Retrieves the value of the designated parameter as a java.io.Reader
object in the Java programming language.
Parameters | |
---|---|
parameterIndex |
Int: the first parameter is 1, the second is 2, ... |
Return | |
---|---|
Reader! |
a 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. |
Exceptions | |
---|---|
java.sql.SQLException |
if the parameterIndex is not valid; if a database access error occurs or this method is called on a closed CallableStatement |
getCharacterStream
abstract fun getCharacterStream(parameterName: String!): Reader!
Retrieves the value of the designated parameter as a java.io.Reader
object in the Java programming language.
Parameters | |
---|---|
parameterName |
String!: the name of the parameter |
Return | |
---|---|
Reader! |
a 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 |
Exceptions | |
---|---|
java.sql.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 |
java.sql.SQLFeatureNotSupportedException |
if the JDBC driver does not support this method |
getClob
abstract fun getClob(parameterIndex: Int): Clob!
Retrieves the value of the designated JDBC CLOB
parameter as a java.sql.Clob
object in the Java programming language.
Parameters | |
---|---|
parameterIndex |
Int: the first parameter is 1, the second is 2, and so on |
Return | |
---|---|
Clob! |
the parameter value as a Clob object in the Java programming language. If the value was SQL NULL , the value null is returned. |
Exceptions | |
---|---|
java.sql.SQLException |
if the parameterIndex is not valid; if a database access error occurs or this method is called on a closed CallableStatement |
java.sql.SQLFeatureNotSupportedException |
if the JDBC driver does not support this method |
getClob
abstract fun getClob(parameterName: String!): Clob!
Retrieves the value of a JDBC CLOB
parameter as a java.sql.Clob
object in the Java programming language.
Parameters | |
---|---|
parameterName |
String!: the name of the parameter |
Return | |
---|---|
Clob! |
the parameter value as a Clob object in the Java programming language. If the value was SQL NULL , the value null is returned. |
Exceptions | |
---|---|
java.sql.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 |
java.sql.SQLFeatureNotSupportedException |
if the JDBC driver does not support this method |
getDate
abstract fun getDate(parameterIndex: Int): Date!
Retrieves the value of the designated JDBC DATE
parameter as a java.sql.Date
object.
Parameters | |
---|---|
parameterIndex |
Int: the first parameter is 1, the second is 2, and so on |
Return | |
---|---|
Date! |
the parameter value. If the value is SQL NULL , the result is null . |
Exceptions | |
---|---|
java.sql.SQLException |
if the parameterIndex is not valid; if a database access error occurs or this method is called on a closed CallableStatement |
See Also
getDate
abstract fun getDate(
parameterIndex: Int,
cal: Calendar!
): Date!
Retrieves the value of the designated JDBC 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.
Parameters | |
---|---|
parameterIndex |
Int: the first parameter is 1, the second is 2, and so on |
cal |
Calendar!: the Calendar object the driver will use to construct the date |
Return | |
---|---|
Date! |
the parameter value. If the value is SQL NULL , the result is null . |
Exceptions | |
---|---|
java.sql.SQLException |
if the parameterIndex is not valid; if a database access error occurs or this method is called on a closed CallableStatement |
See Also
getDate
abstract fun getDate(parameterName: String!): Date!
Retrieves the value of a JDBC DATE
parameter as a java.sql.Date
object.
Parameters | |
---|---|
parameterName |
String!: the name of the parameter |
Return | |
---|---|
Date! |
the parameter value. If the value is SQL NULL , the result is null . |
Exceptions | |
---|---|
java.sql.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 |
java.sql.SQLFeatureNotSupportedException |
if the JDBC driver does not support this method |
See Also
getDate
abstract fun getDate(
parameterName: String!,
cal: Calendar!
): Date!
Retrieves the value of a JDBC 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.
Parameters | |
---|---|
parameterName |
String!: the name of the parameter |
cal |
Calendar!: the Calendar object the driver will use to construct the date |
Return | |
---|---|
Date! |
the parameter value. If the value is SQL NULL , the result is null . |
Exceptions | |
---|---|
java.sql.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 |
java.sql.SQLFeatureNotSupportedException |
if the JDBC driver does not support this method |
See Also
getDouble
abstract fun getDouble(parameterIndex: Int): Double
Retrieves the value of the designated JDBC DOUBLE
parameter as a double
in the Java programming language.
Parameters | |
---|---|
parameterIndex |
Int: the first parameter is 1, the second is 2, and so on |
Return | |
---|---|
Double |
the parameter value. If the value is SQL NULL , the result is 0 . |
Exceptions | |
---|---|
java.sql.SQLException |
if the parameterIndex is not valid; if a database access error occurs or this method is called on a closed CallableStatement |
See Also
getDouble
abstract fun getDouble(parameterName: String!): Double
Retrieves the value of a JDBC DOUBLE
parameter as a double
in the Java programming language.
Parameters | |
---|---|
parameterName |
String!: the name of the parameter |
Return | |
---|---|
Double |
the parameter value. If the value is SQL NULL , the result is 0 . |
Exceptions | |
---|---|
java.sql.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 |
java.sql.SQLFeatureNotSupportedException |
if the JDBC driver does not support this method |
See Also
getFloat
abstract fun getFloat(parameterIndex: Int): Float
Retrieves the value of the designated JDBC FLOAT
parameter as a float
in the Java programming language.
Parameters | |
---|---|
parameterIndex |
Int: the first parameter is 1, the second is 2, and so on |
Return | |
---|---|
Float |
the parameter value. If the value is SQL NULL , the result is 0 . |
Exceptions | |
---|---|
java.sql.SQLException |
if the parameterIndex is not valid; if a database access error occurs or this method is called on a closed CallableStatement |
See Also
getFloat
abstract fun getFloat(parameterName: String!): Float
Retrieves the value of a JDBC FLOAT
parameter as a float
in the Java programming language.
Parameters | |
---|---|
parameterName |
String!: the name of the parameter |
Return | |
---|---|
Float |
the parameter value. If the value is SQL NULL , the result is 0 . |
Exceptions | |
---|---|
java.sql.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 |
java.sql.SQLFeatureNotSupportedException |
if the JDBC driver does not support this method |
See Also
getInt
abstract fun getInt(parameterIndex: Int): Int
Retrieves the value of the designated JDBC INTEGER
parameter as an int
in the Java programming language.
Parameters | |
---|---|
parameterIndex |
Int: the first parameter is 1, the second is 2, and so on |
Return | |
---|---|
Int |
the parameter value. If the value is SQL NULL , the result is 0 . |
Exceptions | |
---|---|
java.sql.SQLException |
if the parameterIndex is not valid; if a database access error occurs or this method is called on a closed CallableStatement |
See Also
getInt
abstract fun getInt(parameterName: String!): Int
Retrieves the value of a JDBC INTEGER
parameter as an int
in the Java programming language.
Parameters | |
---|---|
parameterName |
String!: the name of the parameter |
Return | |
---|---|
Int |
the parameter value. If the value is SQL NULL , the result is 0 . |
Exceptions | |
---|---|
java.sql.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 |
java.sql.SQLFeatureNotSupportedException |
if the JDBC driver does not support this method |
See Also
getLong
abstract fun getLong(parameterIndex: Int): Long
Retrieves the value of the designated JDBC BIGINT
parameter as a long
in the Java programming language.
Parameters | |
---|---|
parameterIndex |
Int: the first parameter is 1, the second is 2, and so on |
Return | |
---|---|
Long |
the parameter value. If the value is SQL NULL , the result is 0 . |
Exceptions | |
---|---|
java.sql.SQLException |
if the parameterIndex is not valid; if a database access error occurs or this method is called on a closed CallableStatement |
See Also
getLong
abstract fun getLong(parameterName: String!): Long
Retrieves the value of a JDBC BIGINT
parameter as a long
in the Java programming language.
Parameters | |
---|---|
parameterName |
String!: the name of the parameter |
Return | |
---|---|
Long |
the parameter value. If the value is SQL NULL , the result is 0 . |
Exceptions | |
---|---|
java.sql.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 |
java.sql.SQLFeatureNotSupportedException |
if the JDBC driver does not support this method |
See Also
getNCharacterStream
abstract fun getNCharacterStream(parameterIndex: Int): Reader!
Retrieves the value of the designated parameter as a java.io.Reader
object in the Java programming language. It is intended for use when accessing NCHAR
,NVARCHAR
and LONGNVARCHAR
parameters.
Parameters | |
---|---|
parameterIndex |
Int: the first parameter is 1, the second is 2, ... |
Return | |
---|---|
Reader! |
a 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. |
Exceptions | |
---|---|
java.sql.SQLException |
if the parameterIndex is not valid; if a database access error occurs or this method is called on a closed CallableStatement |
java.sql.SQLFeatureNotSupportedException |
if the JDBC driver does not support this method |
getNCharacterStream
abstract fun getNCharacterStream(parameterName: String!): Reader!
Retrieves the value of the designated parameter as a java.io.Reader
object in the Java programming language. It is intended for use when accessing NCHAR
,NVARCHAR
and LONGNVARCHAR
parameters.
Parameters | |
---|---|
parameterName |
String!: the name of the parameter |
Return | |
---|---|
Reader! |
a 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 |
Exceptions | |
---|---|
java.sql.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 |
java.sql.SQLFeatureNotSupportedException |
if the JDBC driver does not support this method |
getNClob
abstract fun getNClob(parameterIndex: Int): NClob!
Retrieves the value of the designated JDBC NCLOB
parameter as a java.sql.NClob
object in the Java programming language.
Parameters | |
---|---|
parameterIndex |
Int: the first parameter is 1, the second is 2, and so on |
Return | |
---|---|
NClob! |
the parameter value as a NClob object in the Java programming language. If the value was SQL NULL , the value null is returned. |
Exceptions | |
---|---|
java.sql.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 CallableStatement |
java.sql.SQLFeatureNotSupportedException |
if the JDBC driver does not support this method |
getNClob
abstract fun getNClob(parameterName: String!): NClob!
Retrieves the value of a JDBC NCLOB
parameter as a java.sql.NClob
object in the Java programming language.
Parameters | |
---|---|
parameterName |
String!: the name of the parameter |
Return | |
---|---|
NClob! |
the parameter value as a NClob object in the Java programming language. If the value was SQL NULL , the value null is returned. |
Exceptions | |
---|---|
java.sql.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 CallableStatement |
java.sql.SQLFeatureNotSupportedException |
if the JDBC driver does not support this method |
getNString
abstract fun getNString(parameterIndex: Int): String!
Retrieves the value of the designated NCHAR
, NVARCHAR
oder 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.
Parameters | |
---|---|
parameterIndex |
Int: index of the first parameter is 1, the second is 2, ... |
Return | |
---|---|
String! |
a String object that maps an NCHAR , NVARCHAR oder LONGNVARCHAR value |
Exceptions | |
---|---|
java.sql.SQLException |
if the parameterIndex is not valid; if a database access error occurs or this method is called on a closed CallableStatement |
java.sql.SQLFeatureNotSupportedException |
if the JDBC driver does not support this method |
See Also
getNString
abstract fun getNString(parameterName: String!): String!
Retrieves the value of the designated NCHAR
, NVARCHAR
oder 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.
Parameters | |
---|---|
parameterName |
String!: the name of the parameter |
Return | |
---|---|
String! |
a String object that maps an NCHAR , NVARCHAR oder LONGNVARCHAR value |
Exceptions | |
---|---|
java.sql.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 |
java.sql.SQLFeatureNotSupportedException |
if the JDBC driver does not support this method |
See Also
getObject
abstract fun getObject(parameterIndex: Int): Any!
Retrieves the value of the designated parameter as an 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.
Parameters | |
---|---|
parameterIndex |
Int: the first parameter is 1, the second is 2, and so on |
Return | |
---|---|
Any! |
A java.lang.Object holding the OUT parameter value |
Exceptions | |
---|---|
java.sql.SQLException |
if the parameterIndex is not valid; if a database access error occurs or this method is called on a closed CallableStatement |
See Also
getObject
abstract fun getObject(
parameterIndex: Int,
map: MutableMap<String!, Class<*>!>!
): Any!
Returns an object representing the value of OUT parameter 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.
Parameters | |
---|---|
parameterIndex |
Int: the first parameter is 1, the second is 2, and so on |
map |
MutableMap<String!, Class<*>!>!: the mapping from SQL type names to Java classes |
Return | |
---|---|
Any! |
a java.lang.Object holding the OUT parameter value |
Exceptions | |
---|---|
java.sql.SQLException |
if the parameterIndex is not valid; if a database access error occurs or this method is called on a closed CallableStatement |
java.sql.SQLFeatureNotSupportedException |
if the JDBC driver does not support this method |
See Also
getObject
abstract fun getObject(parameterName: String!): Any!
Retrieves the value of a parameter as an 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.
Parameters | |
---|---|
parameterName |
String!: the name of the parameter |
Return | |
---|---|
Any! |
A java.lang.Object holding the OUT parameter value. |
Exceptions | |
---|---|
java.sql.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 |
java.sql.SQLFeatureNotSupportedException |
if the JDBC driver does not support this method |
See Also
getObject
abstract fun getObject(
parameterName: String!,
map: MutableMap<String!, Class<*>!>!
): Any!
Returns an object representing the value of OUT parameter 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.
Parameters | |
---|---|
parameterName |
String!: the name of the parameter |
map |
MutableMap<String!, Class<*>!>!: the mapping from SQL type names to Java classes |
Return | |
---|---|
Any! |
a java.lang.Object holding the OUT parameter value |
Exceptions | |
---|---|
java.sql.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 |
java.sql.SQLFeatureNotSupportedException |
if the JDBC driver does not support this method |
See Also
getRef
abstract fun getRef(parameterIndex: Int): Ref!
Retrieves the value of the designated JDBC REF(<structured-type>)
parameter as a java.sql.Ref
object in the Java programming language.
Parameters | |
---|---|
parameterIndex |
Int: the first parameter is 1, the second is 2, and so on |
Return | |
---|---|
Ref! |
the parameter value as a Ref object in the Java programming language. If the value was SQL NULL , the value null is returned. |
Exceptions | |
---|---|
java.sql.SQLException |
if the parameterIndex is not valid; if a database access error occurs or this method is called on a closed CallableStatement |
java.sql.SQLFeatureNotSupportedException |
if the JDBC driver does not support this method |
getRef
abstract fun getRef(parameterName: String!): Ref!
Retrieves the value of a JDBC REF(<structured-type>)
parameter as a java.sql.Ref
object in the Java programming language.
Parameters | |
---|---|
parameterName |
String!: the name of the parameter |
Return | |
---|---|
Ref! |
the parameter value as a Ref object in the Java programming language. If the value was SQL NULL , the value null is returned. |
Exceptions | |
---|---|
java.sql.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 |
java.sql.SQLFeatureNotSupportedException |
if the JDBC driver does not support this method |
getRowId
abstract fun getRowId(parameterIndex: Int): RowId!
Retrieves the value of the designated JDBC ROWID
parameter as a java.sql.RowId
object.
Parameters | |
---|---|
parameterIndex |
Int: the first parameter is 1, the second is 2,... |
Return | |
---|---|
RowId! |
a 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. |
Exceptions | |
---|---|
java.sql.SQLException |
if the parameterIndex is not valid; if a database access error occurs or this method is called on a closed CallableStatement |
java.sql.SQLFeatureNotSupportedException |
if the JDBC driver does not support this method |
getRowId
abstract fun getRowId(parameterName: String!): RowId!
Retrieves the value of the designated JDBC ROWID
parameter as a java.sql.RowId
object.
Parameters | |
---|---|
parameterName |
String!: the name of the parameter |
Return | |
---|---|
RowId! |
a 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. |
Exceptions | |
---|---|
java.sql.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 |
java.sql.SQLFeatureNotSupportedException |
if the JDBC driver does not support this method |
getSQLXML
abstract fun getSQLXML(parameterIndex: Int): SQLXML!
Retrieves the value of the designated SQL XML
parameter as a java.sql.SQLXML
object in the Java programming language.
Parameters | |
---|---|
parameterIndex |
Int: index of the first parameter is 1, the second is 2, ... |
Return | |
---|---|
SQLXML! |
a SQLXML object that maps an SQL XML value |
Exceptions | |
---|---|
java.sql.SQLException |
if the parameterIndex is not valid; if a database access error occurs or this method is called on a closed CallableStatement |
java.sql.SQLFeatureNotSupportedException |
if the JDBC driver does not support this method |
getSQLXML
abstract fun getSQLXML(parameterName: String!): SQLXML!
Retrieves the value of the designated SQL XML
parameter as a java.sql.SQLXML
object in the Java programming language.
Parameters | |
---|---|
parameterName |
String!: the name of the parameter |
Return | |
---|---|
SQLXML! |
a SQLXML object that maps an SQL XML value |
Exceptions | |
---|---|
java.sql.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 |
java.sql.SQLFeatureNotSupportedException |
if the JDBC driver does not support this method |
getShort
abstract fun getShort(parameterIndex: Int): Short
Retrieves the value of the designated JDBC SMALLINT
parameter as a short
in the Java programming language.
Parameters | |
---|---|
parameterIndex |
Int: the first parameter is 1, the second is 2, and so on |
Return | |
---|---|
Short |
the parameter value. If the value is SQL NULL , the result is 0 . |
Exceptions | |
---|---|
java.sql.SQLException |
if the parameterIndex is not valid; if a database access error occurs or this method is called on a closed CallableStatement |
See Also
getShort
abstract fun getShort(parameterName: String!): Short
Retrieves the value of a JDBC SMALLINT
parameter as a short
in the Java programming language.
Parameters | |
---|---|
parameterName |
String!: the name of the parameter |
Return | |
---|---|
Short |
the parameter value. If the value is SQL NULL , the result is 0 . |
Exceptions | |
---|---|
java.sql.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 |
java.sql.SQLFeatureNotSupportedException |
if the JDBC driver does not support this method |
See Also
getString
abstract fun getString(parameterIndex: Int): String!
Retrieves the value of the designated JDBC 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.
Parameters | |
---|---|
parameterIndex |
Int: the first parameter is 1, the second is 2, and so on |
Return | |
---|---|
String! |
the parameter value. If the value is SQL NULL , the result is null . |
Exceptions | |
---|---|
java.sql.SQLException |
if the parameterIndex is not valid; if a database access error occurs or this method is called on a closed CallableStatement |
See Also
getString
abstract fun getString(parameterName: String!): String!
Retrieves the value of a JDBC 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.
Parameters | |
---|---|
parameterName |
String!: the name of the parameter |
Return | |
---|---|
String! |
the parameter value. If the value is SQL NULL , the result is null . |
Exceptions | |
---|---|
java.sql.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 |
java.sql.SQLFeatureNotSupportedException |
if the JDBC driver does not support this method |
See Also
getTime
abstract fun getTime(parameterIndex: Int): Time!
Retrieves the value of the designated JDBC TIME
parameter as a java.sql.Time
object.
Parameters | |
---|---|
parameterIndex |
Int: the first parameter is 1, the second is 2, and so on |
Return | |
---|---|
Time! |
the parameter value. If the value is SQL NULL , the result is null . |
Exceptions | |
---|---|
java.sql.SQLException |
if the parameterIndex is not valid; if a database access error occurs or this method is called on a closed CallableStatement |
See Also
getTime
abstract fun getTime(
parameterIndex: Int,
cal: Calendar!
): Time!
Retrieves the value of the designated JDBC 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.
Parameters | |
---|---|
parameterIndex |
Int: the first parameter is 1, the second is 2, and so on |
cal |
Calendar!: the Calendar object the driver will use to construct the time |
Return | |
---|---|
Time! |
the parameter value; if the value is SQL NULL , the result is null . |
Exceptions | |
---|---|
java.sql.SQLException |
if the parameterIndex is not valid; if a database access error occurs or this method is called on a closed CallableStatement |
See Also
getTime
abstract fun getTime(parameterName: String!): Time!
Retrieves the value of a JDBC TIME
parameter as a java.sql.Time
object.
Parameters | |
---|---|
parameterName |
String!: the name of the parameter |
Return | |
---|---|
Time! |
the parameter value. If the value is SQL NULL , the result is null . |
Exceptions | |
---|---|
java.sql.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 |
java.sql.SQLFeatureNotSupportedException |
if the JDBC driver does not support this method |
See Also
getTime
abstract fun getTime(
parameterName: String!,
cal: Calendar!
): Time!
Retrieves the value of a JDBC 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.
Parameters | |
---|---|
parameterName |
String!: the name of the parameter |
cal |
Calendar!: the Calendar object the driver will use to construct the time |
Return | |
---|---|
Time! |
the parameter value; if the value is SQL NULL , the result is null . |
Exceptions | |
---|---|
java.sql.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 |
java.sql.SQLFeatureNotSupportedException |
if the JDBC driver does not support this method |
See Also
getTimestamp
abstract fun getTimestamp(parameterIndex: Int): Timestamp!
Retrieves the value of the designated JDBC TIMESTAMP
parameter as a java.sql.Timestamp
object.
Parameters | |
---|---|
parameterIndex |
Int: the first parameter is 1, the second is 2, and so on |
Return | |
---|---|
Timestamp! |
the parameter value. If the value is SQL NULL , the result is null . |
Exceptions | |
---|---|
java.sql.SQLException |
if the parameterIndex is not valid; if a database access error occurs or this method is called on a closed CallableStatement |
See Also
getTimestamp
abstract fun getTimestamp(
parameterIndex: Int,
cal: Calendar!
): Timestamp!
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. 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.
Parameters | |
---|---|
parameterIndex |
Int: the first parameter is 1, the second is 2, and so on |
cal |
Calendar!: the Calendar object the driver will use to construct the timestamp |
Return | |
---|---|
Timestamp! |
the parameter value. If the value is SQL NULL , the result is null . |
Exceptions | |
---|---|
java.sql.SQLException |
if the parameterIndex is not valid; if a database access error occurs or this method is called on a closed CallableStatement |
See Also
getTimestamp
abstract fun getTimestamp(parameterName: String!): Timestamp!
Retrieves the value of a JDBC TIMESTAMP
parameter as a java.sql.Timestamp
object.
Parameters | |
---|---|
parameterName |
String!: the name of the parameter |
Return | |
---|---|
Timestamp! |
the parameter value. If the value is SQL NULL , the result is null . |
Exceptions | |
---|---|
java.sql.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 |
java.sql.SQLFeatureNotSupportedException |
if the JDBC driver does not support this method |
See Also
getTimestamp
abstract fun getTimestamp(
parameterName: String!,
cal: Calendar!
): Timestamp!
Retrieves the value of a JDBC 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.
Parameters | |
---|---|
parameterName |
String!: the name of the parameter |
cal |
Calendar!: the Calendar object the driver will use to construct the timestamp |
Return | |
---|---|
Timestamp! |
the parameter value. If the value is SQL NULL , the result is null . |
Exceptions | |
---|---|
java.sql.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 |
java.sql.SQLFeatureNotSupportedException |
if the JDBC driver does not support this method |
See Also
getURL
abstract fun getURL(parameterIndex: Int): URL!
Retrieves the value of the designated JDBC DATALINK
parameter as a java.net.URL
object.
Parameters | |
---|---|
parameterIndex |
Int: the first parameter is 1, the second is 2,... |
Return | |
---|---|
URL! |
a java.net.URL object that represents the JDBC DATALINK value used as the designated parameter |
Exceptions | |
---|---|
java.sql.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 platform |
java.sql.SQLFeatureNotSupportedException |
if the JDBC driver does not support this method |
See Also
getURL
abstract fun getURL(parameterName: String!): URL!
Retrieves the value of a JDBC DATALINK
parameter as a java.net.URL
object.
Parameters | |
---|---|
parameterName |
String!: the name of the parameter |
Return | |
---|---|
URL! |
the parameter value as a java.net.URL object in the Java programming language. If the value was SQL NULL , the value null is returned. |
Exceptions | |
---|---|
java.sql.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 URL |
java.sql.SQLFeatureNotSupportedException |
if the JDBC driver does not support this method |
See Also
registerOutParameter
abstract fun registerOutParameter(
parameterIndex: Int,
sqlType: Int
): Unit
Registers the OUT parameter in ordinal position 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 retrieves the value.
Parameters | |
---|---|
parameterIndex |
Int: the first parameter is 1, the second is 2, and so on |
sqlType |
Int: the JDBC type code defined by java.sql.Types . If the parameter is of JDBC type NUMERIC oder DECIMAL , the version of registerOutParameter that accepts a scale value should be used. |
Exceptions | |
---|---|
java.sql.SQLException |
if the parameterIndex is not valid; if a database access error occurs or this method is called on a closed CallableStatement |
java.sql.SQLFeatureNotSupportedException |
if sqlType is a ARRAY , BLOB , CLOB , DATALINK , JAVA_OBJECT , NCHAR , NCLOB , NVARCHAR , LONGNVARCHAR , REF , ROWID , SQLXML oder STRUCT data type and the JDBC driver does not support this data type |
See Also
registerOutParameter
abstract fun registerOutParameter(
parameterIndex: Int,
sqlType: Int,
scale: Int
): Unit
Registers the parameter in ordinal position 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
oder DECIMAL
.
Parameters | |
---|---|
parameterIndex |
Int: the first parameter is 1, the second is 2, and so on |
sqlType |
Int: the SQL type code defined by java.sql.Types . |
scale |
Int: the desired number of digits to the right of the decimal point. It must be greater than or equal to zero. |
Exceptions | |
---|---|
java.sql.SQLException |
if the parameterIndex is not valid; if a database access error occurs or this method is called on a closed CallableStatement |
java.sql.SQLFeatureNotSupportedException |
if sqlType is a ARRAY , BLOB , CLOB , DATALINK , JAVA_OBJECT , NCHAR , NCLOB , NVARCHAR , LONGNVARCHAR , REF , ROWID , SQLXML oder STRUCT data type and the JDBC driver does not support this data type |
See Also
registerOutParameter
abstract fun registerOutParameter(
parameterIndex: Int,
sqlType: Int,
typeName: String!
): Unit
Registers the designated output parameter. This version of the method 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.
Parameters | |
---|---|
parameterIndex |
Int: the first parameter is 1, the second is 2,... |
sqlType |
Int: a value from java.sql.Types |
typeName |
String!: the fully-qualified name of an SQL structured type |
Exceptions | |
---|---|
java.sql.SQLException |
if the parameterIndex is not valid; if a database access error occurs or this method is called on a closed CallableStatement |
java.sql.SQLFeatureNotSupportedException |
if sqlType is a ARRAY , BLOB , CLOB , DATALINK , JAVA_OBJECT , NCHAR , NCLOB , NVARCHAR , LONGNVARCHAR , REF , ROWID , SQLXML oder STRUCT data type and the JDBC driver does not support this data type |
See Also
registerOutParameter
abstract fun registerOutParameter(
parameterName: String!,
sqlType: Int
): Unit
Registers the OUT parameter named 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 retrieves the value.
Parameters | |
---|---|
parameterName |
String!: the name of the parameter |
sqlType |
Int: the JDBC type code defined by java.sql.Types . If the parameter is of JDBC type NUMERIC oder DECIMAL , the version of registerOutParameter that accepts a scale value should be used. |
Exceptions | |
---|---|
java.sql.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 |
java.sql.SQLFeatureNotSupportedException |
if sqlType is a ARRAY , BLOB , CLOB , DATALINK , JAVA_OBJECT , NCHAR , NCLOB , NVARCHAR , LONGNVARCHAR , REF , ROWID , SQLXML oder STRUCT data type and the JDBC driver does not support this data type or if the JDBC driver does not support this method |
See Also
registerOutParameter
abstract fun registerOutParameter(
parameterName: String!,
sqlType: Int,
scale: Int
): Unit
Registers the parameter named 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
oder DECIMAL
.
Parameters | |
---|---|
parameterName |
String!: the name of the parameter |
sqlType |
Int: SQL type code defined by java.sql.Types . |
scale |
Int: the desired number of digits to the right of the decimal point. It must be greater than or equal to zero. |
Exceptions | |
---|---|
java.sql.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 |
java.sql.SQLFeatureNotSupportedException |
if sqlType is a ARRAY , BLOB , CLOB , DATALINK , JAVA_OBJECT , NCHAR , NCLOB , NVARCHAR , LONGNVARCHAR , REF , ROWID , SQLXML oder STRUCT data type and the JDBC driver does not support this data type or if the JDBC driver does not support this method |
See Also
registerOutParameter
abstract fun registerOutParameter(
parameterName: String!,
sqlType: Int,
typeName: String!
): Unit
Registers the designated output parameter. This version of the method 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.
Parameters | |
---|---|
parameterName |
String!: the name of the parameter |
sqlType |
Int: a value from java.sql.Types |
typeName |
String!: the fully-qualified name of an SQL structured type |
Exceptions | |
---|---|
java.sql.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 |
java.sql.SQLFeatureNotSupportedException |
if sqlType is a ARRAY , BLOB , CLOB , DATALINK , JAVA_OBJECT , NCHAR , NCLOB , NVARCHAR , LONGNVARCHAR , REF , ROWID , SQLXML oder STRUCT data type and the JDBC driver does not support this data type or if the JDBC driver does not support this method |
See Also
setAsciiStream
abstract fun setAsciiStream(
parameterName: String!,
x: InputStream!,
length: Int
): Unit
Sets the designated parameter to the given input stream, which will have the specified number of bytes. When a very large ASCII value is input to a 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.
Parameters | |
---|---|
parameterName |
String!: the name of the parameter |
x |
InputStream!: the Java input stream that contains the ASCII parameter value |
length |
Int: the number of bytes in the stream |
Exceptions | |
---|---|
java.sql.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 |
java.sql.SQLFeatureNotSupportedException |
if the JDBC driver does not support this method |
setAsciiStream
abstract fun setAsciiStream(
parameterName: String!,
x: InputStream!,
length: Long
): Unit
Sets the designated parameter to the given input stream, which will have the specified number of bytes. When a very large ASCII value is input to a 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.
Parameters | |
---|---|
parameterName |
String!: the name of the parameter |
x |
InputStream!: the Java input stream that contains the ASCII parameter value |
length |
Long: the number of bytes in the stream |
Exceptions | |
---|---|
java.sql.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 |
java.sql.SQLFeatureNotSupportedException |
if the JDBC driver does not support this method |
setAsciiStream
abstract fun setAsciiStream(
parameterName: String!,
x: InputStream!
): Unit
Sets the designated parameter to the given input stream. When a very large ASCII value is input to a 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.
Parameters | |
---|---|
parameterName |
String!: the name of the parameter |
x |
InputStream!: the Java input stream that contains the ASCII parameter value |
Exceptions | |
---|---|
java.sql.SQLFeatureNotSupportedException |
if the JDBC driver does not support this method |
java.sql.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 |
setBigDecimal
abstract fun setBigDecimal(
parameterName: String!,
x: BigDecimal!
): Unit
Sets the designated parameter to the given java.math.BigDecimal
value. The driver converts this to an SQL NUMERIC
value when it sends it to the database.
Parameters | |
---|---|
parameterName |
String!: the name of the parameter |
x |
BigDecimal!: the parameter value |
Exceptions | |
---|---|
java.sql.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 |
java.sql.SQLFeatureNotSupportedException |
if the JDBC driver does not support this method |
See Also
setBinaryStream
abstract fun setBinaryStream(
parameterName: String!,
x: InputStream!,
length: Int
): Unit
Sets the designated parameter to the given input stream, which will have the specified number of bytes. When a very large binary value is input to a 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.
Parameters | |
---|---|
parameterName |
String!: the name of the parameter |
x |
InputStream!: the java input stream which contains the binary parameter value |
length |
Int: the number of bytes in the stream |
Exceptions | |
---|---|
java.sql.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 |
java.sql.SQLFeatureNotSupportedException |
if the JDBC driver does not support this method |
setBinaryStream
abstract fun setBinaryStream(
parameterName: String!,
x: InputStream!,
length: Long
): Unit
Sets the designated parameter to the given input stream, which will have the specified number of bytes. When a very large binary value is input to a 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.
Parameters | |
---|---|
parameterName |
String!: the name of the parameter |
x |
InputStream!: the java input stream which contains the binary parameter value |
length |
Long: the number of bytes in the stream |
Exceptions | |
---|---|
java.sql.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 |
java.sql.SQLFeatureNotSupportedException |
if the JDBC driver does not support this method |
setBinaryStream
abstract fun setBinaryStream(
parameterName: String!,
x: InputStream!
): Unit
Sets the designated parameter to the given input stream. When a very large binary value is input to a 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.
Parameters | |
---|---|
parameterName |
String!: the name of the parameter |
x |
InputStream!: the java input stream which contains the binary parameter value |
Exceptions | |
---|---|
java.sql.SQLFeatureNotSupportedException |
if the JDBC driver does not support this method |
java.sql.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 |
setBlob
abstract fun setBlob(
parameterName: String!,
inputStream: InputStream!,
length: Long
): Unit
Sets the designated parameter to a 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 BLOB
Parameters | |
---|---|
parameterName |
String!: the name of the parameter to be set the second is 2, ... |
inputStream |
InputStream!: An object that contains the data to set the parameter value to. |
length |
Long: the number of bytes in the parameter data. |
Exceptions | |
---|---|
java.sql.SQLException |
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 specfied length; if a database access error occurs or this method is called on a closed CallableStatement |
java.sql.SQLFeatureNotSupportedException |
if the JDBC driver does not support this method |
setBlob
abstract fun setBlob(
parameterName: String!,
x: Blob!
): Unit
Sets the designated parameter to the given java.sql.Blob
object. The driver converts this to an SQL BLOB
value when it sends it to the database.
Parameters | |
---|---|
parameterName |
String!: the name of the parameter |
x |
Blob!: a Blob object that maps an SQL BLOB value |
Exceptions | |
---|---|
java.sql.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 |
java.sql.SQLFeatureNotSupportedException |
if the JDBC driver does not support this method |
setBlob
abstract fun setBlob(
parameterName: String!,
inputStream: InputStream!
): Unit
Sets the designated parameter to a 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.
Parameters | |
---|---|
parameterName |
String!: the name of the parameter |
inputStream |
InputStream!: An object that contains the data to set the parameter value to. |
Exceptions | |
---|---|
java.sql.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 |
java.sql.SQLFeatureNotSupportedException |
if the JDBC driver does not support this method |
setBoolean
abstract fun setBoolean(
parameterName: String!,
x: Boolean
): Unit
Sets the designated parameter to the given Java boolean
value. The driver converts this to an SQL BIT
oder BOOLEAN
value when it sends it to the database.
Parameters | |
---|---|
parameterName |
String!: the name of the parameter |
x |
Boolean: the parameter value |
Exceptions | |
---|---|
java.sql.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 |
java.sql.SQLFeatureNotSupportedException |
if the JDBC driver does not support this method |
See Also
setByte
abstract fun setByte(
parameterName: String!,
x: Byte
): Unit
Sets the designated parameter to the given Java byte
value. The driver converts this to an SQL TINYINT
value when it sends it to the database.
Parameters | |
---|---|
parameterName |
String!: the name of the parameter |
x |
Byte: the parameter value |
Exceptions | |
---|---|
java.sql.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 |
java.sql.SQLFeatureNotSupportedException |
if the JDBC driver does not support this method |
See Also
setBytes
abstract fun setBytes(
parameterName: String!,
x: ByteArray!
): Unit
Sets the designated parameter to the given Java array of bytes. The driver converts this to an SQL VARBINARY
oder LONGVARBINARY
(depending on the argument's size relative to the driver's limits on VARBINARY
values) when it sends it to the database.
Parameters | |
---|---|
parameterName |
String!: the name of the parameter |
x |
ByteArray!: the parameter value |
Exceptions | |
---|---|
java.sql.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 |
java.sql.SQLFeatureNotSupportedException |
if the JDBC driver does not support this method |
See Also
setCharacterStream
abstract fun setCharacterStream(
parameterName: String!,
reader: Reader!,
length: Int
): Unit
Sets the designated parameter to the given 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.
Parameters | |
---|---|
parameterName |
String!: the name of the parameter |
reader |
Reader!: the java.io.Reader object that contains the UNICODE data used as the designated parameter |
length |
Int: the number of characters in the stream |
Exceptions | |
---|---|
java.sql.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 |
java.sql.SQLFeatureNotSupportedException |
if the JDBC driver does not support this method |
setCharacterStream
abstract fun setCharacterStream(
parameterName: String!,
reader: Reader!,
length: Long
): Unit
Sets the designated parameter to the given 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.
Parameters | |
---|---|
parameterName |
String!: the name of the parameter |
reader |
Reader!: the java.io.Reader object that contains the UNICODE data used as the designated parameter |
length |
Long: the number of characters in the stream |
Exceptions | |
---|---|
java.sql.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 |
java.sql.SQLFeatureNotSupportedException |
if the JDBC driver does not support this method |
setCharacterStream
abstract fun setCharacterStream(
parameterName: String!,
reader: Reader!
): Unit
Sets the designated parameter to the given 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.
Parameters | |
---|---|
parameterName |
String!: the name of the parameter |
reader |
Reader!: the java.io.Reader object that contains the Unicode data |
Exceptions | |
---|---|
java.sql.SQLFeatureNotSupportedException |
if the JDBC driver does not support this method |
java.sql.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 |
setClob
abstract fun setClob(
parameterName: String!,
reader: Reader!,
length: Long
): Unit
Sets the designated parameter to a 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 CLOB
Parameters | |
---|---|
parameterName |
String!: the name of the parameter to be set |
reader |
Reader!: An object that contains the data to set the parameter value to. |
length |
Long: the number of characters in the parameter data. |
Exceptions | |
---|---|
java.sql.SQLException |
if parameterName does not correspond to a named parameter; if the length specified is less than zero; a database access error occurs or this method is called on a closed CallableStatement |
java.sql.SQLFeatureNotSupportedException |
if the JDBC driver does not support this method |
setClob
abstract fun setClob(
parameterName: String!,
x: Clob!
): Unit
Sets the designated parameter to the given java.sql.Clob
object. The driver converts this to an SQL CLOB
value when it sends it to the database.
Parameters | |
---|---|
parameterName |
String!: the name of the parameter |
x |
Clob!: a Clob object that maps an SQL CLOB value |
Exceptions | |
---|---|
java.sql.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 |
java.sql.SQLFeatureNotSupportedException |
if the JDBC driver does not support this method |
setClob
abstract fun setClob(
parameterName: String!,
reader: Reader!
): Unit
Sets the designated parameter to a 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.
Parameters | |
---|---|
parameterName |
String!: the name of the parameter |
reader |
Reader!: An object that contains the data to set the parameter value to. |
Exceptions | |
---|---|
java.sql.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 |
java.sql.SQLFeatureNotSupportedException |
if the JDBC driver does not support this method |
setDate
abstract fun setDate(
parameterName: String!,
x: Date!
): Unit
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. The driver converts this to an SQL DATE
value when it sends it to the database.
Parameters | |
---|---|
parameterName |
String!: the name of the parameter |
x |
Date!: the parameter value |
Exceptions | |
---|---|
java.sql.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 |
java.sql.SQLFeatureNotSupportedException |
if the JDBC driver does not support this method |
See Also
setDate
abstract fun setDate(
parameterName: String!,
x: Date!,
cal: Calendar!
): Unit
Sets the designated parameter to the given 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.
Parameters | |
---|---|
parameterName |
String!: the name of the parameter |
x |
Date!: the parameter value |
cal |
Calendar!: the Calendar object the driver will use to construct the date |
Exceptions | |
---|---|
java.sql.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 |
java.sql.SQLFeatureNotSupportedException |
if the JDBC driver does not support this method |
See Also
setDouble
abstract fun setDouble(
parameterName: String!,
x: Double
): Unit
Sets the designated parameter to the given Java double
value. The driver converts this to an SQL DOUBLE
value when it sends it to the database.
Parameters | |
---|---|
parameterName |
String!: the name of the parameter |
x |
Double: the parameter value |
Exceptions | |
---|---|
java.sql.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 |
java.sql.SQLFeatureNotSupportedException |
if the JDBC driver does not support this method |
See Also
setFloat
abstract fun setFloat(
parameterName: String!,
x: Float
): Unit
Sets the designated parameter to the given Java float
value. The driver converts this to an SQL FLOAT
value when it sends it to the database.
Parameters | |
---|---|
parameterName |
String!: the name of the parameter |
x |
Float: the parameter value |
Exceptions | |
---|---|
java.sql.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 |
java.sql.SQLFeatureNotSupportedException |
if the JDBC driver does not support this method |
See Also
setInt
abstract fun setInt(
parameterName: String!,
x: Int
): Unit
Sets the designated parameter to the given Java int
value. The driver converts this to an SQL INTEGER
value when it sends it to the database.
Parameters | |
---|---|
parameterName |
String!: the name of the parameter |
x |
Int: the parameter value |
Exceptions | |
---|---|
java.sql.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 |
java.sql.SQLFeatureNotSupportedException |
if the JDBC driver does not support this method |
See Also
setLong
abstract fun setLong(
parameterName: String!,
x: Long
): Unit
Sets the designated parameter to the given Java long
value. The driver converts this to an SQL BIGINT
value when it sends it to the database.
Parameters | |
---|---|
parameterName |
String!: the name of the parameter |
x |
Long: the parameter value |
Exceptions | |
---|---|
java.sql.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 |
java.sql.SQLFeatureNotSupportedException |
if the JDBC driver does not support this method |
See Also
setNCharacterStream
abstract fun setNCharacterStream(
parameterName: String!,
value: Reader!,
length: Long
): Unit
Sets the designated parameter to a 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.
Parameters | |
---|---|
parameterName |
String!: the name of the parameter to be set |
value |
Reader!: the parameter value |
length |
Long: the number of characters in the parameter data. |
Exceptions | |
---|---|
java.sql.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 CallableStatement |
java.sql.SQLFeatureNotSupportedException |
if the JDBC driver does not support this method |
setNCharacterStream
abstract fun setNCharacterStream(
parameterName: String!,
value: Reader!
): Unit
Sets the designated parameter to a 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.
Parameters | |
---|---|
parameterName |
String!: the name of the parameter |
value |
Reader!: the parameter value |
Exceptions | |
---|---|
java.sql.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 CallableStatement |
java.sql.SQLFeatureNotSupportedException |
if the JDBC driver does not support this method |
setNClob
abstract fun setNClob(
parameterName: String!,
value: NClob!
): Unit
Sets the designated parameter to a java.sql.NClob
object. The object implements the java.sql.NClob
interface. This NClob
object maps to a SQL NCLOB
.
Parameters | |
---|---|
parameterName |
String!: the name of the parameter to be set |
value |
NClob!: the parameter value |
Exceptions | |
---|---|
java.sql.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 CallableStatement |
java.sql.SQLFeatureNotSupportedException |
if the JDBC driver does not support this method |
setNClob
abstract fun setNClob(
parameterName: String!,
reader: Reader!,
length: Long
): Unit
Sets the designated parameter to a 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 NCLOB
Parameters | |
---|---|
parameterName |
String!: the name of the parameter to be set |
reader |
Reader!: An object that contains the data to set the parameter value to. |
length |
Long: the number of characters in the parameter data. |
Exceptions | |
---|---|
java.sql.SQLException |
if parameterName does not correspond to a named parameter; if the length specified is less than zero; if the driver does not support national character sets; if the driver can detect that a data conversion error could occur; if a database access error occurs or this method is called on a closed CallableStatement |
java.sql.SQLFeatureNotSupportedException |
if the JDBC driver does not support this method |
setNClob
abstract fun setNClob(
parameterName: String!,
reader: Reader!
): Unit
Sets the designated parameter to a 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.
Parameters | |
---|---|
parameterName |
String!: the name of the parameter |
reader |
Reader!: An object that contains the data to set the parameter value to. |
Exceptions | |
---|---|
java.sql.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 CallableStatement |
java.sql.SQLFeatureNotSupportedException |
if the JDBC driver does not support this method |
setNString
abstract fun setNString(
parameterName: String!,
value: String!
): Unit
Sets the designated parameter to the given String
object. The driver converts this to a SQL NCHAR
oder NVARCHAR
oder LONGNVARCHAR
Parameters | |
---|---|
parameterName |
String!: the name of the parameter to be set |
value |
String!: the parameter value |
Exceptions | |
---|---|
java.sql.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 CallableStatement |
java.sql.SQLFeatureNotSupportedException |
if the JDBC driver does not support this method |
setNull
abstract fun setNull(
parameterName: String!,
sqlType: Int
): Unit
Sets the designated parameter to SQL NULL
.
Note: You must specify the parameter's SQL type.
Parameters | |
---|---|
parameterName |
String!: the name of the parameter |
sqlType |
Int: the SQL type code defined in java.sql.Types |
Exceptions | |
---|---|
java.sql.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 |
java.sql.SQLFeatureNotSupportedException |
if the JDBC driver does not support this method |
setNull
abstract fun setNull(
parameterName: String!,
sqlType: Int,
typeName: String!
): Unit
Sets the designated parameter to SQL 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.
Parameters | |
---|---|
parameterName |
String!: the name of the parameter |
sqlType |
Int: a value from java.sql.Types |
typeName |
String!: the fully-qualified name of an SQL user-defined type; ignored if the parameter is not a user-defined type or SQL REF value |
Exceptions | |
---|---|
java.sql.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 |
java.sql.SQLFeatureNotSupportedException |
if the JDBC driver does not support this method |
setObject
abstract fun setObject(
parameterName: String!,
x: Any!,
targetSqlType: Int,
scale: Int
): Unit
Sets the value of the designated parameter with the given object. The second argument must be an object type; for integral values, the java.lang
equivalent objects should be used.
The given Java object will be converted to the given targetSqlType before being sent to the database. If the object has a custom mapping (is of a class implementing the interface SQLData
), the JDBC driver should call the 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.
Parameters | |
---|---|
parameterName |
String!: the name of the parameter |
x |
Any!: the object containing the input parameter value |
targetSqlType |
Int: the SQL type (as defined in java.sql.Types) to be sent to the database. The scale argument may further qualify this type. |
scale |
Int: 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. |
Exceptions | |
---|---|
java.sql.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 |
java.sql.SQLFeatureNotSupportedException |
if targetSqlType is a ARRAY , BLOB , CLOB , DATALINK , JAVA_OBJECT , NCHAR , NCLOB , NVARCHAR , LONGNVARCHAR , REF , ROWID , SQLXML oder STRUCT data type and the JDBC driver does not support this data type |
See Also
setObject
abstract fun setObject(
parameterName: String!,
x: Any!,
targetSqlType: Int
): Unit
Sets the value of the designated parameter with the given object. This method is like the method setObject
above, except that it assumes a scale of zero.
Parameters | |
---|---|
parameterName |
String!: the name of the parameter |
x |
Any!: the object containing the input parameter value |
targetSqlType |
Int: the SQL type (as defined in java.sql.Types) to be sent to the database |
Exceptions | |
---|---|
java.sql.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 |
java.sql.SQLFeatureNotSupportedException |
if targetSqlType is a ARRAY , BLOB , CLOB , DATALINK , JAVA_OBJECT , NCHAR , NCLOB , NVARCHAR , LONGNVARCHAR , REF , ROWID , SQLXML oder STRUCT data type and the JDBC driver does not support this data type |
See Also
setObject
abstract fun setObject(
parameterName: String!,
x: Any!
): Unit
Sets the value of the designated parameter with the given object. The second parameter must be of type Object
; therefore, the java.lang
equivalent objects should be used for built-in types.
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)
.
Parameters | |
---|---|
parameterName |
String!: the name of the parameter |
x |
Any!: the object containing the input parameter value |
Exceptions | |
---|---|
java.sql.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 ambiguous |
java.sql.SQLFeatureNotSupportedException |
if the JDBC driver does not support this method |
See Also
setRowId
abstract fun setRowId(
parameterName: String!,
x: RowId!
): Unit
Sets the designated parameter to the given java.sql.RowId
object. The driver converts this to a SQL ROWID
when it sends it to the database.
Parameters | |
---|---|
parameterName |
String!: the name of the parameter |
x |
RowId!: the parameter value |
Exceptions | |
---|---|
java.sql.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 |
java.sql.SQLFeatureNotSupportedException |
if the JDBC driver does not support this method |
setSQLXML
abstract fun setSQLXML(
parameterName: String!,
xmlObject: SQLXML!
): Unit
Sets the designated parameter to the given java.sql.SQLXML
object. The driver converts this to an SQL XML
value when it sends it to the database.
Parameters | |
---|---|
parameterName |
String!: the name of the parameter |
xmlObject |
SQLXML!: a SQLXML object that maps an SQL XML value |
Exceptions | |
---|---|
java.sql.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 , Autor oder OutputStream has not been closed for the SQLXML object |
java.sql.SQLFeatureNotSupportedException |
if the JDBC driver does not support this method |
setShort
abstract fun setShort(
parameterName: String!,
x: Short
): Unit
Sets the designated parameter to the given Java short
value. The driver converts this to an SQL SMALLINT
value when it sends it to the database.
Parameters | |
---|---|
parameterName |
String!: the name of the parameter |
x |
Short: the parameter value |
Exceptions | |
---|---|
java.sql.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 |
java.sql.SQLFeatureNotSupportedException |
if the JDBC driver does not support this method |
See Also
setString
abstract fun setString(
parameterName: String!,
x: String!
): Unit
Sets the designated parameter to the given Java String
value. The driver converts this to an SQL VARCHAR
oder LONGVARCHAR
value (depending on the argument's size relative to the driver's limits on VARCHAR
values) when it sends it to the database.
Parameters | |
---|---|
parameterName |
String!: the name of the parameter |
x |
String!: the parameter value |
Exceptions | |
---|---|
java.sql.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 |
java.sql.SQLFeatureNotSupportedException |
if the JDBC driver does not support this method |
See Also
setTime
abstract fun setTime(
parameterName: String!,
x: Time!
): Unit
Sets the designated parameter to the given java.sql.Time
value. The driver converts this to an SQL TIME
value when it sends it to the database.
Parameters | |
---|---|
parameterName |
String!: the name of the parameter |
x |
Time!: the parameter value |
Exceptions | |
---|---|
java.sql.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 |
java.sql.SQLFeatureNotSupportedException |
if the JDBC driver does not support this method |
See Also
setTime
abstract fun setTime(
parameterName: String!,
x: Time!,
cal: Calendar!
): Unit
Sets the designated parameter to the given 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.
Parameters | |
---|---|
parameterName |
String!: the name of the parameter |
x |
Time!: the parameter value |
cal |
Calendar!: the Calendar object the driver will use to construct the time |
Exceptions | |
---|---|
java.sql.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 |
java.sql.SQLFeatureNotSupportedException |
if the JDBC driver does not support this method |
See Also
setTimestamp
abstract fun setTimestamp(
parameterName: String!,
x: Timestamp!
): Unit
Sets the designated parameter to the given java.sql.Timestamp
value. The driver converts this to an SQL TIMESTAMP
value when it sends it to the database.
Parameters | |
---|---|
parameterName |
String!: the name of the parameter |
x |
Timestamp!: the parameter value |
Exceptions | |
---|---|
java.sql.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 |
java.sql.SQLFeatureNotSupportedException |
if the JDBC driver does not support this method |
See Also
setTimestamp
abstract fun setTimestamp(
parameterName: String!,
x: Timestamp!,
cal: Calendar!
): Unit
Sets the designated parameter to the given 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.
Parameters | |
---|---|
parameterName |
String!: the name of the parameter |
x |
Timestamp!: the parameter value |
cal |
Calendar!: the Calendar object the driver will use to construct the timestamp |
Exceptions | |
---|---|
java.sql.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 |
java.sql.SQLFeatureNotSupportedException |
if the JDBC driver does not support this method |
See Also
setURL
abstract fun setURL(
parameterName: String!,
val: URL!
): Unit
Sets the designated parameter to the given java.net.URL
object. The driver converts this to an SQL DATALINK
value when it sends it to the database.
Parameters | |
---|---|
parameterName |
String!: the name of the parameter |
val |
URL!: the parameter value |
Exceptions | |
---|---|
java.sql.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 malformed |
java.sql.SQLFeatureNotSupportedException |
if the JDBC driver does not support this method |
See Also
wasNull
abstract fun wasNull(): Boolean
Retrieves whether the last OUT parameter read had the value of SQL 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.
Return | |
---|---|
Boolean |
true if the last parameter read was SQL NULL ; false otherwise |
Exceptions | |
---|---|
java.sql.SQLException |
if a database access error occurs or this method is called on a closed CallableStatement |