|
JavaTM 2 Platform Std. Ed. v1.3 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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 setXXX methods 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.
Example of setting a parameter; con
is an active connection
PreparedStatement pstmt = con.prepareStatement("UPDATE EMPLOYEES
SET SALARY = ? WHERE ID = ?");
pstmt.setBigDecimal(1, 153833.00)
pstmt.setInt(2, 110592)
Connection.prepareStatement(java.lang.String)
,
Some of the methods in this interface are new in the JDBC 2.0 API.
Method Summary | |
void |
addBatch()
Adds a set of parameters to this PreparedStatement
object's batch of commands. |
void |
clearParameters()
Clears the current parameter values immediately. |
boolean |
execute()
Executes any kind of SQL statement. |
ResultSet |
executeQuery()
Executes the SQL query in this PreparedStatement object
and returns the result set generated by the query. |
int |
executeUpdate()
Executes the SQL INSERT, UPDATE or DELETE statement in this PreparedStatement object. |
ResultSetMetaData |
getMetaData()
Gets the number, types and properties of a ResultSet
object's columns. |
void |
setArray(int i,
Array x)
Sets the designated parameter to the given Array object. |
void |
setAsciiStream(int parameterIndex,
InputStream x,
int length)
Sets the designated parameter to the given input stream, which will have the specified number of bytes. |
void |
setBigDecimal(int parameterIndex,
BigDecimal x)
Sets the designated parameter to a java.math.BigDecimal value. |
void |
setBinaryStream(int parameterIndex,
InputStream x,
int length)
Sets the designated parameter to the given input stream, which will have the specified number of bytes. |
void |
setBlob(int i,
Blob x)
Sets the designated parameter to the given Blob object. |
void |
setBoolean(int parameterIndex,
boolean x)
Sets the designated parameter to a Java boolean value. |
void |
setByte(int parameterIndex,
byte x)
Sets the designated parameter to a Java byte value. |
void |
setBytes(int parameterIndex,
byte[] x)
Sets the designated parameter to a Java array of bytes. |
void |
setCharacterStream(int parameterIndex,
Reader reader,
int length)
Sets the designated parameter to the given Reader
object, which is the given number of characters long. |
void |
setClob(int i,
Clob x)
Sets the designated parameter to the given Clob object. |
void |
setDate(int parameterIndex,
Date x)
Sets the designated parameter to a value. |
void |
setDate(int parameterIndex,
Date x,
Calendar cal)
Sets the designated parameter to the given java.sql.Date value,
using the given Calendar object. |
void |
setDouble(int parameterIndex,
double x)
Sets the designated parameter to a Java double value. |
void |
setFloat(int parameterIndex,
float x)
Sets the designated parameter to a Java float value. |
void |
setInt(int parameterIndex,
int x)
Sets the designated parameter to a Java int value. |
void |
setLong(int parameterIndex,
long x)
Sets the designated parameter to a Java long value. |
void |
setNull(int parameterIndex,
int sqlType)
Sets the designated parameter to SQL NULL . |
void |
setNull(int paramIndex,
int sqlType,
String typeName)
Sets the designated parameter to SQL NULL . |
void |
setObject(int parameterIndex,
Object x)
Sets the value of the designated parameter using the given object. |
void |
setObject(int parameterIndex,
Object x,
int targetSqlType)
Sets the value of the designated parameter with the given object. |
void |
setObject(int parameterIndex,
Object x,
int targetSqlType,
int scale)
Sets the value of the designated parameter with the given object. |
void |
setRef(int i,
Ref x)
Sets the designated parameter to the given REF(<structured-type>) value. |
void |
setShort(int parameterIndex,
short x)
Sets the designated parameter to a Java short value. |
void |
setString(int parameterIndex,
String x)
Sets the designated parameter to a Java String value. |
void |
setTime(int parameterIndex,
Time x)
Sets the designated parameter to a java.sql.Time value. |
void |
setTime(int parameterIndex,
Time x,
Calendar cal)
Sets the designated parameter to the given java.sql.Time value,
using the given Calendar object. |
void |
setTimestamp(int parameterIndex,
Timestamp x)
Sets the designated parameter to a java.sql.Timestamp value. |
void |
setTimestamp(int parameterIndex,
Timestamp x,
Calendar cal)
Sets the designated parameter to the given java.sql.Timestamp value,
using the given Calendar object. |
void |
setUnicodeStream(int parameterIndex,
InputStream x,
int length)
Deprecated. |
Methods inherited from interface java.sql.Statement |
addBatch, cancel, clearBatch, clearWarnings, close, execute, executeBatch, executeQuery, executeUpdate, getConnection, getFetchDirection, getFetchSize, getMaxFieldSize, getMaxRows, getMoreResults, getQueryTimeout, getResultSet, getResultSetConcurrency, getResultSetType, getUpdateCount, getWarnings, setCursorName, setEscapeProcessing, setFetchDirection, setFetchSize, setMaxFieldSize, setMaxRows, setQueryTimeout |
Method Detail |
public ResultSet executeQuery() throws SQLException
PreparedStatement
object
and returns the result set generated by the query.ResultSet
object that contains the data produced by the
query; never null
SQLException
- if a database access error occurspublic int executeUpdate() throws SQLException
PreparedStatement
object.
In addition,
SQL statements that return nothing, such as SQL DDL statements,
can be executed.SQLException
- if a database access error occurspublic void setNull(int parameterIndex, int sqlType) throws SQLException
NULL
.
Note: You must specify the parameter's SQL type.
parameterIndex
- the first parameter is 1, the second is 2, ...sqlType
- the SQL type code defined in java.sql.Types
SQLException
- if a database access error occurspublic void setBoolean(int parameterIndex, boolean x) throws SQLException
boolean
value.
The driver converts this
to an SQL BIT
value when it sends it to the database.parameterIndex
- the first parameter is 1, the second is 2, ...x
- the parameter valueSQLException
- if a database access error occurspublic void setByte(int parameterIndex, byte x) throws SQLException
byte
value.
The driver converts this
to an SQL TINYINT
value when it sends it to the database.parameterIndex
- the first parameter is 1, the second is 2, ...x
- the parameter valueSQLException
- if a database access error occurspublic void setShort(int parameterIndex, short x) throws SQLException
short
value.
The driver converts this
to an SQL SMALLINT
value when it sends it to the database.parameterIndex
- the first parameter is 1, the second is 2, ...x
- the parameter valueSQLException
- if a database access error occurspublic void setInt(int parameterIndex, int x) throws SQLException
int
value.
The driver converts this
to an SQL INTEGER
value when it sends it to the database.parameterIndex
- the first parameter is 1, the second is 2, ...x
- the parameter valueSQLException
- if a database access error occurspublic void setLong(int parameterIndex, long x) throws SQLException
long
value.
The driver converts this
to an SQL BIGINT
value when it sends it to the database.parameterIndex
- the first parameter is 1, the second is 2, ...x
- the parameter valueSQLException
- if a database access error occurspublic void setFloat(int parameterIndex, float x) throws SQLException
float
value.
The driver converts this
to an SQL FLOAT
value when it sends it to the database.parameterIndex
- the first parameter is 1, the second is 2, ...x
- the parameter valueSQLException
- if a database access error occurspublic void setDouble(int parameterIndex, double x) throws SQLException
double
value.
The driver converts this
to an SQL DOUBLE
value when it sends it to the database.parameterIndex
- the first parameter is 1, the second is 2, ...x
- the parameter valueSQLException
- if a database access error occurspublic void setBigDecimal(int parameterIndex, BigDecimal x) throws SQLException
java.math.BigDecimal
value.
The driver converts this to an SQL NUMERIC
value when
it sends it to the database.parameterIndex
- the first parameter is 1, the second is 2, ...x
- the parameter valueSQLException
- if a database access error occurspublic void setString(int parameterIndex, String x) throws SQLException
String
value.
The driver converts this
to an SQL VARCHAR
or LONGVARCHAR
value
(depending on the argument's
size relative to the driver's limits on VARCHAR
values)
when it sends it to the database.parameterIndex
- the first parameter is 1, the second is 2, ...x
- the parameter valueSQLException
- if a database access error occurspublic void setBytes(int parameterIndex, byte[] x) throws SQLException
VARBINARY
or LONGVARBINARY
(depending on the argument's size relative to the driver's limits on
VARBINARY
values) when it sends it to the database.parameterIndex
- the first parameter is 1, the second is 2, ...x
- the parameter valueSQLException
- if a database access error occurspublic void setDate(int parameterIndex, Date x) throws SQLException
value.
The driver converts this
to an SQL DATE
value when it sends it to the database.
- Parameters:
parameterIndex
- the first parameter is 1, the second is 2, ...x
- the parameter value- Throws:
SQLException
- if a database access error occurs
public void setTime(int parameterIndex, Time x) throws SQLException
java.sql.Time
value.
The driver converts this
to an SQL TIME
value when it sends it to the database.parameterIndex
- the first parameter is 1, the second is 2, ...x
- the parameter valueSQLException
- if a database access error occurspublic void setTimestamp(int parameterIndex, Timestamp x) throws SQLException
java.sql.Timestamp
value.
The driver
converts this to an SQL TIMESTAMP
value when it sends it to the
database.parameterIndex
- the first parameter is 1, the second is 2, ...x
- the parameter valueSQLException
- if a database access error occurspublic void setAsciiStream(int parameterIndex, InputStream x, int length) throws SQLException
LONGVARCHAR
parameter, it may be more practical to send it via a
java.io.InputStream
. Data will be read from the stream
as needed until end-of-file is reached. The JDBC driver will
do any necessary conversion from ASCII to the database char format.
Note: This stream object can either be a standard Java stream object or your own subclass that implements the standard interface.
parameterIndex
- the first parameter is 1, the second is 2, ...x
- the Java input stream that contains the ASCII parameter valuelength
- the number of bytes in the streamSQLException
- if a database access error occurspublic void setUnicodeStream(int parameterIndex, InputStream x, int length) throws SQLException
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 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.
parameterIndex
- the first parameter is 1, the second is 2, ...x
- the java input stream which contains the
UNICODE parameter valuelength
- the number of bytes in the streamSQLException
- if a database access error occurspublic void setBinaryStream(int parameterIndex, InputStream x, int length) throws SQLException
LONGVARBINARY
parameter, it may be more practical to send it via a
java.io.InputStream
object. The data will be read from the stream
as needed until end-of-file is reached.
Note: This stream object can either be a standard Java stream object or your own subclass that implements the standard interface.
parameterIndex
- the first parameter is 1, the second is 2, ...x
- the java input stream which contains the binary parameter valuelength
- the number of bytes in the streamSQLException
- if a database access error occurspublic void clearParameters() throws SQLException
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
.
SQLException
- if a database access error occurspublic void setObject(int parameterIndex, Object x, int targetSqlType, int scale) 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
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, Struct,
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.
parameterIndex
- the first parameter is 1, the second is 2, ...x
- the object containing the input parameter valuetargetSqlType
- the SQL type (as defined in java.sql.Types) to be
sent to the database. The scale argument may further qualify this type.scale
- for java.sql.Types.DECIMAL or java.sql.Types.NUMERIC types,
this is the number of digits after the decimal point. For all other
types, this value will be ignored.SQLException
- if a database access error occursTypes
public void setObject(int parameterIndex, Object x, int targetSqlType) throws SQLException
setObject
above, except that it assumes a scale of zero.parameterIndex
- the first parameter is 1, the second is 2, ...x
- the object containing the input parameter valuetargetSqlType
- the SQL type (as defined in java.sql.Types) to be
sent to the databaseSQLException
- if a database access error occurspublic 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 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, Struct,
or Array, then 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.
parameterIndex
- the first parameter is 1, the second is 2, ...x
- the object containing the input parameter valueSQLException
- if a database access error occurspublic boolean execute() throws SQLException
execute
method handles these complex statements as well as the simpler
form of statements handled by the methods executeQuery
and executeUpdate
.SQLException
- if a database access error occursStatement.execute(java.lang.String)
public void addBatch() throws SQLException
PreparedStatement
object's batch of commands.SQLException
- if a database access error occursStatement.addBatch(java.lang.String)
,
What Is in the JDBC
2.0 APIpublic void setCharacterStream(int parameterIndex, Reader reader, int length) throws SQLException
Reader
object, which is the given number of characters long.
When a very large UNICODE value is input to a LONGVARCHAR
parameter, it may be more practical to send it via a
java.io.Reader
object. The data will be read from the stream
as needed until end-of-file is reached. The JDBC driver will
do any necessary conversion from UNICODE to the database char format.
Note: This stream object can either be a standard Java stream object or your own subclass that implements the standard interface.
parameterIndex
- the first parameter is 1, the second is 2, ...x
- the java reader which contains the UNICODE datalength
- the number of characters in the streamSQLException
- if a database access error occurspublic void setRef(int i, Ref x) throws SQLException
REF(<structured-type>)
value.i
- the first parameter is 1, the second is 2, ...x
- an SQL REF
valueSQLException
- if a database access error occurspublic void setBlob(int i, Blob x) throws SQLException
Blob
object.i
- the first parameter is 1, the second is 2, ...x
- a Blob
object that maps an SQL BLOB
valueSQLException
- if a database access error occurspublic void setClob(int i, Clob x) throws SQLException
Clob
object.i
- the first parameter is 1, the second is 2, ...x
- a Clob
object that maps an SQL CLOB
valueSQLException
- if a database access error occurspublic void setArray(int i, Array x) throws SQLException
Array
object.
Sets an Array parameter.i
- the first parameter is 1, the second is 2, ...x
- an Array
object that maps an SQL ARRAY
valueSQLException
- if a database access error occurspublic ResultSetMetaData getMetaData() throws SQLException
ResultSet
object's columns.ResultSet
object's columnsSQLException
- if a database access error occurspublic void setDate(int parameterIndex, Date x, Calendar cal) throws SQLException
java.sql.Date
value,
using the given Calendar
object. The driver uses
the Calendar
object to construct an SQL DATE
value,
which the driver then sends to the database. With a
a Calendar
object, the driver can calculate the date
taking into account a custom timezone. If no
Calendar
object is specified, the driver uses the default
timezone, which is that of the virtual machine running the application.parameterIndex
- the first parameter is 1, the second is 2, ...x
- the parameter valuecal
- the Calendar
object the driver will use
to construct the dateSQLException
- if a database access error occurspublic void setTime(int parameterIndex, Time x, Calendar cal) throws SQLException
java.sql.Time
value,
using the given Calendar
object. The driver uses
the Calendar
object to construct an SQL TIME
value,
which the driver then sends to the database. With a
a Calendar
object, the driver can calculate the time
taking into account a custom timezone. If no
Calendar
object is specified, the driver uses the default
timezone, which is that of the virtual machine running the application.parameterIndex
- the first parameter is 1, the second is 2, ...x
- the parameter valuecal
- the Calendar
object the driver will use
to construct the timeSQLException
- if a database access error occurspublic void setTimestamp(int parameterIndex, Timestamp x, Calendar cal) throws SQLException
java.sql.Timestamp
value,
using the given Calendar
object. The driver uses
the Calendar
object to construct an SQL TIMESTAMP
value,
which the driver then sends to the database. With a
a Calendar
object, the driver can calculate the timestamp
taking into account a custom timezone. If no
Calendar
object is specified, the driver uses the default
timezone, which is that of the virtual machine running the application.parameterIndex
- the first parameter is 1, the second is 2, ...x
- the parameter valuecal
- the Calendar
object the driver will use
to construct the timestampSQLException
- if a database access error occurspublic void setNull(int paramIndex, int sqlType, String typeName) throws SQLException
NULL
.
This version of the method setNull
should
be used for user-defined types and REF type parameters. Examples
of user-defined types include: STRUCT, DISTINCT, JAVA_OBJECT, and
named array types.
Note: To be portable, applications must give the SQL type code and the fully-qualified SQL type name when specifying a NULL user-defined or REF parameter. In the case of a user-defined type the name is the type name of the parameter itself. For a REF parameter, the name is the type name of the referenced type. 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.
parameterIndex
- the first parameter is 1, the second is 2, ...sqlType
- a value from java.sql.Types
typeName
- the fully-qualified name of an SQL user-defined type;
ignored if the parameter is not a user-defined type or REFSQLException
- if a database access error occurs
|
JavaTM 2 Platform Std. Ed. v1.3 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Java, Java 2D, and JDBC are trademarks or registered trademarks of Sun Microsystems, Inc. in the US and other countries.
Copyright 1993-2000 Sun Microsystems, Inc. 901 San Antonio Road
Palo Alto, California, 94303, U.S.A. All Rights Reserved.