PreparedStatement

public interface PreparedStatement implements Statement

Known Indirect Subclasses CallableStatement CallableStatement The interface used to execute SQL stored procedures.

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)
 

See Also

• Connection.prepareStatement(String)
• ResultSet

Inherited Constant Summary

From interface java.sql.Statement

int	CLOSE_ALL_RESULTS	The constant indicating that all ResultSet objects that have previously been kept open should be closed when calling getMoreResults.
int	CLOSE_CURRENT_RESULT	The constant indicating that the current ResultSet object should be closed when calling getMoreResults.
int	EXECUTE_FAILED	The constant indicating that an error occured while executing a batch statement.
int	KEEP_CURRENT_RESULT	The constant indicating that the current ResultSet object should not be closed when calling getMoreResults.
int	NO_GENERATED_KEYS	The constant indicating that generated keys should not be made available for retrieval.
int	RETURN_GENERATED_KEYS	The constant indicating that generated keys should be made available for retrieval.
int	SUCCESS_NO_INFO	The constant indicating that a batch statement executed successfully but that no count of the number of rows it affected is available.

Public Method Summary

abstract void	addBatch() Adds a set of parameters to this PreparedStatement object's batch of commands.
abstract void	clearParameters() Clears the current parameter values immediately.
abstract boolean	execute() Executes the SQL statement in this PreparedStatement object, which may be any kind of SQL statement.
abstract ResultSet	executeQuery() Executes the SQL query in this PreparedStatement object and returns the ResultSet object generated by the query.
abstract int	executeUpdate() 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.
abstract 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.
abstract ParameterMetaData	getParameterMetaData() Retrieves the number, types and properties of this PreparedStatement object's parameters.
abstract void	setArray(int parameterIndex, Array x) Sets the designated parameter to the given java.sql.Array object.
abstract void	setAsciiStream(int parameterIndex, InputStream x, long length) Sets the designated parameter to the given input stream, which will have the specified number of bytes.
abstract void	setAsciiStream(int parameterIndex, InputStream x) Sets the designated parameter to the given input stream.
abstract 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.
abstract void	setBigDecimal(int parameterIndex, BigDecimal x) Sets the designated parameter to the given java.math.BigDecimal value.
abstract void	setBinaryStream(int parameterIndex, InputStream x, long length) Sets the designated parameter to the given input stream, which will have the specified number of bytes.
abstract void	setBinaryStream(int parameterIndex, InputStream x) Sets the designated parameter to the given input stream.
abstract 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.
abstract void	setBlob(int parameterIndex, InputStream inputStream, long length) Sets the designated parameter to a InputStream object.
abstract void	setBlob(int parameterIndex, InputStream inputStream) Sets the designated parameter to a InputStream object.
abstract void	setBlob(int parameterIndex, Blob x) Sets the designated parameter to the given java.sql.Blob object.
abstract void	setBoolean(int parameterIndex, boolean x) Sets the designated parameter to the given Java boolean value.
abstract void	setByte(int parameterIndex, byte x) Sets the designated parameter to the given Java byte value.
abstract void	setBytes(int parameterIndex, byte[] x) Sets the designated parameter to the given Java array of bytes.
abstract void	setCharacterStream(int parameterIndex, Reader reader, long length) Sets the designated parameter to the given Reader object, which is the given number of characters long.
abstract 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.
abstract void	setCharacterStream(int parameterIndex, Reader reader) Sets the designated parameter to the given Reader object.
abstract void	setClob(int parameterIndex, Clob x) Sets the designated parameter to the given java.sql.Clob object.
abstract void	setClob(int parameterIndex, Reader reader, long length) Sets the designated parameter to a Reader object.
abstract void	setClob(int parameterIndex, Reader reader) Sets the designated parameter to a Reader object.
abstract void	setDate(int parameterIndex, Date x) 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.
abstract void	setDate(int parameterIndex, Date x, Calendar cal) Sets the designated parameter to the given java.sql.Date value, using the given Calendar object.
abstract void	setDouble(int parameterIndex, double x) Sets the designated parameter to the given Java double value.
abstract void	setFloat(int parameterIndex, float x) Sets the designated parameter to the given Java float value.
abstract void	setInt(int parameterIndex, int x) Sets the designated parameter to the given Java int value.
abstract void	setLong(int parameterIndex, long x) Sets the designated parameter to the given Java long value.
abstract void	setNCharacterStream(int parameterIndex, Reader value, long length) Sets the designated parameter to a Reader object.
abstract void	setNCharacterStream(int parameterIndex, Reader value) Sets the designated parameter to a Reader object.
abstract void	setNClob(int parameterIndex, Reader reader, long length) Sets the designated parameter to a Reader object.
abstract void	setNClob(int parameterIndex, NClob value) Sets the designated parameter to a java.sql.NClob object.
abstract void	setNClob(int parameterIndex, Reader reader) Sets the designated parameter to a Reader object.
abstract void	setNString(int parameterIndex, String value) Sets the designated paramter to the given String object.
abstract void	setNull(int parameterIndex, int sqlType, String typeName) Sets the designated parameter to SQL NULL.
abstract void	setNull(int parameterIndex, int sqlType) Sets the designated parameter to SQL NULL.
abstract void	setObject(int parameterIndex, Object x, int targetSqlType) Sets the value of the designated parameter with the given object.
abstract void	setObject(int parameterIndex, Object x, int targetSqlType, int scaleOrLength) Sets the value of the designated parameter with the given object.
abstract void	setObject(int parameterIndex, Object x) Sets the value of the designated parameter using the given object.
abstract void	setRef(int parameterIndex, Ref x) Sets the designated parameter to the given REF(<structured-type>) value.
abstract void	setRowId(int parameterIndex, RowId x) Sets the designated parameter to the given java.sql.RowId object.
abstract void	setSQLXML(int parameterIndex, SQLXML xmlObject) Sets the designated parameter to the given java.sql.SQLXML object.
abstract void	setShort(int parameterIndex, short x) Sets the designated parameter to the given Java short value.
abstract void	setString(int parameterIndex, String x) Sets the designated parameter to the given Java String value.
abstract void	setTime(int parameterIndex, Time x, Calendar cal) Sets the designated parameter to the given java.sql.Time value, using the given Calendar object.
abstract void	setTime(int parameterIndex, Time x) Sets the designated parameter to the given java.sql.Time value.
abstract void	setTimestamp(int parameterIndex, Timestamp x) Sets the designated parameter to the given java.sql.Timestamp value.
abstract void	setTimestamp(int parameterIndex, Timestamp x, Calendar cal) Sets the designated parameter to the given java.sql.Timestamp value, using the given Calendar object.
abstract void	setURL(int parameterIndex, URL x) Sets the designated parameter to the given java.net.URL value.
abstract void	setUnicodeStream(int parameterIndex, InputStream x, int length) This method is deprecated. Use setCharacterStream

