PreparedStatement

TopBlend: Here is the first difference. There are 173 differences.

~~is old.~~

is new.

java.sql
Interface PreparedStatement

All Superinterfaces:: Statement , Wrapper

All Known Subinterfaces:: CallableStatement

public interface PreparedStatement
extends Statement
extends Statement

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(java.lang.String) , ResultSet

Field Summary

Fields inherited from interface java.sql. Statement

CLOSE_ALL_RESULTS , CLOSE_CURRENT_RESULT , EXECUTE_FAILED , KEEP_CURRENT_RESULT , NO_GENERATED_KEYS , RETURN_GENERATED_KEYS , SUCCESS_NO_INFO

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 the SQL statement in this PreparedStatement object, which may be any kind of SQL statement.

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

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; ~~DELETE statement;~~ or an SQL statement that returns nothing, such as a DDL statement.

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.

ParameterMetaData getParameterMetaData ()
          Retrieves the number, types and properties of this PreparedStatement object's parameters.

boolean isPoolable ()
          Returns the value of the statements poolable hint, indicating whether pooling of the statement is requested.
~~void~~ ~~setArray~~ ~~(int i,~~ ~~Array~~
          ~~Sets the designated parameter to the given Array object.~~

void setArray (int parameterIndex, Array
          Sets the designated parameter to the given java.sql.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 the given 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 parameterIndex, ~~(int i,~~ Blob
          Sets the designated parameter to the given java.sql.Blob ~~Blob~~ object.

void setBlob (int parameterIndex, InputStream
          Sets the designated parameter to a InputStream object.

void setBoolean (int parameterIndex, boolean x)
          Sets the designated parameter to the given Java boolean value.

void setByte (int parameterIndex, byte x)
          Sets the designated parameter to the given Java byte value.

void setBytes (int parameterIndex, byte[] x)
          Sets the designated parameter to the given 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 parameterIndex, ~~(int i,~~ Clob
          Sets the designated parameter to the given java.sql.Clob ~~Clob~~ object.

void setClob ~~setDate~~ (int parameterIndex, Reader ~~Date~~
          Sets the designated parameter to a Reader object. ~~the given java.sql.Date value.~~

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

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 the given Java double value.

void setFloat (int parameterIndex, float x)
          Sets the designated parameter to the given Java float value.

void setInt (int parameterIndex, int x)
          Sets the designated parameter to the given Java int value.

void setLong (int parameterIndex, long x)
          Sets the designated parameter to the given Java long value.

void setNCharacterStream (int parameterIndex, Reader
          Sets the designated parameter to a Reader object.

void setNClob (int parameterIndex, NClob
          Sets the designated parameter to a java.sql.NClob object.

void setNClob (int parameterIndex, Reader
          Sets the designated parameter to a Reader object.

void setNString (int parameterIndex, String
          Sets the designated paramter to the given String object.

void setNull (int parameterIndex, int sqlType)
          Sets the designated parameter to SQL NULL.

void setNull (int parameterIndex, ~~(int paramIndex,~~ int sqlType, String
          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
          Sets the value of the designated parameter with the given object.

void setPoolable (boolean poolable)
          Requests that a PreparedStatement be pooled or not pooled.
~~void~~ ~~setRef~~ ~~(int i,~~ ~~Ref~~
          ~~Sets the designated parameter to the given REF(<structured-type>) value.~~

void setRef (int parameterIndex, Ref
          Sets the designated parameter to the given REF(<structured-type>) value.

void setRowId (int parameterIndex, RowId
          Sets the designated parameter to the given java.sql.RowId object.

void setShort (int parameterIndex, short x)
          Sets the designated parameter to the given Java short value.

void setSQLXML (int parameterIndex, SQLXML
          Sets the designated parameter to the given java.sql.SQLXML object.

void setString (int parameterIndex, String x)
          Sets the designated parameter to the given Java String value.

void setTime (int parameterIndex, Time x)
          Sets the designated parameter to the given 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 the given 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.

void setURL (int parameterIndex, URL x)
          Sets the designated parameter to the given java.net.URL value.

Methods inherited from interface java.sql. Statement

addBatch , cancel , clearBatch , clearWarnings , close , execute , execute , execute , execute , executeBatch , executeQuery , executeUpdate , executeUpdate , executeUpdate , executeUpdate , getConnection , getFetchDirection , getFetchSize , getGeneratedKeys , getMaxFieldSize , getMaxRows , getMoreResults , getMoreResults , getQueryTimeout , getResultSet , getResultSetConcurrency , getResultSetHoldability , getResultSetType , getUpdateCount , getWarnings , isClosed , setCursorName , setEscapeProcessing , setFetchDirection , setFetchSize , setMaxFieldSize , setMaxRows , setQueryTimeout

Methods inherited from interface java.sql. Wrapper

isWrapperFor , unwrap

Fields inherited from interface java.sql. Statement
CLOSE_ALL_RESULTS , CLOSE_CURRENT_RESULT , EXECUTE_FAILED , KEEP_CURRENT_RESULT , NO_GENERATED_KEYS , RETURN_GENERATED_KEYS , SUCCESS_NO_INFO

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 the SQL statement in this PreparedStatement object, which may be any kind of SQL statement.
ResultSet	executeQuery () Executes the SQL query in this PreparedStatement object and returns the ResultSet object generated by the query.
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;* ~~DELETE statement;~~ or an SQL statement that returns nothing, such as a DDL statement.
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.
ParameterMetaData	getParameterMetaData () Retrieves the number, types and properties of this PreparedStatement object's parameters.
*boolean*	*isPoolable* () *Returns the value of the statements poolable hint, indicating whether pooling of the statement is requested.*
~~void~~	~~setArray~~ ~~(int i,~~ ~~Array~~ ~~Sets the designated parameter to the given Array object.~~
*void*	*setArray* *(int parameterIndex,* *Array* *Sets the designated parameter to the given java.sql.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 the given 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 parameterIndex,* ~~(int i,~~ Blob Sets the designated parameter to the given *java.sql.Blob* ~~Blob~~ object.
*void*	*setBlob* *(int parameterIndex,* *InputStream* *Sets the designated parameter to a InputStream object.*
void	setBoolean (int parameterIndex, boolean x) Sets the designated parameter to the given Java boolean value.
void	setByte (int parameterIndex, byte x) Sets the designated parameter to the given Java byte value.
void	setBytes (int parameterIndex, byte[] x) Sets the designated parameter to the given 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 parameterIndex,* ~~(int i,~~ Clob Sets the designated parameter to the given *java.sql.Clob* ~~Clob~~ object.
void	*setClob* ~~setDate~~ (int parameterIndex, *Reader* ~~Date~~ Sets the designated parameter to *a Reader object.* ~~the given java.sql.Date value.~~
*void*	*setDate* *(int parameterIndex,* *Date* *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.*
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 the given Java double value.
void	setFloat (int parameterIndex, float x) Sets the designated parameter to the given Java float value.
void	setInt (int parameterIndex, int x) Sets the designated parameter to the given Java int value.
void	setLong (int parameterIndex, long x) Sets the designated parameter to the given Java long value.
*void*	*setNCharacterStream* *(int parameterIndex,* *Reader* *Sets the designated parameter to a Reader object.*
*void*	*setNClob* *(int parameterIndex,* *NClob* *Sets the designated parameter to a java.sql.NClob object.*
*void*	*setNClob* *(int parameterIndex,* *Reader* *Sets the designated parameter to a Reader object.*
*void*	*setNString* *(int parameterIndex,* *String* *Sets the designated paramter to the given String object.*
void	setNull (int parameterIndex, int sqlType) Sets the designated parameter to SQL NULL.
void	setNull *(int parameterIndex,* ~~(int paramIndex,~~ int sqlType, String 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 Sets the value of the designated parameter with the given object.
*void*	*setPoolable* *(boolean poolable)* *Requests that a PreparedStatement be pooled or not pooled.*
~~void~~	~~setRef~~ ~~(int i,~~ ~~Ref~~ ~~Sets the designated parameter to the given REF(<structured-type>) value.~~
*void*	*setRef* *(int parameterIndex,* *Ref* *Sets the designated parameter to the given REF(<structured-type>) value.*
*void*	*setRowId* *(int parameterIndex,* *RowId* *Sets the designated parameter to the given java.sql.RowId object.*
void	setShort (int parameterIndex, short x) Sets the designated parameter to the given Java short value.
*void*	*setSQLXML* *(int parameterIndex,* *SQLXML* *Sets the designated parameter to the given java.sql.SQLXML object.*
void	setString (int parameterIndex, String x) Sets the designated parameter to the given Java String value.
void	setTime (int parameterIndex, Time x) Sets the designated parameter to the given 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 the given 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.
void	setURL (int parameterIndex, URL x) Sets the designated parameter to the given java.net.URL value.

Methods inherited from interface java.sql. Statement
addBatch , cancel , clearBatch , clearWarnings , close , execute , execute , execute , execute , executeBatch , executeQuery , executeUpdate , executeUpdate , executeUpdate , executeUpdate , getConnection , getFetchDirection , getFetchSize , getGeneratedKeys , getMaxFieldSize , getMaxRows , getMoreResults , getMoreResults , getQueryTimeout , getResultSet , getResultSetConcurrency , getResultSetHoldability , getResultSetType , getUpdateCount , getWarnings , *isClosed* , setCursorName , setEscapeProcessing , setFetchDirection , setFetchSize , setMaxFieldSize , setMaxRows , setQueryTimeout

*Methods inherited from interface java.sql.* *Wrapper*
*isWrapperFor* , *unwrap*

Method Detail

executeQuery


ResultSet executeQuery()
                       throws SQLException

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 or the SQL statement does not return a ResultSet object

executeUpdate


int executeUpdate()
                  throws SQLException

Executes the SQL statement in this PreparedStatement object, which must be an SQL

Data Manipulation Language (DML) statement, such as INSERT, UPDATE or

DELETE;

~~DELETE statement;~~ or an SQL statement that returns nothing, such as a DDL statement.

Returns:: either (1) the row count for SQL Data Manipulation Language (DML) ~~INSERT, UPDATE, or DELETE~~ statements or (2) 0 for SQL statements that return nothing
Throws:: SQLException - if a database access error occurs or the SQL statement returns a ResultSet object

setNull


void setNull(int parameterIndex,
             int sqlType)
             throws SQLException

Sets the designated parameter to SQL NULL.

Note: You must specify the parameter's SQL type.

Parameters:: parameterIndex - the first parameter is 1, the second is 2, ...; sqlType - the SQL type code defined in java.sql.Types
Throws:: SQLException - if a database access error occurs

setBoolean


void setBoolean(int parameterIndex,
                boolean x)
                throws SQLException

Sets the designated parameter to the given Java boolean value. The driver converts this to an SQL BIT

or BOOLEAN value when it sends it to the database.

Parameters:: parameterIndex - the first parameter is 1, the second is 2, ...; x - the parameter value
Throws:: SQLException - if a database access error occurs

setByte


void setByte(int parameterIndex,
             byte x)
             throws SQLException

Sets the designated parameter to the given Java byte value. The driver converts this to an SQL TINYINT value when it sends it to the database.

Parameters:: parameterIndex - the first parameter is 1, the second is 2, ...; x - the parameter value
Throws:: SQLException - if a database access error occurs

setShort


void setShort(int parameterIndex,
              short x)
              throws SQLException

Sets the designated parameter to the given Java short value. The driver converts this to an SQL SMALLINT value when it sends it to the database.

Parameters:: parameterIndex - the first parameter is 1, the second is 2, ...; x - the parameter value
Throws:: SQLException - if a database access error occurs

setInt


void setInt(int parameterIndex,
            int x)
            throws SQLException

Sets the designated parameter to the given Java int value. The driver converts this to an SQL INTEGER value when it sends it to the database.

Parameters:: parameterIndex - the first parameter is 1, the second is 2, ...; x - the parameter value
Throws:: SQLException - if a database access error occurs

setLong


void setLong(int parameterIndex,
             long x)
             throws SQLException

Sets the designated parameter to the given Java long value. The driver converts this to an SQL BIGINT value when it sends it to the database.

Parameters:: parameterIndex - the first parameter is 1, the second is 2, ...; x - the parameter value
Throws:: SQLException - if a database access error occurs

setFloat


void setFloat(int parameterIndex,
              float x)
              throws SQLException

Sets the designated parameter to the given Java float value. The driver converts this to an SQL

REAL

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

setDouble


void setDouble(int parameterIndex,
               double x)
               throws SQLException

Sets the designated parameter to the given Java double value. The driver converts this to an SQL DOUBLE value when it sends it to the database.

Parameters:: parameterIndex - the first parameter is 1, the second is 2, ...; x - the parameter value
Throws:: SQLException - if a database access error occurs

setBigDecimal


void setBigDecimal(int parameterIndex,
                   BigDecimal x)
                   throws SQLException

Sets the designated parameter to the given java.math.BigDecimal value. The driver converts this to an SQL NUMERIC value when it sends it to the database.

Parameters:: parameterIndex - the first parameter is 1, the second is 2, ...; x - the parameter value
Throws:: SQLException - if a database access error occurs

setString


void setString(int parameterIndex,
               String x)
               throws SQLException

Sets the designated parameter to the given Java String value. The driver converts this to an SQL VARCHAR or LONGVARCHAR value (depending on the argument's size relative to the driver's limits on VARCHAR values) when it sends it to the database.

Parameters:: parameterIndex - the first parameter is 1, the second is 2, ...; x - the parameter value
Throws:: SQLException - if a database access error occurs

setBytes


void setBytes(int parameterIndex,
              byte[] x)
              throws SQLException

Sets the designated parameter to the given Java array of bytes. The driver converts this to an SQL VARBINARY or LONGVARBINARY (depending on the argument's size relative to the driver's limits on VARBINARY values) when it sends it to the database.

Parameters:: parameterIndex - the first parameter is 1, the second is 2, ...; x - the parameter value
Throws:: SQLException - if a database access error occurs

setDate


void setDate(int parameterIndex,
             Date x)
             throws SQLException

Sets the designated parameter to the given java.sql.Date

value using the default time zone of the virtual machine that is running the application.

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

setTime


void setTime(int parameterIndex,
             Time x)
             throws SQLException

Sets the designated parameter to the given java.sql.Time value. The driver converts this to an SQL TIME value when it sends it to the database.

Parameters:: parameterIndex - the first parameter is 1, the second is 2, ...; x - the parameter value
Throws:: SQLException - if a database access error occurs

setTimestamp


void setTimestamp(int parameterIndex,
                  Timestamp x)
                  throws SQLException

Sets the designated parameter to the given java.sql.Timestamp value. The driver converts this to an SQL TIMESTAMP value when it sends it to the database.

Parameters:: parameterIndex - the first parameter is 1, the second is 2, ...; x - the parameter value
Throws:: SQLException - if a database access error occurs

setAsciiStream


void setAsciiStream(int parameterIndex,
                    InputStream x,
                    int length)
                    throws SQLException

Sets the designated parameter to the given input stream, which will have the specified number of bytes. When a very large ASCII value is input to a LONGVARCHAR parameter, it may be more practical to send it via a java.io.InputStream. Data will be read from the stream as needed until end-of-file is reached. The JDBC driver will do any necessary conversion from ASCII to the database char format.

Note: This stream object can either be a standard Java stream object or your own subclass that implements the standard interface.

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 a database access error occurs

setUnicodeStream


 @Deprecated
void setUnicodeStream(int parameterIndex,
 InputStream x,
 int length)
 throws SQLException

Deprecated.

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.The byte format of the Unicode stream must be a Java UTF-8, as defined in the Java Virtual Machine Specification.

~~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 - a java.io.InputStream object that contains the Unicode parameter value ~~as two-byte Unicode characters~~; length - the number of bytes in the stream
Throws:: SQLException - if a database access error occurs

setBinaryStream


void setBinaryStream(int parameterIndex,
                     InputStream x,
                     int length)
                     throws SQLException

Sets the designated parameter to the given input stream, which will have the specified number of bytes. When a very large binary value is input to a LONGVARBINARY parameter, it may be more practical to send it via a java.io.InputStream object. The data will be read from the stream as needed until end-of-file is reached.

Note: This stream object can either be a standard Java stream object or your own subclass that implements the standard interface.

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 a database access error occurs

clearParameters


void clearParameters()
                     throws SQLException

Clears the current parameter values immediately.

In general, parameter values remain in force for repeated use of a statement. Setting a parameter value automatically clears its previous value. However, in some cases it is useful to immediately release the resources used by the current parameter values; this can be done by calling the method clearParameters.

Throws:: SQLException - if a database access error occurs

setObject


void setObject(int parameterIndex,
               Object x,
 int targetSqlType)
 int targetSqlType,
 int scale)
 throws SQLException

Sets the value of the designated parameter with the given object. This method is like the method setObject above, except that it assumes a scale of zero. ~~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.~~

Parameters:: parameterIndex - the first parameter is 1, the second is 2, ...; x - the object containing the input parameter value; targetSqlType - the SQL type (as defined in java.sql.Types) to be sent to the database ~~targetSqlType - 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.~~
Throws:: SQLException - if a database access error occurs
~~See Also:~~: ~~Types~~

setObject


void setObject(int parameterIndex,
               Object x)
  x,
 int targetSqlType)
 throws SQLException

~~Sets the value of the designated parameter with the given object. This method is like the method setObject above, except that it assumes a scale of zero.~~

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, NClob, Struct, java.net.URL, 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.

Parameters:: parameterIndex - the first parameter is 1, the second is 2, ...; x - the object containing the input parameter value; ~~targetSqlType - the SQL type (as defined in java.sql.Types) to be sent to the database~~
Throws:: SQLException - if a database access error occurs or the type of the given object is ambiguous

execute setObject


boolean 
void execute setObject ()
 throws SQLException(int parameterIndex,
 Object x)
 throws SQLException

Executes the SQL statement in this PreparedStatement object, which may be any kind of SQL statement. Some prepared statements return multiple results; the execute method handles these complex statements as well as the simpler form of statements handled by the methods executeQuery and executeUpdate.

The 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). ~~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.~~

Returns: ~~Parameters:~~: true if the first result is a ResultSet object; false if the first result is an update count or there is no result ~~parameterIndex - the first parameter is 1, the second is 2, ...~~; ~~x - the object containing the input parameter value~~
Throws:: SQLException - if a database access error occurs or an argument is supplied to this method
See Also:: Statement.execute(java.lang.String) , Statement.getResultSet() , Statement.getUpdateCount() , Statement.getMoreResults() ~~- if a database access error occurs or the type of the given object is ambiguous~~

addBatch execute


void 
boolean addBatch execute ()
 throws SQLException

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

Throws: ~~Returns:~~: SQLException - if a database access error occurs ~~true if the first result is a ResultSet object; false if the first result is an update count or there is no result~~
Since: ~~Throws:~~: 1.2
See Also:: Statement.addBatch(java.lang.String) ~~Statement.execute(java.lang.String)~~ , ~~Statement.getResultSet()~~ , ~~Statement.getUpdateCount()~~ , ~~Statement.getMoreResults()~~

setCharacterStream addBatch


void setCharacterStream addBatch (int parameterIndex,
 Reader()
 throws SQLException reader,
 int length)
 throws SQLException

Sets the designated parameter to the given Reader object, which is the given number of characters long. When a very large UNICODE value is input to a LONGVARCHAR parameter, it may be more practical to send it via a java.io.Reader object. The data will be read from the stream as needed until end-of-file is reached. The JDBC driver will do any necessary conversion from UNICODE to the database char format.

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

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 a database access error occurs
Since:: 1.2
~~See Also:~~: ~~Statement.addBatch(java.lang.String)~~

setRef setCharacterStream


void setRef setCharacterStream (int parameterIndex,
 RefReader x)
  reader,
 int length)
 throws SQLException

Sets the designated parameter to the given REF(<structured-type>) value. The driver converts this to an SQL REF value when it sends it to the database.

~~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 - an SQL REF value ~~reader - the java.io.Reader object that contains the Unicode data~~; ~~length - the number of characters in the stream~~
Throws:: SQLException - if a database access error occurs
Since:: 1.2

setBlob setRef


void setBlob setRef (int parameterIndex,
 Blob(int i,
 Ref x)
 throws SQLException

Sets the designated parameter to the given

java.sql.Blob object.

~~REF(<structured-type>) value.~~ The driver converts this to an SQL

BLOB

~~REF~~ value when it sends it to the database.

Parameters:: parameterIndex i - the first parameter is 1, the second is 2, ...; x - a Blob object that maps an SQL BLOB ~~REF~~ value
Throws:: SQLException - if a database access error occurs
Since:: 1.2

setClob setBlob


void setClob setBlob (int parameterIndex,
 Clob(int i,
 Blob x)
             throws SQLException

Sets the designated parameter to the given

java.sql.Clob

~~Blob~~ object. The driver converts this to an SQL

CLOB

~~BLOB~~ value when it sends it to the database.

Parameters:: parameterIndex i - the first parameter is 1, the second is 2, ...; x - a Clob ~~Blob~~ object that maps an SQL CLOB ~~BLOB~~ value
Throws:: SQLException - if a database access error occurs
Since:: 1.2

setArray setClob


void setArray setClob (int parameterIndex,
 Array(int i,
 Clob x)
 throws SQLException

Sets the designated parameter to the given

java.sql.Array

~~Clob~~ object. The driver converts this to an SQL

ARRAY

~~CLOB~~ value when it sends it to the database.

Parameters:: parameterIndex i - the first parameter is 1, the second is 2, ...; x - an Array ~~a Clob~~ object that maps an SQL ARRAY ~~CLOB~~ value
Throws:: SQLException - if a database access error occurs
Since:: 1.2

getMetaData setArray


 ResultSetMetaData
void getMetaData setArray ()
 throws SQLException(int i,
 Array x)
 throws SQLException

Retrieves a ResultSetMetaData object that contains information about the columns of the ResultSet object that will be returned when this PreparedStatement object is executed.

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

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: ~~Parameters:~~: the description of a ResultSet object's columns or null if the driver cannot return a ResultSetMetaData object ~~i - the first parameter is 1, the second is 2, ...~~; ~~x - an Array object that maps an SQL ARRAY value~~
Throws:: SQLException - if a database access error occurs
Since:: 1.2

setDate getMetaData


void 
 ResultSetMetaDatasetDate getMetaData (int parameterIndex,
 Date()
 throws SQLException x,
 Calendar cal)
 throws SQLException

Sets the designated parameter to the given java.sql.Date value, using the given Calendar object. The driver uses the Calendar object to construct an SQL DATE value, which the driver then sends to the database. With a Calendar object, the driver can calculate the date taking into account a custom timezone. If no Calendar object is specified, the driver uses the default timezone, which is that of the virtual machine running the application.

~~Retrieves a ResultSetMetaData object that contains information about the columns of the ResultSet object that will be returned when this PreparedStatement object is executed.~~

~~NOTE:~~ ~~Using this method may be expensive for some drivers due to the lack of underlying DBMS support.~~

Parameters: ~~Returns:~~: 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 ~~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
Since:: 1.2

setTime setDate


void setTime setDate (int parameterIndex,
 TimeDate x,
             Calendar cal)
             throws SQLException

Sets the designated parameter to the given

java.sql.Time

~~java.sql.Date~~ value, using the given Calendar object. The driver uses the Calendar object to construct an SQL

TIME

~~DATE~~ value, which the driver then sends to the database. With a Calendar object, the driver can calculate the

time

~~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 time ~~date~~
Throws:: SQLException - if a database access error occurs
Since:: 1.2

setTimestamp setTime


void setTimestamp setTime (int parameterIndex,
 TimestampTime x,
 Calendar cal)
 throws SQLException

Sets the designated parameter to the given

java.sql.Timestamp

~~java.sql.Time~~ value, using the given Calendar object. The driver uses the Calendar object to construct an SQL

TIMESTAMP

~~TIME~~ value, which the driver then sends to the database. With a Calendar object, the driver can calculate the

timestamp

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

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 timestamp ~~time~~
Throws:: SQLException - if a database access error occurs
Since:: 1.2

setNull setTimestamp


void setNull setTimestamp (int parameterIndex,
 int sqlType,
 String(int parameterIndex,
 Timestamp typeName)
 throws SQLException x,
 Calendar cal)
 throws SQLException

Sets the designated parameter to SQL NULL. This version of the method setNull should be used for user-defined types and REF type parameters. Examples of user-defined types include: STRUCT, DISTINCT, JAVA_OBJECT, and named array types.

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.

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.

Parameters:: parameterIndex - the first parameter is 1, the second is 2, ...; sqlType - a value from java.sql.Types ~~x - the parameter value~~; typeName - the fully-qualified name of an SQL user-defined type; ignored if the parameter is not a user-defined type or REF ~~cal - the Calendar object the driver will use to construct the timestamp~~
Throws:: SQLException - if a database access error occurs
Since:: 1.2

setURL setNull


void setURL setNull (int parameterIndex,
 URL(int paramIndex,
 int sqlType,
 String x)
  typeName)
 throws SQLException

Sets the designated parameter to the given java.net.URL value. The driver converts this to an SQL DATALINK value when it sends it to the database.

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

Parameters:: parameterIndex ~~paramIndex~~ - the first parameter is 1, the second is 2, ...; x - the java.net.URL object to be set ~~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 REF~~
Throws:: SQLException - if a database access error occurs
Since:: 1.4 ~~1.2~~

getParameterMetaData setURL


 ParameterMetaData
void getParameterMetaData setURL ()
 throws SQLException(int parameterIndex,
 URL x)
 throws SQLException

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

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

Returns: ~~Parameters:~~: a ParameterMetaData object that contains information about the number, types and properties of this PreparedStatement object's parameters ~~parameterIndex - the first parameter is 1, the second is 2, ...~~; ~~x - the java.net.URL object to be set~~
Throws:: SQLException - if a database access error occurs
Since:: 1.4
See Also:: ParameterMetaData

setRowId getParameterMetaData


void 
 ParameterMetaDatasetRowId getParameterMetaData (int parameterIndex,
 RowId()
 throws SQLException x)
 throws SQLException

Sets the designated parameter to the given java.sql.RowId object. The driver converts this to a SQL ROWID value when it sends it to the database

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

Parameters: ~~Returns:~~: parameterIndex - the first parameter is 1, the second is 2, ...; x - the parameter value ~~a ParameterMetaData object that contains information about the number, types and properties of this PreparedStatement object's parameters~~
Throws:: SQLException - if a database access error occurs
Since:: 1.6 ~~1.4~~
~~See Also:~~: ~~ParameterMetaData~~

setNString


 
void setNString (int parameterIndex,
 String value)
 throws SQLException

Sets the designated paramter to the given String object. The driver converts this to a SQL NCHAR or NVARCHAR or LONGNVARCHAR value (depending on the argument's size relative to the driver's limits on NVARCHAR values) when it sends it to the database.

Parameters:: parameterIndex - of the first parameter is 1, the second is 2, ...; value - the parameter value
Throws:: SQLException - if the driver does not support national character sets; if the driver can detect that a data conversion error could occur ; or if a database access error occurs
Since:: 1.6

setNCharacterStream


 
void setNCharacterStream (int parameterIndex,
 Reader value,
 long length)
 throws SQLException

Sets the designated parameter to a Reader object. The Reader reads the data till end-of-file is reached. The driver does the necessary conversion from Java character format to the national character set in the database.

Parameters:: parameterIndex - of the first parameter is 1, the second is 2, ...; value - the parameter value; length - the number of characters in the parameter data.
Throws:: SQLException - if the driver does not support national character sets; if the driver can detect that a data conversion error could occur ; or if a database access error occurs
Since:: 1.6

setNClob


 
void setNClob (int parameterIndex,
 NClob value)
 throws SQLException

Sets the designated parameter to a java.sql.NClob object. The driver converts this to a SQL NCLOB value when it sends it to the database.

Parameters:: parameterIndex - of the first parameter is 1, the second is 2, ...; value - the parameter value
Throws:: SQLException - if the driver does not support national character sets; if the driver can detect that a data conversion error could occur ; or if a database access error occurs
Since:: 1.6

setClob


 
void setClob (int parameterIndex,
 Reader reader,
 long length)
 throws SQLException

Sets the designated parameter to a Reader object. The reader must contain the number of characters specified by length otherwise a SQLException will be generated when the PreparedStatement is executed.This method differs from the setCharacterStream (int, Reader, int) method because it informs the driver that the parameter value should be sent to the server as a CLOB. When the setCharacterStream method is used, the driver may have to do extra work to determine whether the parameter data should be send 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, or if the length specified is less than zero.
Since:: 1.6

setBlob


 
void setBlob (int parameterIndex,
 InputStream inputStream,
 long length)
 throws SQLException

Sets the designated parameter to a InputStream object. The inputstream must contain the number of characters specified by length otherwise a SQLException will be generated when the PreparedStatement is executed. This method differs from the setBinaryStream (int, InputStream, int) method because it informs the driver that the parameter value should be sent to the server as a BLOB. When the setBinaryStream method is used, the driver may have to do extra work to determine whether the parameter data should be send 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 the length specified is less than zero or if the number of bytes in the inputstream does not match the specfied length.
Since:: 1.6

setNClob


 
void setNClob (int parameterIndex,
 Reader reader,
 long length)
 throws SQLException

Sets the designated parameter to a Reader object. The reader must contain the number of characters specified by length otherwise a SQLException will be generated when the PreparedStatement is executed. This method differs from the setCharacterStream (int, Reader, int) method because it informs the driver that the parameter value should be sent to the server as a NCLOB. When the setCharacterStream method is used, the driver may have to do extra work to determine whether the parameter data should be send to the server as a LONGNVARCHAR or a NCLOB

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 the length specified is less than zero; if the driver does not support national character sets; if the driver can detect that a data conversion error could occur; or if a database access error occurs
Since:: 1.6

setSQLXML


 
void setSQLXML (int parameterIndex,
 SQLXML xmlObject)
 throws SQLException

Sets the designated parameter to the given java.sql.SQLXML object. The driver converts this to an SQL XML value when it sends it to the database.

Parameters:: parameterIndex - index of the first parameter is 1, the second is 2, ...; xmlObject - a SQLXML object that maps an SQL XML value
Throws:: SQLException - if a database access error occurs
Since:: 1.6

setPoolable


 
void setPoolable (boolean poolable)
 throws SQLException

Requests that a PreparedStatement be pooled or not pooled. The value specified is a hint to the statement pool implementation indicating whether the applicaiton wants the statement to be pooled. It is up to the statement pool manager as to whether the hint is used.

The poolable value of a statement is applicable to both internal statement caches implemented by the driver and external statement caches implemented by application servers and other applications.

By default, a PreparedStatement is poolable when it is created.

Parameters:: poolable - requests that the statement be pooled if true and that the statement not be pooled if false
Throws:: SQLException - if the PreparedStatement has been closed
Since:: 1.6

isPoolable


 
boolean isPoolable ()
 throws SQLException

Returns the value of the statements poolable hint, indicating whether pooling of the statement is requested.

Returns:: The value of the statements poolable hint.
Throws:: SQLException - if the PreparedStatement has been closed
Since:: 1.6
See Also:: setPoolable(boolean)

setObject


 
void setObject (int parameterIndex,
 Object x,
 int targetSqlType,
 int scaleOrLength)
 throws SQLException

Sets the value of the designated parameter with the given object. The second argument must be an object type; for integral values, the java.lang equivalent objects should be used. If the second argument is an InputStream then the stream must contain the number of bytes specified by scaleOrLength. If the second argument is a Reader then the reader must contain the number of characters specified by scaleOrLength. If these conditions are not true the driver will generate a SQLException when the prepared statement is executed.

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, NClob, Struct, java.net.URL, 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.

Parameters:: parameterIndex - the first parameter is 1, the second is 2, ...; x - the object containing the input parameter value; targetSqlType - the SQL type (as defined in java.sql.Types) to be sent to the database. The scale argument may further qualify this type.; scaleOrLength - for java.sql.Types.DECIMAL or java.sql.Types.NUMERIC types, this is the number of digits after the decimal point. For Java Object types InputStream and Reader, this is the length of the data in the stream or reader. For all other types, this value will be ignored.
Throws:: SQLException - if a database access error occurs or if the Java Object specified by x is an InputStream or Reader object and the value of the scale parameter is less than zero
Since:: 1.6
See Also:: Types

java.sql Interface PreparedStatement

executeQuery

executeUpdate

setNull

setBoolean

setByte

setShort

setInt

setLong

setFloat

setDouble

setBigDecimal

setString

setBytes

setDate

setTime

setTimestamp

setAsciiStream

setUnicodeStream

setBinaryStream

clearParameters

setObject

setObject

execute setObject

addBatch execute

setCharacterStream addBatch

setRef setCharacterStream

setBlob setRef

setClob setBlob

setArray setClob

getMetaData setArray

setDate getMetaData

setTime setDate

setTimestamp setTime

setNull setTimestamp

setURL setNull

getParameterMetaData setURL

setRowId getParameterMetaData

setNString

setNCharacterStream

setNClob

setClob

setBlob

setNClob

setSQLXML

setPoolable

isPoolable

setObject

java.sql
Interface PreparedStatement