File	Doc	Category	Size	Date	Package
PreparedStatement.java	API Doc	Java SE 5 API	29074	Fri Aug 26 14:57:20 BST 2005	java.sql

PreparedStatement

PreparedStatement pstmt = con.prepareStatement("UPDATE EMPLOYEES
SET SALARY = ? WHERE ID = ?");
pstmt.setBigDecimal(1, 153833.00)
pstmt.setInt(2, 110592)

Fields Summary

Constructors Summary

Methods Summary
public void	addBatch() Adds a set of parameters to this PreparedStatement object's batch of commands. exception SQLException if a database access error occurs see Statement#addBatch since 1.2
public void	clearParameters() 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. exception SQLException if a database access error occurs
public boolean	execute() 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 true if the first result is a ResultSet object; false if the first result is an update count or there is no result exception SQLException if a database access error occurs or an argument is supplied to this method see Statement#execute see Statement#getResultSet see Statement#getUpdateCount see Statement#getMoreResults
public java.sql.ResultSet	executeQuery() Executes the SQL query in this PreparedStatement object and returns the ResultSet object generated by the query. return a ResultSet object that contains the data produced by the query; never null exception SQLException if a database access error occurs or the SQL statement does not return a ResultSet object
public int	executeUpdate() Executes the SQL statement in this PreparedStatement object, which must be an SQL INSERT, UPDATE or DELETE statement; or an SQL statement that returns nothing, such as a DDL statement. return either (1) the row count for INSERT, UPDATE, or DELETE statements or (2) 0 for SQL statements that return nothing exception SQLException if a database access error occurs or the SQL statement returns a ResultSet object
public java.sql.ResultSetMetaData	getMetaData() 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 the description of a ResultSet object's columns or null if the driver cannot return a ResultSetMetaData object exception SQLException if a database access error occurs since 1.2
public java.sql.ParameterMetaData	getParameterMetaData() Retrieves the number, types and properties of this PreparedStatement object's parameters. return a ParameterMetaData object that contains information about the number, types and properties of this PreparedStatement object's parameters exception SQLException if a database access error occurs see ParameterMetaData since 1.4
public void	setArray(int i, java.sql.Array x) Sets the designated parameter to the given Array object. The driver converts this to an SQL ARRAY value when it sends it to the database. param i the first parameter is 1, the second is 2, ... param x an Array object that maps an SQL ARRAY value exception SQLException if a database access error occurs since 1.2
public void	setAsciiStream(int parameterIndex, java.io.InputStream x, int length) 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. param parameterIndex the first parameter is 1, the second is 2, ... param x the Java input stream that contains the ASCII parameter value param length the number of bytes in the stream exception SQLException if a database access error occurs
public void	setBigDecimal(int parameterIndex, java.math.BigDecimal x) 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. param parameterIndex the first parameter is 1, the second is 2, ... param x the parameter value exception SQLException if a database access error occurs
public void	setBinaryStream(int parameterIndex, java.io.InputStream x, int length) 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. param parameterIndex the first parameter is 1, the second is 2, ... param x the java input stream which contains the binary parameter value param length the number of bytes in the stream exception SQLException if a database access error occurs
public void	setBlob(int i, java.sql.Blob x) Sets the designated parameter to the given Blob object. The driver converts this to an SQL BLOB value when it sends it to the database. param i the first parameter is 1, the second is 2, ... param x a Blob object that maps an SQL BLOB value exception SQLException if a database access error occurs since 1.2
public void	setBoolean(int parameterIndex, boolean x) Sets the designated parameter to the given Java boolean value. The driver converts this to an SQL BIT value when it sends it to the database. param parameterIndex the first parameter is 1, the second is 2, ... param x the parameter value exception SQLException if a database access error occurs
public void	setByte(int parameterIndex, byte x) 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. param parameterIndex the first parameter is 1, the second is 2, ... param x the parameter value exception SQLException if a database access error occurs
public void	setBytes(int parameterIndex, byte[] x) 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. param parameterIndex the first parameter is 1, the second is 2, ... param x the parameter value exception SQLException if a database access error occurs
public void	setCharacterStream(int parameterIndex, java.io.Reader reader, int length) 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. param parameterIndex the first parameter is 1, the second is 2, ... param reader the java.io.Reader object that contains the Unicode data param length the number of characters in the stream exception SQLException if a database access error occurs since 1.2
public void	setClob(int i, java.sql.Clob x) Sets the designated parameter to the given Clob object. The driver converts this to an SQL CLOB value when it sends it to the database. param i the first parameter is 1, the second is 2, ... param x a Clob object that maps an SQL CLOB value exception SQLException if a database access error occurs since 1.2
public void	setDate(int parameterIndex, java.sql.Date x) Sets the designated parameter to the given java.sql.Date value. The driver converts this to an SQL DATE value when it sends it to the database. param parameterIndex the first parameter is 1, the second is 2, ... param x the parameter value exception SQLException if a database access error occurs
public void	setDate(int parameterIndex, java.sql.Date x, java.util.Calendar cal) 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. param parameterIndex the first parameter is 1, the second is 2, ... param x the parameter value param cal the Calendar object the driver will use to construct the date exception SQLException if a database access error occurs since 1.2
public void	setDouble(int parameterIndex, double x) 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. param parameterIndex the first parameter is 1, the second is 2, ... param x the parameter value exception SQLException if a database access error occurs
public void	setFloat(int parameterIndex, float x) Sets the designated parameter to the given Java float value. The driver converts this to an SQL FLOAT value when it sends it to the database. param parameterIndex the first parameter is 1, the second is 2, ... param x the parameter value exception SQLException if a database access error occurs
public void	setInt(int parameterIndex, int x) 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. param parameterIndex the first parameter is 1, the second is 2, ... param x the parameter value exception SQLException if a database access error occurs
public void	setLong(int parameterIndex, long x) 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. param parameterIndex the first parameter is 1, the second is 2, ... param x the parameter value exception SQLException if a database access error occurs
public void	setNull(int parameterIndex, int sqlType) Sets the designated parameter to SQL NULL. Note: You must specify the parameter's SQL type. param parameterIndex the first parameter is 1, the second is 2, ... param sqlType the SQL type code defined in java.sql.Types exception SQLException if a database access error occurs
public void	setNull(int paramIndex, int sqlType, java.lang.String typeName) 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. param paramIndex the first parameter is 1, the second is 2, ... param sqlType a value from java.sql.Types param typeName the fully-qualified name of an SQL user-defined type; ignored if the parameter is not a user-defined type or REF exception SQLException if a database access error occurs since 1.2
public void	setObject(int parameterIndex, java.lang.Object x, int targetSqlType, int scale) 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 database-specific abstract data types. param parameterIndex the first parameter is 1, the second is 2, ... param x the object containing the input parameter value param targetSqlType the SQL type (as defined in java.sql.Types) to be sent to the database. The scale argument may further qualify this type. param 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. exception SQLException if a database access error occurs see Types
public void	setObject(int parameterIndex, java.lang.Object x, int targetSqlType) 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. param parameterIndex the first parameter is 1, the second is 2, ... param x the object containing the input parameter value param targetSqlType the SQL type (as defined in java.sql.Types) to be sent to the database exception SQLException if a database access error occurs
public void	setObject(int parameterIndex, java.lang.Object x) 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, 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. param parameterIndex the first parameter is 1, the second is 2, ... param x the object containing the input parameter value exception SQLException if a database access error occurs or the type of the given object is ambiguous
public void	setRef(int i, java.sql.Ref x) 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. param i the first parameter is 1, the second is 2, ... param x an SQL REF value exception SQLException if a database access error occurs since 1.2
public void	setShort(int parameterIndex, short x) 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. param parameterIndex the first parameter is 1, the second is 2, ... param x the parameter value exception SQLException if a database access error occurs
public void	setString(int parameterIndex, java.lang.String x) 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. param parameterIndex the first parameter is 1, the second is 2, ... param x the parameter value exception SQLException if a database access error occurs
public void	setTime(int parameterIndex, java.sql.Time x) 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. param parameterIndex the first parameter is 1, the second is 2, ... param x the parameter value exception SQLException if a database access error occurs
public void	setTime(int parameterIndex, java.sql.Time x, java.util.Calendar cal) 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. param parameterIndex the first parameter is 1, the second is 2, ... param x the parameter value param cal the Calendar object the driver will use to construct the time exception SQLException if a database access error occurs since 1.2
public void	setTimestamp(int parameterIndex, java.sql.Timestamp x) 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. param parameterIndex the first parameter is 1, the second is 2, ... param x the parameter value exception SQLException if a database access error occurs
public void	setTimestamp(int parameterIndex, java.sql.Timestamp x, java.util.Calendar cal) 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. param parameterIndex the first parameter is 1, the second is 2, ... param x the parameter value param cal the Calendar object the driver will use to construct the timestamp exception SQLException if a database access error occurs since 1.2
public void	setURL(int parameterIndex, java.net.URL x) 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. param parameterIndex the first parameter is 1, the second is 2, ... param x the java.net.URL object to be set exception SQLException if a database access error occurs since 1.4
public void	setUnicodeStream(int parameterIndex, java.io.InputStream x, int length) Sets the designated parameter to the given input stream, which will have the specified number of bytes. A Unicode character has two bytes, with the first byte being the high byte, and the second being the low byte. 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. Note: This stream object can either be a standard Java stream object or your own subclass that implements the standard interface. param parameterIndex the first parameter is 1, the second is 2, ... param x a java.io.InputStream object that contains the Unicode parameter value as two-byte Unicode characters param length the number of bytes in the stream exception SQLException if a database access error occurs deprecated