|
Java Platform 1.2 |
|||||||||
| 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 pre-compiled 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),
ResultSet| Method Summary | |
void |
addBatch()
JDBC 2.0 Adds a set of parameters to the batch. |
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()
JDBC 2.0 Gets the number, types and properties of a ResultSet's columns. |
void |
setArray(int i,
Array x)
JDBC 2.0 Sets an Array parameter. |
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.lang.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)
JDBC 2.0 Sets a BLOB parameter. |
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)
JDBC 2.0 Sets the designated parameter to the given Reader
object, which is the given number of characters long. |
void |
setClob(int i,
Clob x)
JDBC 2.0 Sets a CLOB parameter. |
void |
setDate(int parameterIndex,
Date x)
Sets the designated parameter to a java.sql.Date value. |
void |
setDate(int parameterIndex,
Date x,
Calendar cal)
JDBC 2.0 Sets the designated parameter to a 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)
JDBC 2.0 Sets the designated parameter to SQL NULL. |
void |
setObject(int parameterIndex,
Object x)
Sets the value of a parameter using an object; use the java.lang equivalent objects for integral values. |
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 a parameter using an object. |
void |
setRef(int i,
Ref x)
JDBC 2.0 Sets a REF(<structured-type>) parameter. |
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)
JDBC 2.0 Sets the designated parameter to a 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)
JDBC 2.0 Sets the designated parameter to a 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.
public int executeUpdate()
throws SQLException
PreparedStatement object.
In addition,
SQL statements that return nothing, such as SQL DDL statements,
can be executed.
public void setNull(int parameterIndex,
int sqlType)
throws SQLException
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
public void setBoolean(int parameterIndex,
boolean x)
throws SQLException
parameterIndex - the first parameter is 1, the second is 2, ...x - the parameter value
public void setByte(int parameterIndex,
byte x)
throws SQLException
parameterIndex - the first parameter is 1, the second is 2, ...x - the parameter value
public void setShort(int parameterIndex,
short x)
throws SQLException
parameterIndex - the first parameter is 1, the second is 2, ...x - the parameter value
public void setInt(int parameterIndex,
int x)
throws SQLException
parameterIndex - the first parameter is 1, the second is 2, ...x - the parameter value
public void setLong(int parameterIndex,
long x)
throws SQLException
parameterIndex - the first parameter is 1, the second is 2, ...x - the parameter value
public void setFloat(int parameterIndex,
float x)
throws SQLException
parameterIndex - the first parameter is 1, the second is 2, ...x - the parameter value
public void setDouble(int parameterIndex,
double x)
throws SQLException
parameterIndex - the first parameter is 1, the second is 2, ...x - the parameter value
public void setBigDecimal(int parameterIndex,
BigDecimal x)
throws SQLException
parameterIndex - the first parameter is 1, the second is 2, ...x - the parameter value
public void setString(int parameterIndex,
String x)
throws SQLException
parameterIndex - the first parameter is 1, the second is 2, ...x - the parameter value
public void setBytes(int parameterIndex,
byte[] x)
throws SQLException
parameterIndex - the first parameter is 1, the second is 2, ...x - the parameter value
public void setDate(int parameterIndex,
Date x)
throws SQLException
parameterIndex - the first parameter is 1, the second is 2, ...x - the parameter value
public void setTime(int parameterIndex,
Time x)
throws SQLException
parameterIndex - the first parameter is 1, the second is 2, ...x - the parameter value
public void setTimestamp(int parameterIndex,
Timestamp x)
throws SQLException
parameterIndex - the first parameter is 1, the second is 2, ...x - the parameter value
public void setAsciiStream(int parameterIndex,
InputStream x,
int length)
throws SQLException
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 stream
public void setUnicodeStream(int parameterIndex,
InputStream x,
int length)
throws SQLException
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 stream
public void setBinaryStream(int parameterIndex,
InputStream x,
int length)
throws SQLException
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 stream
public 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 clearParameters.
public void setObject(int parameterIndex,
Object x,
int targetSqlType,
int scale)
throws SQLException
Sets the value of a parameter using an 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 targetSqlType
before being sent to the database.
If the object has a custom mapping (is of a class implementing SQLData),
the JDBC driver should call its method 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.Types
public void setObject(int parameterIndex,
Object x,
int targetSqlType)
throws SQLException
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
public void setObject(int parameterIndex,
Object x)
throws SQLException
Sets the value of a parameter using an object; use the java.lang equivalent objects for integral values.
The JDBC specification specifies a standard mapping from Java Object types to SQL types. The given argument java object 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 SQLData,
the JDBC driver should call its method 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 those interfaces.
parameterIndex - the first parameter is 1, the second is 2, ...x - the object containing the input parameter value
public boolean execute()
throws SQLException
Statement.execute(java.lang.String)
public void addBatch()
throws SQLException
Statement.addBatch(java.lang.String)
public 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. JDBC will read the data from the stream
as needed, until it reaches end-of-file. 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 stream
public void setRef(int i,
Ref x)
throws SQLException
i - the first parameter is 1, the second is 2, ...x - an object representing data of an SQL REF Type
public void setBlob(int i,
Blob x)
throws SQLException
i - the first parameter is 1, the second is 2, ...x - an object representing a BLOB
public void setClob(int i,
Clob x)
throws SQLException
i - the first parameter is 1, the second is 2, ...x - an object representing a CLOB
public void setArray(int i,
Array x)
throws SQLException
i - the first parameter is 1, the second is 2, ...x - an object representing an SQL array
public ResultSetMetaData getMetaData()
throws SQLException
public void setDate(int parameterIndex,
Date x,
Calendar cal)
throws SQLException
Calendar object. The driver uses
the Calendar object to construct an SQL DATE,
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 and locale. If no
Calendar object is specified, the driver uses the default
timezone and locale.parameterIndex - the first parameter is 1, the second is 2, ...x - the parameter valuecal - the Calendar object the driver will use
to construct the date
public void setTime(int parameterIndex,
Time x,
Calendar cal)
throws SQLException
Calendar object. The driver uses
the Calendar object to construct an SQL TIME,
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 and locale. If no
Calendar object is specified, the driver uses the default
timezone and locale.parameterIndex - the first parameter is 1, the second is 2, ...x - the parameter valuecal - the Calendar object the driver will use
to construct the time
public void setTimestamp(int parameterIndex,
Timestamp x,
Calendar cal)
throws SQLException
Calendar object. The driver uses
the Calendar object to construct an SQL TIMESTAMP,
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 and locale. If no
Calendar object is specified, the driver uses the default
timezone and locale.parameterIndex - the first parameter is 1, the second is 2, ...x - the parameter valuecal - the Calendar object the driver will use
to construct the timestamp
public void setNull(int paramIndex,
int sqlType,
String typeName)
throws SQLException
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-named 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-named 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-named or REF type, the given typeName is ignored.
parameterIndex - the first parameter is 1, the second is 2, ...sqlType - a value from java.sql.TypestypeName - the fully-qualified name of an SQL user-named type,
ignored if the parameter is not a user-named type or REF
|
Java Platform 1.2 |
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||