Inherited Method Summary

From interface java.sql.Statement

abstract void	addBatch(String sql) Adds the given SQL command to the current list of commmands for this Statement object.
abstract void	cancel() Cancels this Statement object if both the DBMS and driver support aborting an SQL statement.
abstract void	clearBatch() Empties this Statement object's current list of SQL commands.
abstract void	clearWarnings() Clears all the warnings reported on this Statement object.
abstract void	close() Releases this Statement object's database and JDBC resources immediately instead of waiting for this to happen when it is automatically closed.
abstract boolean	execute(String sql, int autoGeneratedKeys) Executes the given SQL statement, which may return multiple results, and signals the driver that any auto-generated keys should be made available for retrieval.
abstract boolean	execute(String sql) Executes the given SQL statement, which may return multiple results.
abstract boolean	execute(String sql, int[] columnIndexes) Executes the given SQL statement, which may return multiple results, and signals the driver that the auto-generated keys indicated in the given array should be made available for retrieval.
abstract boolean	execute(String sql, String[] columnNames) Executes the given SQL statement, which may return multiple results, and signals the driver that the auto-generated keys indicated in the given array should be made available for retrieval.
abstract int[]	executeBatch() Submits a batch of commands to the database for execution and if all commands execute successfully, returns an array of update counts.
abstract ResultSet	executeQuery(String sql) Executes the given SQL statement, which returns a single ResultSet object.
abstract int	executeUpdate(String sql) Executes the given SQL statement, which may be an INSERT, UPDATE, or DELETE statement or an SQL statement that returns nothing, such as an SQL DDL statement.
abstract int	executeUpdate(String sql, String[] columnNames) Executes the given SQL statement and signals the driver that the auto-generated keys indicated in the given array should be made available for retrieval.
abstract int	executeUpdate(String sql, int[] columnIndexes) Executes the given SQL statement and signals the driver that the auto-generated keys indicated in the given array should be made available for retrieval.
abstract int	executeUpdate(String sql, int autoGeneratedKeys) Executes the given SQL statement and signals the driver with the given flag about whether the auto-generated keys produced by this Statement object should be made available for retrieval.
abstract Connection	getConnection() Retrieves the Connection object that produced this Statement object.
abstract int	getFetchDirection() Retrieves the direction for fetching rows from database tables that is the default for result sets generated from this Statement object.
abstract int	getFetchSize() Retrieves the number of result set rows that is the default fetch size for ResultSet objects generated from this Statement object.
abstract ResultSet	getGeneratedKeys() Retrieves any auto-generated keys created as a result of executing this Statement object.
abstract int	getMaxFieldSize() Retrieves the maximum number of bytes that can be returned for character and binary column values in a ResultSet object produced by this Statement object.
abstract int	getMaxRows() Retrieves the maximum number of rows that a ResultSet object produced by this Statement object can contain.
abstract boolean	getMoreResults(int current) Moves to this Statement object's next result, deals with any current ResultSet object(s) according to the instructions specified by the given flag, and returns true if the next result is a ResultSet object.
abstract boolean	getMoreResults() Moves to this Statement object's next result, returns true if it is a ResultSet object, and implicitly closes any current ResultSet object(s) obtained with the method getResultSet.
abstract int	getQueryTimeout() Retrieves the number of seconds the driver will wait for a Statement object to execute.
abstract ResultSet	getResultSet() Retrieves the current result as a ResultSet object.
abstract int	getResultSetConcurrency() Retrieves the result set concurrency for ResultSet objects generated by this Statement object.
abstract int	getResultSetHoldability() Retrieves the result set holdability for ResultSet objects generated by this Statement object.
abstract int	getResultSetType() Retrieves the result set type for ResultSet objects generated by this Statement object.
abstract int	getUpdateCount() Retrieves the current result as an update count; if the result is a ResultSet object or there are no more results, -1 is returned.
abstract SQLWarning	getWarnings() Retrieves the first warning reported by calls on this Statement object.
abstract boolean	isClosed() Retrieves whether this Statement object has been closed.
abstract boolean	isPoolable() Returns a value indicating whether the Statement is poolable or not.
abstract void	setCursorName(String name) Sets the SQL cursor name to the given String, which will be used by subsequent Statement object execute methods.
abstract void	setEscapeProcessing(boolean enable) Sets escape processing on or off.
abstract void	setFetchDirection(int direction) Gives the driver a hint as to the direction in which rows will be processed in ResultSet objects created using this Statement object.
abstract void	setFetchSize(int rows) Gives the JDBC driver a hint as to the number of rows that should be fetched from the database when more rows are needed for ResultSet objects genrated by this Statement.
abstract void	setMaxFieldSize(int max) Sets the limit for the maximum number of bytes that can be returned for character and binary column values in a ResultSet object produced by this Statement object.
abstract void	setMaxRows(int max) Sets the limit for the maximum number of rows that any ResultSet object generated by this Statement object can contain to the given number.
abstract void	setPoolable(boolean poolable) Requests that a Statement be pooled or not pooled.
abstract void	setQueryTimeout(int seconds) Sets the number of seconds the driver will wait for a Statement object to execute to the given number of seconds.

