PreparedStatement
Java SE 6
| public interface java.sql PreparedStatement
|
Java SE 6 |
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)
| See also | prepareStatement, java.sql.ResultSet |
| Methods | |||||||
|---|---|---|---|---|---|---|---|
| public void | addBatch() throws SQLException Adds a set of parameters to this PreparedStatement
object's batch of commands.
| ||||||
| public void | clearParameters() throws SQLException 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
| ||||||
| public boolean | execute() throws SQLException 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
| ||||||
| public ResultSet | executeQuery() throws SQLException Executes the SQL query in this PreparedStatement object
and returns the ResultSet object generated by the query.
| ||||||
| public int | executeUpdate() throws SQLException 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.
| ||||||
| Properties | |||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| public void | setArray(int parameterIndex, Array x) throws SQLException 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.
| ||||||||||||||||
| public void | setAsciiStream(int parameterIndex, InputStream x, int length) throws SQLException 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.
| ||||||||||||||||
| public void | setAsciiStream(int parameterIndex, InputStream x, long length) throws SQLException 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.
| ||||||||||||||||
| public void | setAsciiStream(int parameterIndex, InputStream x) throws SQLException 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
| ||||||||||||||||
| public void | setBigDecimal(int parameterIndex, BigDecimal x) throws SQLException 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.
| ||||||||||||||||
| public void | setBinaryStream(int parameterIndex, InputStream x, int length) throws SQLException 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.
| ||||||||||||||||
| public void | setBinaryStream(int parameterIndex, InputStream x, long length) throws SQLException 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.
| ||||||||||||||||
| public void | setBinaryStream(int parameterIndex, InputStream x) throws SQLException 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
| ||||||||||||||||
| public void | setBlob(int parameterIndex, Blob x) throws SQLException 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.
| ||||||||||||||||
| public void | setBlob(int parameterIndex, InputStream inputStream, long length) throws SQLException 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
| ||||||||||||||||
| public void | setBlob(int parameterIndex, InputStream inputStream) throws SQLException 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
| ||||||||||||||||
| public void | setBoolean(int parameterIndex, boolean x) throws SQLException 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.
| ||||||||||||||||
| public void | setByte(int parameterIndex, byte x) throws SQLException 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.
| ||||||||||||||||
| public void | setBytes(int parameterIndex, byte[] x) throws SQLException 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.
| ||||||||||||||||
| public void | setCharacterStream(int parameterIndex, Reader reader, int length) throws SQLException 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.
| ||||||||||||||||
| public void | setCharacterStream(int parameterIndex, Reader reader, long length) throws SQLException 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.
| ||||||||||||||||
| public void | setCharacterStream(int parameterIndex, Reader reader) throws SQLException 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
| ||||||||||||||||
| public void | setClob(int parameterIndex, Clob x) throws SQLException 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.
| ||||||||||||||||
| public void | setClob(int parameterIndex, Reader reader, long length) throws SQLException 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
| ||||||||||||||||
| public void | setClob(int parameterIndex, Reader reader) throws SQLException 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
| ||||||||||||||||
| public void | setDate(int parameterIndex, Date x) throws SQLException 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.
| ||||||||||||||||
| public void | setDate(int parameterIndex, Date x, Calendar cal) throws SQLException 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.
| ||||||||||||||||
| public void | setDouble(int parameterIndex, double x) throws SQLException 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.
| ||||||||||||||||
| public void | setFloat(int parameterIndex, float x) throws SQLException 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.
| ||||||||||||||||
| public void | setInt(int parameterIndex, int x) throws SQLException 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.
| ||||||||||||||||
| public void | setLong(int parameterIndex, long x) throws SQLException 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.
| ||||||||||||||||
| public ResultSetMetaData | getMetaData() throws SQLException 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 NOTE: Using this method may be expensive for some drivers due to the lack of underlying DBMS support.
| ||||||||||||||||
| public void | setNCharacterStream(int parameterIndex, Reader value, long length) throws SQLException 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.
| ||||||||||||||||
| public void | setNCharacterStream(int parameterIndex, Reader value) throws SQLException 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
| ||||||||||||||||
| public void | setNClob(int parameterIndex, NClob value) throws SQLException 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.
| ||||||||||||||||
| public void | setNClob(int parameterIndex, Reader reader, long length) throws SQLException 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
| ||||||||||||||||
| public void | setNClob(int parameterIndex, Reader reader) throws SQLException 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
| ||||||||||||||||
| public void | setNString(int parameterIndex, String value) throws SQLException 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.
| ||||||||||||||||
| public void | setNull(int parameterIndex, int sqlType) throws SQLException Sets the designated parameter to SQL NULL.
Note: You must specify the parameter's SQL type.
| ||||||||||||||||
| public void | setNull(int parameterIndex, int sqlType, String typeName) throws SQLException 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.
| ||||||||||||||||
| public void | setObject(int parameterIndex, Object x, int targetSqlType) throws SQLException 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.
| ||||||||||||||||
| public void | setObject(int parameterIndex, Object x) throws SQLException Sets the value of the designated parameter using the given object.
The second parameter must be of type The JDBC specification specifies a standard mapping from
Java 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
Note: Not all databases allow for a non-typed Null to be sent to
the backend. For maximum portability, the 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.
| ||||||||||||||||
| public void | setObject(int parameterIndex, Object x, int targetSqlType, int scaleOrLength) throws SQLException Sets the value of the designated parameter with the given object. The second
argument must be an object type; for integral values, the
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 Note that this method may be used to pass database-specific abstract data types.
| ||||||||||||||||
| public ParameterMetaData | getParameterMetaData() throws SQLException Retrieves the number, types and properties of this PreparedStatement object's parameters.
| ||||||||||||||||
| public void | setRef(int parameterIndex, Ref x) throws SQLException 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.
| ||||||||||||||||
| public void | setRowId(int parameterIndex, RowId x) throws SQLException 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
| ||||||||||||||||
| public void | setShort(int parameterIndex, short x) throws SQLException 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.
| ||||||||||||||||
| public void | setSQLXML(int parameterIndex, SQLXML xmlObject) throws SQLException 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.
| ||||||||||||||||
| public void | setString(int parameterIndex, String x) throws SQLException 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.
| ||||||||||||||||
| public void | setTime(int parameterIndex, Time x) throws SQLException 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.
| ||||||||||||||||
| public void | setTime(int parameterIndex, Time x, Calendar cal) throws SQLException 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.
| ||||||||||||||||
| public void | setTimestamp(int parameterIndex, Timestamp x) throws SQLException 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.
| ||||||||||||||||
| public void | setTimestamp(int parameterIndex, Timestamp x, Calendar cal) throws SQLException 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.
| ||||||||||||||||
| public void | setUnicodeStream(int parameterIndex, InputStream x, int length) throws SQLException 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.
| ||||||||||||||||
| public void | setURL(int parameterIndex, URL x) throws SQLException 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.
| ||||||||||||||||
| About DocWeb · Bundles · Export · Export All | Top 10 · Statistics · Login |
| About Sun · Contact · Privacy · Terms of Use · Trademarks | Java SE 6 · Copyright © 1994-2009 Sun Microsystems, Inc.All rights reserved. Use is subject to license terms |
 |
 |
|