PreparedStatement
interface PreparedStatement : Statement
java.sql.PreparedStatement |
An object that represents a precompiled SQL statement.
A SQL statement is precompiled and stored in a PreparedStatement
object. This object can then be used to efficiently execute this statement multiple times.
Note: The setter methods (setShort
, setString
, and so on) for setting IN parameter values must specify types that are compatible with the defined SQL type of the input parameter. For instance, if the IN parameter has SQL type INTEGER
, then the method setInt
should be used.
If arbitrary parameter type conversions are required, the method setObject
should be used with a target SQL type.
In the following example of setting a parameter, con
represents an active connection:
PreparedStatement pstmt = con.prepareStatement("UPDATE EMPLOYEES SET SALARY = ? WHERE ID = ?"); pstmt.setBigDecimal(1, 153833.00) pstmt.setInt(2, 110592)
Summary
Inherited constants | |
---|---|
Public methods | |
---|---|
abstract Unit |
addBatch() Adds a set of parameters to this |
abstract Unit |
Clears the current parameter values immediately. |
abstract Boolean |
execute() Executes the SQL statement in this |
abstract ResultSet! |
Executes the SQL query in this |
abstract Int |
Executes the SQL statement in this |
abstract ResultSetMetaData! |
Retrieves a |
abstract ParameterMetaData! |
Retrieves the number, types and properties of this |
abstract Unit |
Sets the designated parameter to the given |
abstract Unit |
setAsciiStream(parameterIndex: Int, x: InputStream!, length: Int) Sets the designated parameter to the given input stream, which will have the specified number of bytes. |
abstract Unit |
setAsciiStream(parameterIndex: Int, x: InputStream!, length: Long) Sets the designated parameter to the given input stream, which will have the specified number of bytes. |
abstract Unit |
setAsciiStream(parameterIndex: Int, x: InputStream!) Sets the designated parameter to the given input stream. |
abstract Unit |
setBigDecimal(parameterIndex: Int, x: BigDecimal!) Sets the designated parameter to the given |
abstract Unit |
setBinaryStream(parameterIndex: Int, x: InputStream!, length: Int) Sets the designated parameter to the given input stream, which will have the specified number of bytes. |
abstract Unit |
setBinaryStream(parameterIndex: Int, x: InputStream!, length: Long) Sets the designated parameter to the given input stream, which will have the specified number of bytes. |
abstract Unit |
setBinaryStream(parameterIndex: Int, x: InputStream!) Sets the designated parameter to the given input stream. |
abstract Unit |
Sets the designated parameter to the given |
abstract Unit |
setBlob(parameterIndex: Int, inputStream: InputStream!, length: Long) Sets the designated parameter to a |
abstract Unit |
setBlob(parameterIndex: Int, inputStream: InputStream!) Sets the designated parameter to a |
abstract Unit |
setBoolean(parameterIndex: Int, 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(parameterIndex: Int, reader: Reader!, length: Int) Sets the designated parameter to the given |
abstract Unit |
setCharacterStream(parameterIndex: Int, reader: Reader!, length: Long) Sets the designated parameter to the given |
abstract Unit |
setCharacterStream(parameterIndex: Int, reader: Reader!) Sets the designated parameter to the given |
abstract Unit |
Sets the designated parameter to the given |
abstract Unit |
Sets the designated parameter to a |
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(parameterIndex: Int, value: Reader!, length: Long) Sets the designated parameter to a |
abstract Unit |
setNCharacterStream(parameterIndex: Int, 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(parameterIndex: Int, value: String!) Sets the designated paramter 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 using 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 |
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(parameterIndex: Int, x: Timestamp!) Sets the designated parameter to the given |
abstract Unit |
setTimestamp(parameterIndex: Int, x: Timestamp!, cal: Calendar!) Sets the designated parameter to the given |
abstract Unit |
Sets the designated parameter to the given |
abstract Unit |
setUnicodeStream(parameterIndex: Int, x: InputStream!, length: Int) Sets the designated parameter to the given input stream, which will have the specified number of bytes. |
Inherited functions | |
---|---|
Public methods
addBatch
abstract fun addBatch(): Unit
Adds a set of parameters to this PreparedStatement
object's batch of commands.
Exceptions | |
---|---|
java.sql.SQLException |
if a database access error occurs or this method is called on a closed PreparedStatement |
See Also
clearParameters
abstract fun clearParameters(): Unit
Clears the current parameter values immediately.
In general, parameter values remain in force for repeated use of a statement. Setting a parameter value automatically clears its previous value. However, in some cases it is useful to immediately release the resources used by the current parameter values; this can be done by calling the method clearParameters
.
Exceptions | |
---|---|
java.sql.SQLException |
if a database access error occurs or this method is called on a closed PreparedStatement |
execute
abstract fun execute(): Boolean
Executes the SQL statement in this PreparedStatement
object, which may be any kind of SQL statement. Some prepared statements return multiple results; the execute
method handles these complex statements as well as the simpler form of statements handled by the methods executeQuery
and executeUpdate
.
The execute
method returns a boolean
to indicate the form of the first result. You must call either the method getResultSet
or getUpdateCount
to retrieve the result; you must call getMoreResults
to move to any subsequent result(s).
Return | |
---|---|
Boolean |
true if the first result is a ResultSet object; false if the first result is an update count or there is no result |
Exceptions | |
---|---|
java.sql.SQLTimeoutException |
when the driver has determined that the timeout value that was specified by the setQueryTimeout method has been exceeded and has at least attempted to cancel the currently running Statement |
java.sql.SQLException |
if a database access error occurs; this method is called on a closed PreparedStatement or an argument is supplied to this method |
executeQuery
abstract fun executeQuery(): ResultSet!
Executes the SQL query in this PreparedStatement
object and returns the ResultSet
object generated by the query.
Return | |
---|---|
ResultSet! |
a ResultSet object that contains the data produced by the query; never null |
Exceptions | |
---|---|
java.sql.SQLTimeoutException |
when the driver has determined that the timeout value that was specified by the setQueryTimeout method has been exceeded and has at least attempted to cancel the currently running Statement |
java.sql.SQLException |
if a database access error occurs; this method is called on a closed PreparedStatement or the SQL statement does not return a ResultSet object |
executeUpdate
abstract fun executeUpdate(): Int
Executes the SQL statement in this PreparedStatement
object, which must be an SQL Data Manipulation Language (DML) statement, such as INSERT
, UPDATE
or DELETE
; or an SQL statement that returns nothing, such as a DDL statement.
Return | |
---|---|
Int |
either (1) the row count for SQL Data Manipulation Language (DML) statements or (2) 0 for SQL statements that return nothing |
Exceptions | |
---|---|
java.sql.SQLTimeoutException |
when the driver has determined that the timeout value that was specified by the setQueryTimeout method has been exceeded and has at least attempted to cancel the currently running Statement |
java.sql.SQLException |
if a database access error occurs; this method is called on a closed PreparedStatement or the SQL statement returns a ResultSet object |
getMetaData
abstract fun getMetaData(): ResultSetMetaData!
Retrieves a ResultSetMetaData
object that contains information about the columns of the ResultSet
object that will be returned when this PreparedStatement
object is executed.
Because a PreparedStatement
object is precompiled, it is possible to know about the ResultSet
object that it will return without having to execute it. Consequently, it is possible to invoke the method getMetaData
on a PreparedStatement
object rather than waiting to execute it and then invoking the ResultSet.getMetaData
method on the ResultSet
object that is returned.
NOTE: Using this method may be expensive for some drivers due to the lack of underlying DBMS support.
Return | |
---|---|
ResultSetMetaData! |
the description of a ResultSet object's columns or null if the driver cannot return a ResultSetMetaData object |
Exceptions | |
---|---|
java.sql.SQLException |
if a database access error occurs or this method is called on a closed PreparedStatement |
java.sql.SQLFeatureNotSupportedException |
if the JDBC driver does not support this method |
getParameterMetaData
abstract fun getParameterMetaData(): ParameterMetaData!
Retrieves the number, types and properties of this PreparedStatement
object's parameters.
Return | |
---|---|
ParameterMetaData! |
a ParameterMetaData object that contains information about the number, types and properties for each parameter marker of this PreparedStatement object |
Exceptions | |
---|---|
java.sql.SQLException |
if a database access error occurs or this method is called on a closed PreparedStatement |
See Also
setArray
abstract fun setArray(
parameterIndex: Int,
x: Array!
): Unit
Sets the designated parameter to the given java.sql.Array
object. The driver converts this to an SQL ARRAY
value when it sends it to the database.
Parameters | |
---|---|
parameterIndex |
Int: the first parameter is 1, the second is 2, ... |
x |
Array!: an Array object that maps an SQL ARRAY value |
Exceptions | |
---|---|
java.sql.SQLFeatureNotSupportedException |
if the JDBC driver does not support this method |
java.sql.SQLException |
if parameterIndex does not correspond to a parameter marker in the SQL statement; if a database access error occurs or this method is called on a closed PreparedStatement |
setAsciiStream
abstract fun setAsciiStream(
parameterIndex: Int,
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 | |
---|---|
parameterIndex |
Int: the first parameter is 1, the second is 2, ... |
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 parameterIndex does not correspond to a parameter marker in the SQL statement; if a database access error occurs or this method is called on a closed PreparedStatement |
setAsciiStream
abstract fun setAsciiStream(
parameterIndex: Int,
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 | |
---|---|
parameterIndex |
Int: the first parameter is 1, the second is 2, ... |
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 parameterIndex does not correspond to a parameter marker in the SQL statement; if a database access error occurs or this method is called on a closed PreparedStatement |
setAsciiStream
abstract fun setAsciiStream(
parameterIndex: Int,
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 | |
---|---|
parameterIndex |
Int: the first parameter is 1, the second is 2, ... |
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 parameterIndex does not correspond to a parameter marker in the SQL statement; if a database access error occurs or this method is called on a closed PreparedStatement |
setBigDecimal
abstract fun setBigDecimal(
parameterIndex: Int,
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 | |
---|---|
parameterIndex |
Int: the first parameter is 1, the second is 2, ... |
x |
BigDecimal!: the parameter value |
Exceptions | |
---|---|
java.sql.SQLException |
if parameterIndex does not correspond to a parameter marker in the SQL statement; if a database access error occurs or this method is called on a closed PreparedStatement |
setBinaryStream
abstract fun setBinaryStream(
parameterIndex: Int,
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 | |
---|---|
parameterIndex |
Int: the first parameter is 1, the second is 2, ... |
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 parameterIndex does not correspond to a parameter marker in the SQL statement; if a database access error occurs or this method is called on a closed PreparedStatement |
setBinaryStream
abstract fun setBinaryStream(
parameterIndex: Int,
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 | |
---|---|
parameterIndex |
Int: the first parameter is 1, the second is 2, ... |
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 parameterIndex does not correspond to a parameter marker in the SQL statement; if a database access error occurs or this method is called on a closed PreparedStatement |
setBinaryStream
abstract fun setBinaryStream(
parameterIndex: Int,
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 | |
---|---|
parameterIndex |
Int: the first parameter is 1, the second is 2, ... |
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 parameterIndex does not correspond to a parameter marker in the SQL statement; if a database access error occurs or this method is called on a closed PreparedStatement |
setBlob
abstract fun setBlob(
parameterIndex: Int,
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 | |
---|---|
parameterIndex |
Int: the first parameter is 1, the second is 2, ... |
x |
Blob!: a Blob object that maps an SQL BLOB value |
Exceptions | |
---|---|
java.sql.SQLFeatureNotSupportedException |
if the JDBC driver does not support this method |
java.sql.SQLException |
if parameterIndex does not correspond to a parameter marker in the SQL statement; if a database access error occurs or this method is called on a closed PreparedStatement |
setBlob
abstract fun setBlob(
parameterIndex: Int,
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 PreparedStatement
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 | |
---|---|
parameterIndex |
Int: index of the first parameter is 1, 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 parameterIndex does not correspond to a parameter marker in the SQL statement; if a database access error occurs; this method is called on a closed PreparedStatement ; if the length specified is less than zero or if the number of bytes in the inputstream does not match the specfied length. |
java.sql.SQLFeatureNotSupportedException |
if the JDBC driver does not support this method |
setBlob
abstract fun setBlob(
parameterIndex: Int,
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 sent 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 | |
---|---|
parameterIndex |
Int: index of the first parameter is 1, the second is 2, ... |
inputStream |
InputStream!: An object that contains the data to set the parameter value to. |
Exceptions | |
---|---|
java.sql.SQLException |
if parameterIndex does not correspond to a parameter marker in the SQL statement; if a database access error occurs; this method is called on a closed PreparedStatement or if parameterIndex does not correspond to a parameter marker in the SQL statement, |
java.sql.SQLFeatureNotSupportedException |
if the JDBC driver does not support this method |
setBoolean
abstract fun setBoolean(
parameterIndex: Int,
x: Boolean
): Unit
Sets the designated parameter to the given Java boolean
value. The driver converts this to an SQL BIT
or BOOLEAN
value when it sends it to the database.
Parameters | |
---|---|
parameterIndex |
Int: the first parameter is 1, the second is 2, ... |
x |
Boolean: the parameter value |
Exceptions | |
---|---|
java.sql.SQLException |
if parameterIndex does not correspond to a parameter marker in the SQL statement; if a database access error occurs or this method is called on a closed PreparedStatement |
setByte
abstract fun setByte(
parameterIndex: Int,
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 | |
---|---|
parameterIndex |
Int: the first parameter is 1, the second is 2, ... |
x |
Byte: the parameter value |
Exceptions | |
---|---|
java.sql.SQLException |
if parameterIndex does not correspond to a parameter marker in the SQL statement; if a database access error occurs or this method is called on a closed PreparedStatement |
setBytes
abstract fun setBytes(
parameterIndex: Int,
x: ByteArray!
): Unit
Sets the designated parameter to the given Java array of bytes. The driver converts this to an SQL VARBINARY
or LONGVARBINARY
(depending on the argument's size relative to the driver's limits on VARBINARY
values) when it sends it to the database.
Parameters | |
---|---|
parameterIndex |
Int: the first parameter is 1, the second is 2, ... |
x |
ByteArray!: the parameter value |
Exceptions | |
---|---|
java.sql.SQLException |
if parameterIndex does not correspond to a parameter marker in the SQL statement; if a database access error occurs or this method is called on a closed PreparedStatement |
setCharacterStream
abstract fun setCharacterStream(
parameterIndex: Int,
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 | |
---|---|
parameterIndex |
Int: the first parameter is 1, the second is 2, ... |
reader |
Reader!: the java.io.Reader object that contains the Unicode data |
length |
Int: the number of characters in the stream |
Exceptions | |
---|---|
java.sql.SQLException |
if parameterIndex does not correspond to a parameter marker in the SQL statement; if a database access error occurs or this method is called on a closed PreparedStatement |
setCharacterStream
abstract fun setCharacterStream(
parameterIndex: Int,
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 | |
---|---|
parameterIndex |
Int: the first parameter is 1, the second is 2, ... |
reader |
Reader!: the java.io.Reader object that contains the Unicode data |
length |
Long: the number of characters in the stream |
Exceptions | |
---|---|
java.sql.SQLException |
if parameterIndex does not correspond to a parameter marker in the SQL statement; if a database access error occurs or this method is called on a closed PreparedStatement |
setCharacterStream
abstract fun setCharacterStream(
parameterIndex: Int,
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 | |
---|---|
parameterIndex |
Int: the first parameter is 1, the second is 2, ... |
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 parameterIndex does not correspond to a parameter marker in the SQL statement; if a database access error occurs or this method is called on a closed PreparedStatement |
setClob
abstract fun setClob(
parameterIndex: Int,
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 | |
---|---|
parameterIndex |
Int: the first parameter is 1, the second is 2, ... |
x |
Clob!: a Clob object that maps an SQL CLOB value |
Exceptions | |
---|---|
java.sql.SQLFeatureNotSupportedException |
if the JDBC driver does not support this method |
java.sql.SQLException |
if parameterIndex does not correspond to a parameter marker in the SQL statement; if a database access error occurs or this method is called on a closed PreparedStatement |
setClob
abstract fun setClob(
parameterIndex: Int,
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 PreparedStatement
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 sent to the server as a LONGVARCHAR
or a CLOB
Parameters | |
---|---|
parameterIndex |
Int: index of the first parameter is 1, the second is 2, ... |
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 parameterIndex does not correspond to a parameter marker in the SQL statement; if a database access error occurs; this method is called on a closed PreparedStatement or if the length specified is less than zero. |
java.sql.SQLFeatureNotSupportedException |
if the JDBC driver does not support this method |
setClob
abstract fun setClob(
parameterIndex: Int,
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 sent 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 | |
---|---|
parameterIndex |
Int: index of the first parameter is 1, the second is 2, ... |
reader |
Reader!: An object that contains the data to set the parameter value to. |
Exceptions | |
---|---|
java.sql.SQLException |
if parameterIndex does not correspond to a parameter marker in the SQL statement; if a database access error occurs; this method is called on a closed PreparedStatement or if parameterIndex does not correspond to a parameter marker in the SQL statement |
java.sql.SQLFeatureNotSupportedException |
if the JDBC driver does not support this method |
setDate
abstract fun setDate(
parameterIndex: Int,
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 | |
---|---|
parameterIndex |
Int: the first parameter is 1, the second is 2, ... |
x |
Date!: the parameter value |
Exceptions | |
---|---|
java.sql.SQLException |
if parameterIndex does not correspond to a parameter marker in the SQL statement; if a database access error occurs or this method is called on a closed PreparedStatement |
setDate
abstract fun setDate(
parameterIndex: Int,
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 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 | |
---|---|
parameterIndex |
Int: the first parameter is 1, the second is 2, ... |
x |
Date!: the parameter value |
cal |
Calendar!: the Calendar object the driver will use to construct the date |
Exceptions | |
---|---|
java.sql.SQLException |
if parameterIndex does not correspond to a parameter marker in the SQL statement; if a database access error occurs or this method is called on a closed PreparedStatement |
setDouble
abstract fun setDouble(
parameterIndex: Int,
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 | |
---|---|
parameterIndex |
Int: the first parameter is 1, the second is 2, ... |
x |
Double: the parameter value |
Exceptions | |
---|---|
java.sql.SQLException |
if parameterIndex does not correspond to a parameter marker in the SQL statement; if a database access error occurs or this method is called on a closed PreparedStatement |
setFloat
abstract fun setFloat(
parameterIndex: Int,
x: Float
): Unit
Sets the designated parameter to the given Java float
value. The driver converts this to an SQL REAL
value when it sends it to the database.
Parameters | |
---|---|
parameterIndex |
Int: the first parameter is 1, the second is 2, ... |
x |
Float: the parameter value |
Exceptions | |
---|---|
java.sql.SQLException |
if parameterIndex does not correspond to a parameter marker in the SQL statement; if a database access error occurs or this method is called on a closed PreparedStatement |
setInt
abstract fun setInt(
parameterIndex: Int,
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 | |
---|---|
parameterIndex |
Int: the first parameter is 1, the second is 2, ... |
x |
Int: the parameter value |
Exceptions | |
---|---|
java.sql.SQLException |
if parameterIndex does not correspond to a parameter marker in the SQL statement; if a database access error occurs or this method is called on a closed PreparedStatement |
setLong
abstract fun setLong(
parameterIndex: Int,
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 | |
---|---|
parameterIndex |
Int: the first parameter is 1, the second is 2, ... |
x |
Long: the parameter value |
Exceptions | |
---|---|
java.sql.SQLException |
if parameterIndex does not correspond to a parameter marker in the SQL statement; if a database access error occurs or this method is called on a closed PreparedStatement |
setNCharacterStream
abstract fun setNCharacterStream(
parameterIndex: Int,
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 | |
---|---|
parameterIndex |
Int: of the first parameter is 1, the second is 2, ... |
value |
Reader!: the parameter value |
length |
Long: the number of characters in the parameter data. |
Exceptions | |
---|---|
java.sql.SQLException |
if parameterIndex does not correspond to a parameter marker in the SQL statement; 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 PreparedStatement |
java.sql.SQLFeatureNotSupportedException |
if the JDBC driver does not support this method |
setNCharacterStream
abstract fun setNCharacterStream(
parameterIndex: Int,
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 | |
---|---|
parameterIndex |
Int: of the first parameter is 1, the second is 2, ... |
value |
Reader!: the parameter value |
Exceptions | |
---|---|
java.sql.SQLException |
if parameterIndex does not correspond to a parameter marker in the SQL statement; 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 PreparedStatement |
java.sql.SQLFeatureNotSupportedException |
if the JDBC driver does not support this method |
setNClob
abstract fun setNClob(
parameterIndex: Int,
value: NClob!
): Unit
Sets the designated parameter to a java.sql.NClob
object. The driver converts this to a SQL NCLOB
value when it sends it to the database.
Parameters | |
---|---|
parameterIndex |
Int: of the first parameter is 1, the second is 2, ... |
value |
NClob!: the parameter value |
Exceptions | |
---|---|
java.sql.SQLException |
if parameterIndex does not correspond to a parameter marker in the SQL statement; 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 PreparedStatement |
java.sql.SQLFeatureNotSupportedException |
if the JDBC driver does not support this method |
setNClob
abstract fun setNClob(
parameterIndex: Int,
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 PreparedStatement
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 sent to the server as a LONGNVARCHAR
or a NCLOB
Parameters | |
---|---|
parameterIndex |
Int: index of the first parameter is 1, the second is 2, ... |
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 parameterIndex does not correspond to a parameter marker in the SQL statement; 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 PreparedStatement |
java.sql.SQLFeatureNotSupportedException |
if the JDBC driver does not support this method |
setNClob
abstract fun setNClob(
parameterIndex: Int,
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 sent 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 | |
---|---|
parameterIndex |
Int: index of the first parameter is 1, the second is 2, ... |
reader |
Reader!: An object that contains the data to set the parameter value to. |
Exceptions | |
---|---|
java.sql.SQLException |
if parameterIndex does not correspond to a parameter marker in the SQL statement; 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 PreparedStatement |
java.sql.SQLFeatureNotSupportedException |
if the JDBC driver does not support this method |
setNString
abstract fun setNString(
parameterIndex: Int,
value: String!
): Unit
Sets the designated paramter to the given String
object. The driver converts this to a SQL NCHAR
or NVARCHAR
or LONGNVARCHAR
value (depending on the argument's size relative to the driver's limits on NVARCHAR
values) when it sends it to the database.
Parameters | |
---|---|
parameterIndex |
Int: of the first parameter is 1, the second is 2, ... |
value |
String!: the parameter value |
Exceptions | |
---|---|
java.sql.SQLException |
if parameterIndex does not correspond to a parameter marker in the SQL statement; 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 PreparedStatement |
java.sql.SQLFeatureNotSupportedException |
if the JDBC driver does not support this method |
setNull
abstract fun setNull(
parameterIndex: Int,
sqlType: Int
): Unit
Sets the designated parameter to SQL NULL
.
Note: You must specify the parameter's SQL type.
Parameters | |
---|---|
parameterIndex |
Int: the first parameter is 1, the second is 2, ... |
sqlType |
Int: the SQL type code defined in java.sql.Types |
Exceptions | |
---|---|
java.sql.SQLException |
if parameterIndex does not correspond to a parameter marker in the SQL statement; if a database access error occurs or this method is called on a closed PreparedStatement |
java.sql.SQLFeatureNotSupportedException |
if sqlType is a ARRAY , BLOB , CLOB , DATALINK , JAVA_OBJECT , NCHAR , NCLOB , NVARCHAR , LONGNVARCHAR , REF , ROWID , SQLXML or STRUCT data type and the JDBC driver does not support this data type |
setNull
abstract fun setNull(
parameterIndex: Int,
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. If a JDBC driver does not need the type code or type name information, it may ignore it. Although it is intended for user-defined and Ref parameters, this method may be used to set a null parameter of any JDBC type. If the parameter does not have a user-defined or REF type, the given typeName is ignored.
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 user-defined type; ignored if the parameter is not a user-defined type or REF |
Exceptions | |
---|---|
java.sql.SQLException |
if parameterIndex does not correspond to a parameter marker in the SQL statement; if a database access error occurs or this method is called on a closed PreparedStatement |
java.sql.SQLFeatureNotSupportedException |
if sqlType is a ARRAY , BLOB , CLOB , DATALINK , JAVA_OBJECT , NCHAR , NCLOB , NVARCHAR , LONGNVARCHAR , REF , ROWID , SQLXML or STRUCT data type and the JDBC driver does not support this data type or if the JDBC driver does not support this method |
setObject
abstract fun setObject(
parameterIndex: Int,
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 | |
---|---|
parameterIndex |
Int: the first parameter is 1, the second is 2, ... |
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 parameterIndex does not correspond to a parameter marker in the SQL statement; if a database access error occurs or this method is called on a closed PreparedStatement |
java.sql.SQLFeatureNotSupportedException |
if targetSqlType is a ARRAY , BLOB , CLOB , DATALINK , JAVA_OBJECT , NCHAR , NCLOB , NVARCHAR , LONGNVARCHAR , REF , ROWID , SQLXML or STRUCT data type and the JDBC driver does not support this data type |
See Also
setObject
abstract fun setObject(
parameterIndex: Int,
x: Any!
): Unit
Sets the value of the designated parameter using 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
, RowId
, SQLXML
or Array
, the driver should pass it to the database as a value of the corresponding SQL type.
Note: Not all databases allow for a non-typed Null to be sent to the backend. For maximum portability, the setNull
or the setObject(int parameterIndex, Object x, int sqlType)
method should be used instead of setObject(int parameterIndex, Object x)
.
Note: 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.
Parameters | |
---|---|
parameterIndex |
Int: the first parameter is 1, the second is 2, ... |
x |
Any!: the object containing the input parameter value |
Exceptions | |
---|---|
java.sql.SQLException |
if parameterIndex does not correspond to a parameter marker in the SQL statement; if a database access error occurs; this method is called on a closed PreparedStatement or the type of the given object is ambiguous |
setObject
abstract fun setObject(
parameterIndex: Int,
x: Any!,
targetSqlType: Int,
scaleOrLength: 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. If the second argument is an InputStream
then the stream must contain the number of bytes specified by scaleOrLength. If the second argument is a Reader
then the reader must contain the number of characters specified by scaleOrLength. If these conditions are not true the driver will generate a SQLException
when the prepared statement is executed.
The given Java object will be converted to the given targetSqlType before being sent to the database. If the object has a custom mapping (is of a class implementing the interface SQLData
), the JDBC driver should call the method SQLData.writeSQL
to write it to the SQL data stream. If, on the other hand, the object is of a class implementing Ref
, Blob
, Clob
, NClob
, Struct
, java.net.URL
, or Array
, the driver should pass it to the database as a value of the corresponding SQL type.
Note that this method may be used to pass database-specific abstract data types.
Parameters | |
---|---|
parameterIndex |
Int: the first parameter is 1, the second is 2, ... |
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. |
scaleOrLength |
Int: for java.sql.Types.DECIMAL or java.sql.Types.NUMERIC types , this is the number of digits after the decimal point. For Java Object types InputStream and Reader , this is the length of the data in the stream or reader. For all other types, this value will be ignored. |
Exceptions | |
---|---|
java.sql.SQLException |
if parameterIndex does not correspond to a parameter marker in the SQL statement; if a database access error occurs; this method is called on a closed PreparedStatement or if the Java Object specified by x is an InputStream or Reader object and the value of the scale parameter is less than zero |
java.sql.SQLFeatureNotSupportedException |
if targetSqlType is a ARRAY , BLOB , CLOB , DATALINK , JAVA_OBJECT , NCHAR , NCLOB , NVARCHAR , LONGNVARCHAR , REF , ROWID , SQLXML or STRUCT data type and the JDBC driver does not support this data type |
See Also
setRef
abstract fun setRef(
parameterIndex: Int,
x: Ref!
): Unit
Sets the designated parameter to the given REF(<structured-type>)
value. The driver converts this to an SQL REF
value when it sends it to the database.
Parameters | |
---|---|
parameterIndex |
Int: the first parameter is 1, the second is 2, ... |
x |
Ref!: an SQL REF value |
Exceptions | |
---|---|
java.sql.SQLFeatureNotSupportedException |
if the JDBC driver does not support this method |
java.sql.SQLException |
if parameterIndex does not correspond to a parameter marker in the SQL statement; if a database access error occurs or this method is called on a closed PreparedStatement |
setRowId
abstract fun setRowId(
parameterIndex: Int,
x: RowId!
): Unit
Sets the designated parameter to the given java.sql.RowId
object. The driver converts this to a SQL ROWID
value when it sends it to the database
Parameters | |
---|---|
parameterIndex |
Int: the first parameter is 1, the second is 2, ... |
x |
RowId!: the parameter value |
Exceptions | |
---|---|
java.sql.SQLException |
if parameterIndex does not correspond to a parameter marker in the SQL statement; if a database access error occurs or this method is called on a closed PreparedStatement |
java.sql.SQLFeatureNotSupportedException |
if the JDBC driver does not support this method |
setSQLXML
abstract fun setSQLXML(
parameterIndex: Int,
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 | |
---|---|
parameterIndex |
Int: index of the first parameter is 1, the second is 2, ... |
xmlObject |
SQLXML!: a SQLXML object that maps an SQL XML value |
Exceptions | |
---|---|
java.sql.SQLException |
if parameterIndex does not correspond to a parameter marker in the SQL statement; if a database access error occurs; this method is called on a closed PreparedStatement or the java.xml.transform.Result , Writer or 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(
parameterIndex: Int,
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 | |
---|---|
parameterIndex |
Int: the first parameter is 1, the second is 2, ... |
x |
Short: the parameter value |
Exceptions | |
---|---|
java.sql.SQLException |
if parameterIndex does not correspond to a parameter marker in the SQL statement; if a database access error occurs or this method is called on a closed PreparedStatement |
setString
abstract fun setString(
parameterIndex: Int,
x: String!
): Unit
Sets the designated parameter to the given Java String
value. The driver converts this to an SQL VARCHAR
or LONGVARCHAR
value (depending on the argument's size relative to the driver's limits on VARCHAR
values) when it sends it to the database.
Parameters | |
---|---|
parameterIndex |
Int: the first parameter is 1, the second is 2, ... |
x |
String!: the parameter value |
Exceptions | |
---|---|
java.sql.SQLException |
if parameterIndex does not correspond to a parameter marker in the SQL statement; if a database access error occurs or this method is called on a closed PreparedStatement |
setTime
abstract fun setTime(
parameterIndex: Int,
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 | |
---|---|
parameterIndex |
Int: the first parameter is 1, the second is 2, ... |
x |
Time!: the parameter value |
Exceptions | |
---|---|
java.sql.SQLException |
if parameterIndex does not correspond to a parameter marker in the SQL statement; if a database access error occurs or this method is called on a closed PreparedStatement |
setTime
abstract fun setTime(
parameterIndex: Int,
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 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 | |
---|---|
parameterIndex |
Int: the first parameter is 1, the second is 2, ... |
x |
Time!: the parameter value |
cal |
Calendar!: the Calendar object the driver will use to construct the time |
Exceptions | |
---|---|
java.sql.SQLException |
if parameterIndex does not correspond to a parameter marker in the SQL statement; if a database access error occurs or this method is called on a closed PreparedStatement |
setTimestamp
abstract fun setTimestamp(
parameterIndex: Int,
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 | |
---|---|
parameterIndex |
Int: the first parameter is 1, the second is 2, ... |
x |
Timestamp!: the parameter value |
Exceptions | |
---|---|
java.sql.SQLException |
if parameterIndex does not correspond to a parameter marker in the SQL statement; if a database access error occurs or this method is called on a closed PreparedStatement |
setTimestamp
abstract fun setTimestamp(
parameterIndex: Int,
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 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 | |
---|---|
parameterIndex |
Int: the first parameter is 1, the second is 2, ... |
x |
Timestamp!: the parameter value |
cal |
Calendar!: the Calendar object the driver will use to construct the timestamp |
Exceptions | |
---|---|
java.sql.SQLException |
if parameterIndex does not correspond to a parameter marker in the SQL statement; if a database access error occurs or this method is called on a closed PreparedStatement |
setURL
abstract fun setURL(
parameterIndex: Int,
x: URL!
): Unit
Sets the designated parameter to the given java.net.URL
value. The driver converts this to an SQL DATALINK
value when it sends it to the database.
Parameters | |
---|---|
parameterIndex |
Int: the first parameter is 1, the second is 2, ... |
x |
URL!: the java.net.URL object to be set |
Exceptions | |
---|---|
java.sql.SQLFeatureNotSupportedException |
if the JDBC driver does not support this method |
java.sql.SQLException |
if parameterIndex does not correspond to a parameter marker in the SQL statement; if a database access error occurs or this method is called on a closed PreparedStatement |
setUnicodeStream
abstract funsetUnicodeStream(
parameterIndex: Int,
x: InputStream!,
length: Int
): Unit
Deprecated: Use setCharacterStream
Sets the designated parameter to the given input stream, which will have the specified number of bytes. When a very large Unicode value is input to a LONGVARCHAR
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. The JDBC driver will do any necessary conversion from Unicode to the database char format. The byte format of the Unicode stream must be a Java UTF-8, as defined in the Java Virtual Machine Specification.
Note: This stream object can either be a standard Java stream object or your own subclass that implements the standard interface.
Parameters | |
---|---|
parameterIndex |
Int: the first parameter is 1, the second is 2, ... |
x |
InputStream!: a java.io.InputStream object that contains the Unicode parameter value |
length |
Int: the number of bytes in the stream |
Exceptions | |
---|---|
java.sql.SQLException |
if parameterIndex does not correspond to a parameter marker in the SQL statement; if a database access error occurs or this method is called on a closed PreparedStatement |
java.sql.SQLFeatureNotSupportedException |
if the JDBC driver does not support this method |