From interface java.sql.Wrapper

abstract boolean	isWrapperFor(Class<?> iface) Returns true if this either implements the interface argument or is directly or indirectly a wrapper for an object that does.
abstract <T> T	unwrap(Class<T> iface) Returns an object that implements the given interface to allow access to non-standard methods, or standard methods not exposed by the proxy.

From interface java.lang.AutoCloseable

abstract void

close() Closes this resource, relinquishing any underlying resources.

Public Methods

public abstract void addBatch ()

Adds a set of parameters to this PreparedStatement object's batch of commands.

Throws

SQLException	if a database access error occurs or this method is called on a closed PreparedStatement

See Also

• Statement.addBatch(String)

public abstract 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.

Throws

SQLException	if a database access error occurs or this method is called on a closed PreparedStatement

public abstract 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).

Returns

• true if the first result is a ResultSet object; false if the first result is an update count or there is no result

Throws

SQLException	if a database access error occurs; this method is called on a closed PreparedStatement or an argument is supplied to this method
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

See Also

• Statement.execute(String)
• Statement.getResultSet()
• Statement.getUpdateCount()
• Statement.getMoreResults()

public abstract ResultSet executeQuery ()

Executes the SQL query in this PreparedStatement object and returns the ResultSet object generated by the query.

Returns

• a ResultSet object that contains the data produced by the query; never null

Throws

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
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

public abstract int executeUpdate ()

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.

Returns

• either (1) the row count for SQL Data Manipulation Language (DML) statements or (2) 0 for SQL statements that return nothing

Throws

SQLException	if a database access error occurs; this method is called on a closed PreparedStatement or the SQL statement returns a ResultSet object
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

public abstract 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.

Returns

• the description of a ResultSet object's columns or null if the driver cannot return a ResultSetMetaData object

Throws

SQLException	if a database access error occurs or this method is called on a closed PreparedStatement
SQLFeatureNotSupportedException	if the JDBC driver does not support this method

public abstract ParameterMetaData getParameterMetaData ()

Retrieves the number, types and properties of this PreparedStatement object's parameters.

Returns

• a ParameterMetaData object that contains information about the number, types and properties for each parameter marker of this PreparedStatement object

Throws

SQLException	if a database access error occurs or this method is called on a closed PreparedStatement

See Also

• ParameterMetaData

public abstract void setArray (int parameterIndex, Array x)

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	the first parameter is 1, the second is 2, ...
x	an Array object that maps an SQL ARRAY value

Throws

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
SQLFeatureNotSupportedException	if the JDBC driver does not support this method

public abstract void setAsciiStream (int parameterIndex, InputStream x, long 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.

Parameters

parameterIndex	the first parameter is 1, the second is 2, ...
x	the Java input stream that contains the ASCII parameter value
length	the number of bytes in the stream

Throws

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

public abstract void setAsciiStream (int parameterIndex, InputStream x)

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	the first parameter is 1, the second is 2, ...
x	the Java input stream that contains the ASCII parameter value

Throws

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
SQLFeatureNotSupportedException	if the JDBC driver does not support this method

public abstract 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. 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	the first parameter is 1, the second is 2, ...
x	the Java input stream that contains the ASCII parameter value
length	the number of bytes in the stream

Throws

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

public abstract void setBigDecimal (int parameterIndex, 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.

Parameters

parameterIndex	the first parameter is 1, the second is 2, ...
x	the parameter value

Throws

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

public abstract void setBinaryStream (int parameterIndex, InputStream x, long 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.

Parameters

parameterIndex	the first parameter is 1, the second is 2, ...
x	the java input stream which contains the binary parameter value
length	the number of bytes in the stream

Throws

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

public abstract void setBinaryStream (int parameterIndex, InputStream x)

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	the first parameter is 1, the second is 2, ...
x	the java input stream which contains the binary parameter value

Throws

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
SQLFeatureNotSupportedException	if the JDBC driver does not support this method

public abstract 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. 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	the first parameter is 1, the second is 2, ...
x	the java input stream which contains the binary parameter value
length	the number of bytes in the stream

Throws

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

public abstract void setBlob (int parameterIndex, InputStream inputStream, long length)

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	index of the first parameter is 1, the second is 2, ...
inputStream	An object that contains the data to set the parameter value to.
length	the number of bytes in the parameter data.

Throws

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.
SQLFeatureNotSupportedException	if the JDBC driver does not support this method

public abstract void setBlob (int parameterIndex, InputStream inputStream)

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	index of the first parameter is 1, the second is 2, ...
inputStream	An object that contains the data to set the parameter value to.

Throws

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,
SQLFeatureNotSupportedException	if the JDBC driver does not support this method

public abstract void setBlob (int parameterIndex, Blob x)

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	the first parameter is 1, the second is 2, ...
x	a Blob object that maps an SQL BLOB value

Throws

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
SQLFeatureNotSupportedException	if the JDBC driver does not support this method

public abstract void setBoolean (int parameterIndex, boolean x)

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	the first parameter is 1, the second is 2, ...
x	the parameter value

Throws

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

public abstract 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.

Parameters

parameterIndex	the first parameter is 1, the second is 2, ...
x	the parameter value

Throws

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

public abstract 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.

Parameters

parameterIndex	the first parameter is 1, the second is 2, ...
x	the parameter value

Throws

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

public abstract void setCharacterStream (int parameterIndex, Reader reader, long 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.

Parameters

parameterIndex	the first parameter is 1, the second is 2, ...
reader	the java.io.Reader object that contains the Unicode data
length	the number of characters in the stream

Throws

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

public abstract 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. 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	the first parameter is 1, the second is 2, ...
reader	the java.io.Reader object that contains the Unicode data
length	the number of characters in the stream

Throws

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

public abstract void setCharacterStream (int parameterIndex, Reader reader)

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	the first parameter is 1, the second is 2, ...
reader	the java.io.Reader object that contains the Unicode data

Throws

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
SQLFeatureNotSupportedException	if the JDBC driver does not support this method

public abstract void setClob (int parameterIndex, Clob x)

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	the first parameter is 1, the second is 2, ...
x	a Clob object that maps an SQL CLOB value

Throws

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
SQLFeatureNotSupportedException	if the JDBC driver does not support this method

public abstract void setClob (int parameterIndex, Reader reader, long length)

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	index of the first parameter is 1, the second is 2, ...
reader	An object that contains the data to set the parameter value to.
length	the number of characters in the parameter data.

Throws

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.
SQLFeatureNotSupportedException	if the JDBC driver does not support this method

public abstract void setClob (int parameterIndex, Reader reader)

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	index of the first parameter is 1, the second is 2, ...
reader	An object that contains the data to set the parameter value to.

Throws

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 PreparedStatementor if parameterIndex does not correspond to a parameter marker in the SQL statement
SQLFeatureNotSupportedException	if the JDBC driver does not support this method

public abstract void setDate (int parameterIndex, Date x)

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	the first parameter is 1, the second is 2, ...
x	the parameter value

Throws

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

public abstract void setDate (int parameterIndex, Date x, 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.

Parameters

parameterIndex	the first parameter is 1, the second is 2, ...
x	the parameter value
cal	the Calendar object the driver will use to construct the date

Throws

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

public abstract 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.

Parameters

parameterIndex	the first parameter is 1, the second is 2, ...
x	the parameter value

Throws

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

public abstract void setFloat (int parameterIndex, float x)

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	the first parameter is 1, the second is 2, ...
x	the parameter value

Throws

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

public abstract 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.

Parameters

parameterIndex	the first parameter is 1, the second is 2, ...
x	the parameter value

Throws

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

public abstract 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.

Parameters

parameterIndex	the first parameter is 1, the second is 2, ...
x	the parameter value

Throws

<