java.sql
Interface PreparedStatement

All Superinterfaces:
Statement sample code for java.sql.Statement definition code for java.sql.Statement
All Known Subinterfaces:
CallableStatement sample code for java.sql.CallableStatement definition code for java.sql.CallableStatement

public interface PreparedStatement
extends Statement sample code for java.sql.Statement definition code for java.sql.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) sample code for java.sql.Connection.prepareStatement(java.lang.String) definition code for java.sql.Connection.prepareStatement(java.lang.String) , ResultSet sample code for java.sql.ResultSet definition code for java.sql.ResultSet

Field Summary
 
Fields inherited from interface java.sql.Statement sample code for java.sql.Statement definition code for java.sql.Statement
CLOSE_ALL_RESULTS sample code for java.sql.Statement.CLOSE_ALL_RESULTS definition code for java.sql.Statement.CLOSE_ALL_RESULTS , CLOSE_CURRENT_RESULT sample code for java.sql.Statement.CLOSE_CURRENT_RESULT definition code for java.sql.Statement.CLOSE_CURRENT_RESULT , EXECUTE_FAILED sample code for java.sql.Statement.EXECUTE_FAILED definition code for java.sql.Statement.EXECUTE_FAILED , KEEP_CURRENT_RESULT sample code for java.sql.Statement.KEEP_CURRENT_RESULT definition code for java.sql.Statement.KEEP_CURRENT_RESULT , NO_GENERATED_KEYS sample code for java.sql.Statement.NO_GENERATED_KEYS definition code for java.sql.Statement.NO_GENERATED_KEYS , RETURN_GENERATED_KEYS sample code for java.sql.Statement.RETURN_GENERATED_KEYS definition code for java.sql.Statement.RETURN_GENERATED_KEYS , SUCCESS_NO_INFO sample code for java.sql.Statement.SUCCESS_NO_INFO definition code for java.sql.Statement.SUCCESS_NO_INFO
 
Method Summary
 void addBatch sample code for java.sql.PreparedStatement.addBatch() definition code for java.sql.PreparedStatement.addBatch() ()
          Adds a set of parameters to this PreparedStatement object's batch of commands.
 void clearParameters sample code for java.sql.PreparedStatement.clearParameters() definition code for java.sql.PreparedStatement.clearParameters() ()
          Clears the current parameter values immediately.
 boolean execute sample code for java.sql.PreparedStatement.execute() definition code for java.sql.PreparedStatement.execute() ()
          Executes the SQL statement in this PreparedStatement object, which may be any kind of SQL statement.
 ResultSet sample code for java.sql.ResultSet definition code for java.sql.ResultSet executeQuery sample code for java.sql.PreparedStatement.executeQuery() definition code for java.sql.PreparedStatement.executeQuery() ()
          Executes the SQL query in this PreparedStatement object and returns the ResultSet object generated by the query.
 int executeUpdate sample code for java.sql.PreparedStatement.executeUpdate() definition code for java.sql.PreparedStatement.executeUpdate() ()
          Executes the SQL statement in this PreparedStatement object, which must be an SQL INSERT, UPDATE or DELETE statement; or an SQL statement that returns nothing, such as a DDL statement.
 ResultSetMetaData sample code for java.sql.ResultSetMetaData definition code for java.sql.ResultSetMetaData getMetaData sample code for java.sql.PreparedStatement.getMetaData() definition code for java.sql.PreparedStatement.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 sample code for java.sql.ParameterMetaData definition code for java.sql.ParameterMetaData getParameterMetaData sample code for java.sql.PreparedStatement.getParameterMetaData() definition code for java.sql.PreparedStatement.getParameterMetaData() ()
          Retrieves the number, types and properties of this PreparedStatement object's parameters.
 void setArray sample code for java.sql.PreparedStatement.setArray(int, java.sql.Array) definition code for java.sql.PreparedStatement.setArray(int, java.sql.Array) (int i, Array sample code for java.sql.Array definition code for java.sql.Array  x)
          Sets the designated parameter to the given Array object.
 void setAsciiStream sample code for java.sql.PreparedStatement.setAsciiStream(int, java.io.InputStream, int) definition code for java.sql.PreparedStatement.setAsciiStream(int, java.io.InputStream, int) (int parameterIndex, InputStream sample code for java.io.InputStream definition code for java.io.InputStream  x, int length)
          Sets the designated parameter to the given input stream, which will have the specified number of bytes.
 void setBigDecimal sample code for java.sql.PreparedStatement.setBigDecimal(int, java.math.BigDecimal) definition code for java.sql.PreparedStatement.setBigDecimal(int, java.math.BigDecimal) (int parameterIndex, BigDecimal sample code for java.math.BigDecimal definition code for java.math.BigDecimal  x)
          Sets the designated parameter to the given java.math.BigDecimal value.
 void setBinaryStream sample code for java.sql.PreparedStatement.setBinaryStream(int, java.io.InputStream, int) definition code for java.sql.PreparedStatement.setBinaryStream(int, java.io.InputStream, int) (int parameterIndex, InputStream sample code for java.io.InputStream definition code for java.io.InputStream  x, int length)
          Sets the designated parameter to the given input stream, which will have the specified number of bytes.
 void setBlob sample code for java.sql.PreparedStatement.setBlob(int, java.sql.Blob) definition code for java.sql.PreparedStatement.setBlob(int, java.sql.Blob) (int i, Blob sample code for java.sql.Blob definition code for java.sql.Blob  x)
          Sets the designated parameter to the given Blob object.
 void setBoolean sample code for java.sql.PreparedStatement.setBoolean(int, boolean) definition code for java.sql.PreparedStatement.setBoolean(int, boolean) (int parameterIndex, boolean x)
          Sets the designated parameter to the given Java boolean value.
 void setByte sample code for java.sql.PreparedStatement.setByte(int, byte) definition code for java.sql.PreparedStatement.setByte(int, byte) (int parameterIndex, byte x)
          Sets the designated parameter to the given Java byte value.
 void setBytes sample code for java.sql.PreparedStatement.setBytes(int, byte[]) definition code for java.sql.PreparedStatement.setBytes(int, byte[]) (int parameterIndex, byte[] x)
          Sets the designated parameter to the given Java array of bytes.
 void setCharacterStream sample code for java.sql.PreparedStatement.setCharacterStream(int, java.io.Reader, int) definition code for java.sql.PreparedStatement.setCharacterStream(int, java.io.Reader, int) (int parameterIndex, Reader sample code for java.io.Reader definition code for java.io.Reader  reader, int length)
          Sets the designated parameter to the given Reader object, which is the given number of characters long.
 void setClob sample code for java.sql.PreparedStatement.setClob(int, java.sql.Clob) definition code for java.sql.PreparedStatement.setClob(int, java.sql.Clob) (int i, Clob sample code for java.sql.Clob definition code for java.sql.Clob  x)
          Sets the designated parameter to the given Clob object.
 void setDate sample code for java.sql.PreparedStatement.setDate(int, java.sql.Date) definition code for java.sql.PreparedStatement.setDate(int, java.sql.Date) (int parameterIndex, Date sample code for java.sql.Date definition code for java.sql.Date  x)
          Sets the designated parameter to the given java.sql.Date value.
 void setDate sample code for java.sql.PreparedStatement.setDate(int, java.sql.Date, java.util.Calendar) definition code for java.sql.PreparedStatement.setDate(int, java.sql.Date, java.util.Calendar) (int parameterIndex, Date sample code for java.sql.Date definition code for java.sql.Date  x, Calendar sample code for java.util.Calendar definition code for java.util.Calendar  cal)
          Sets the designated parameter to the given java.sql.Date value, using the given Calendar object.
 void setDouble sample code for java.sql.PreparedStatement.setDouble(int, double) definition code for java.sql.PreparedStatement.setDouble(int, double) (int parameterIndex, double x)
          Sets the designated parameter to the given Java double value.
 void setFloat sample code for java.sql.PreparedStatement.setFloat(int, float) definition code for java.sql.PreparedStatement.setFloat(int, float) (int parameterIndex, float x)
          Sets the designated parameter to the given Java float value.
 void setInt sample code for java.sql.PreparedStatement.setInt(int, int) definition code for java.sql.PreparedStatement.setInt(int, int) (int parameterIndex, int x)
          Sets the designated parameter to the given Java int value.
 void setLong sample code for java.sql.PreparedStatement.setLong(int, long) definition code for java.sql.PreparedStatement.setLong(int, long) (int parameterIndex, long x)
          Sets the designated parameter to the given Java long value.
 void setNull sample code for java.sql.PreparedStatement.setNull(int, int) definition code for java.sql.PreparedStatement.setNull(int, int) (int parameterIndex, int sqlType)
          Sets the designated parameter to SQL NULL.
 void setNull sample code for java.sql.PreparedStatement.setNull(int, int, java.lang.String) definition code for java.sql.PreparedStatement.setNull(int, int, java.lang.String) (int paramIndex, int sqlType, String sample code for java.lang.String definition code for java.lang.String  typeName)
          Sets the designated parameter to SQL NULL.
 void setObject sample code for java.sql.PreparedStatement.setObject(int, java.lang.Object) definition code for java.sql.PreparedStatement.setObject(int, java.lang.Object) (int parameterIndex, Object sample code for java.lang.Object definition code for java.lang.Object  x)
          Sets the value of the designated parameter using the given object.
 void setObject sample code for java.sql.PreparedStatement.setObject(int, java.lang.Object, int) definition code for java.sql.PreparedStatement.setObject(int, java.lang.Object, int) (int parameterIndex, Object sample code for java.lang.Object definition code for java.lang.Object  x, int targetSqlType)
          Sets the value of the designated parameter with the given object.
 void setObject sample code for java.sql.PreparedStatement.setObject(int, java.lang.Object, int, int) definition code for java.sql.PreparedStatement.setObject(int, java.lang.Object, int, int) (int parameterIndex, Object sample code for java.lang.Object definition code for java.lang.Object  x, int targetSqlType, int scale)
          Sets the value of the designated parameter with the given object.
 void setRef sample code for java.sql.PreparedStatement.setRef(int, java.sql.Ref) definition code for java.sql.PreparedStatement.setRef(int, java.sql.Ref) (int i, Ref sample code for java.sql.Ref definition code for java.sql.Ref  x)
          Sets the designated parameter to the given REF(<structured-type>) value.
 void setShort sample code for java.sql.PreparedStatement.setShort(int, short) definition code for java.sql.PreparedStatement.setShort(int, short) (int parameterIndex, short x)
          Sets the designated parameter to the given Java short value.
 void setString sample code for java.sql.PreparedStatement.setString(int, java.lang.String) definition code for java.sql.PreparedStatement.setString(int, java.lang.String) (int parameterIndex, String sample code for java.lang.String definition code for java.lang.String  x)
          Sets the designated parameter to the given Java String value.
 void setTime sample code for java.sql.PreparedStatement.setTime(int, java.sql.Time) definition code for java.sql.PreparedStatement.setTime(int, java.sql.Time) (int parameterIndex, Time sample code for java.sql.Time definition code for java.sql.Time  x)
          Sets the designated parameter to the given java.sql.Time value.
 void setTime sample code for java.sql.PreparedStatement.setTime(int, java.sql.Time, java.util.Calendar) definition code for java.sql.PreparedStatement.setTime(int, java.sql.Time, java.util.Calendar) (int parameterIndex, Time sample code for java.sql.Time definition code for java.sql.Time  x, Calendar sample code for java.util.Calendar definition code for java.util.Calendar  cal)
          Sets the designated parameter to the given java.sql.Time value, using the given Calendar object.
 void setTimestamp sample code for java.sql.PreparedStatement.setTimestamp(int, java.sql.Timestamp) definition code for java.sql.PreparedStatement.setTimestamp(int, java.sql.Timestamp) (int parameterIndex, Timestamp sample code for java.sql.Timestamp definition code for java.sql.Timestamp  x)
          Sets the designated parameter to the given java.sql.Timestamp value.
 void setTimestamp sample code for java.sql.PreparedStatement.setTimestamp(int, java.sql.Timestamp, java.util.Calendar) definition code for java.sql.PreparedStatement.setTimestamp(int, java.sql.Timestamp, java.util.Calendar) (int parameterIndex, Timestamp sample code for java.sql.Timestamp definition code for java.sql.Timestamp  x, Calendar sample code for java.util.Calendar definition code for java.util.Calendar  cal)
          Sets the designated parameter to the given java.sql.Timestamp value, using the given Calendar object.
 void setUnicodeStream sample code for java.sql.PreparedStatement.setUnicodeStream(int, java.io.InputStream, int) definition code for java.sql.PreparedStatement.setUnicodeStream(int, java.io.InputStream, int) (int parameterIndex, InputStream sample code for java.io.InputStream definition code for java.io.InputStream  x, int length)
          Deprecated.  
 void setURL sample code for java.sql.PreparedStatement.setURL(int, java.net.URL) definition code for java.sql.PreparedStatement.setURL(int, java.net.URL) (int parameterIndex, URL sample code for java.net.URL definition code for java.net.URL  x)
          Sets the designated parameter to the given java.net.URL value.
 
Methods inherited from interface java.sql.Statement sample code for java.sql.Statement definition code for java.sql.Statement
addBatch sample code for java.sql.Statement.addBatch(java.lang.String) definition code for java.sql.Statement.addBatch(java.lang.String) , cancel sample code for java.sql.Statement.cancel() definition code for java.sql.Statement.cancel() , clearBatch sample code for java.sql.Statement.clearBatch() definition code for java.sql.Statement.clearBatch() , clearWarnings sample code for java.sql.Statement.clearWarnings() definition code for java.sql.Statement.clearWarnings() , close sample code for java.sql.Statement.close() definition code for java.sql.Statement.close() , execute sample code for java.sql.Statement.execute(java.lang.String) definition code for java.sql.Statement.execute(java.lang.String) , execute sample code for java.sql.Statement.execute(java.lang.String, int) definition code for java.sql.Statement.execute(java.lang.String, int) , execute sample code for java.sql.Statement.execute(java.lang.String, int[]) definition code for java.sql.Statement.execute(java.lang.String, int[]) , execute sample code for java.sql.Statement.execute(java.lang.String, java.lang.String[]) definition code for java.sql.Statement.execute(java.lang.String, java.lang.String[]) , executeBatch sample code for java.sql.Statement.executeBatch() definition code for java.sql.Statement.executeBatch() , executeQuery sample code for java.sql.Statement.executeQuery(java.lang.String) definition code for java.sql.Statement.executeQuery(java.lang.String) , executeUpdate sample code for java.sql.Statement.executeUpdate(java.lang.String) definition code for java.sql.Statement.executeUpdate(java.lang.String) , executeUpdate sample code for java.sql.Statement.executeUpdate(java.lang.String, int) definition code for java.sql.Statement.executeUpdate(java.lang.String, int) , executeUpdate sample code for java.sql.Statement.executeUpdate(java.lang.String, int[]) definition code for java.sql.Statement.executeUpdate(java.lang.String, int[]) , executeUpdate sample code for java.sql.Statement.executeUpdate(java.lang.String, java.lang.String[]) definition code for java.sql.Statement.executeUpdate(java.lang.String, java.lang.String[]) , getConnection sample code for java.sql.Statement.getConnection() definition code for java.sql.Statement.getConnection() , getFetchDirection sample code for java.sql.Statement.getFetchDirection() definition code for java.sql.Statement.getFetchDirection() , getFetchSize sample code for java.sql.Statement.getFetchSize() definition code for java.sql.Statement.getFetchSize() , getGeneratedKeys sample code for java.sql.Statement.getGeneratedKeys() definition code for java.sql.Statement.getGeneratedKeys() , getMaxFieldSize sample code for java.sql.Statement.getMaxFieldSize() definition code for java.sql.Statement.getMaxFieldSize() , getMaxRows sample code for java.sql.Statement.getMaxRows() definition code for java.sql.Statement.getMaxRows() , getMoreResults sample code for java.sql.Statement.getMoreResults() definition code for java.sql.Statement.getMoreResults() , getMoreResults sample code for java.sql.Statement.getMoreResults(int) definition code for java.sql.Statement.getMoreResults(int) , getQueryTimeout sample code for java.sql.Statement.getQueryTimeout() definition code for java.sql.Statement.getQueryTimeout() , getResultSet sample code for java.sql.Statement.getResultSet() definition code for java.sql.Statement.getResultSet() , getResultSetConcurrency sample code for java.sql.Statement.getResultSetConcurrency() definition code for java.sql.Statement.getResultSetConcurrency() , getResultSetHoldability sample code for java.sql.Statement.getResultSetHoldability() definition code for java.sql.Statement.getResultSetHoldability() , getResultSetType sample code for java.sql.Statement.getResultSetType() definition code for java.sql.Statement.getResultSetType() , getUpdateCount sample code for java.sql.Statement.getUpdateCount() definition code for java.sql.Statement.getUpdateCount() , getWarnings sample code for java.sql.Statement.getWarnings() definition code for java.sql.Statement.getWarnings() , setCursorName sample code for java.sql.Statement.setCursorName(java.lang.String) definition code for java.sql.Statement.setCursorName(java.lang.String) , setEscapeProcessing sample code for java.sql.Statement.setEscapeProcessing(boolean) definition code for java.sql.Statement.setEscapeProcessing(boolean) , setFetchDirection sample code for java.sql.Statement.setFetchDirection(int) definition code for java.sql.Statement.setFetchDirection(int) , setFetchSize sample code for java.sql.Statement.setFetchSize(int) definition code for java.sql.Statement.setFetchSize(int) , setMaxFieldSize sample code for java.sql.Statement.setMaxFieldSize(int) definition code for java.sql.Statement.setMaxFieldSize(int) , setMaxRows sample code for java.sql.Statement.setMaxRows(int) definition code for java.sql.Statement.setMaxRows(int) , setQueryTimeout sample code for java.sql.Statement.setQueryTimeout(int) definition code for java.sql.Statement.setQueryTimeout(int)
 

Method Detail

executeQuery sample code for java.sql.PreparedStatement.executeQuery() definition code for java.sql.PreparedStatement.executeQuery()

ResultSet sample code for java.sql.ResultSet definition code for java.sql.ResultSet  executeQuery()
                       throws SQLException sample code for java.sql.SQLException definition code for java.sql.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 sample code for java.sql.SQLException definition code for java.sql.SQLException - if a database access error occurs or the SQL statement does not return a ResultSet object

executeUpdate sample code for java.sql.PreparedStatement.executeUpdate() definition code for java.sql.PreparedStatement.executeUpdate()

int executeUpdate()
                  throws SQLException sample code for java.sql.SQLException definition code for java.sql.SQLException 
Executes the SQL statement in this PreparedStatement object, which must be an SQL INSERT, UPDATE or DELETE statement; or an SQL statement that returns nothing, such as a DDL statement.

Returns:
either (1) the row count for INSERT, UPDATE, or DELETE statements or (2) 0 for SQL statements that return nothing
Throws:
SQLException sample code for java.sql.SQLException definition code for java.sql.SQLException - if a database access error occurs or the SQL statement returns a ResultSet object

setNull sample code for java.sql.PreparedStatement.setNull(int, int) definition code for java.sql.PreparedStatement.setNull(int, int)

void setNull(int parameterIndex,
             int sqlType)
             throws SQLException sample code for java.sql.SQLException definition code for java.sql.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 sample code for java.sql.SQLException definition code for java.sql.SQLException - if a database access error occurs

setBoolean sample code for java.sql.PreparedStatement.setBoolean(int, boolean) definition code for java.sql.PreparedStatement.setBoolean(int, boolean)

void setBoolean(int parameterIndex,
                boolean x)
                throws SQLException sample code for java.sql.SQLException definition code for java.sql.SQLException 
Sets the designated parameter to the given Java boolean value. The driver converts this to an SQL BIT value when it sends it to the database.

Parameters:
parameterIndex - the first parameter is 1, the second is 2, ...
x - the parameter value
Throws:
SQLException sample code for java.sql.SQLException definition code for java.sql.SQLException - if a database access error occurs

setByte sample code for java.sql.PreparedStatement.setByte(int, byte) definition code for java.sql.PreparedStatement.setByte(int, byte)

void setByte(int parameterIndex,
             byte x)
             throws SQLException sample code for java.sql.SQLException definition code for java.sql.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 sample code for java.sql.SQLException definition code for java.sql.SQLException - if a database access error occurs

setShort sample code for java.sql.PreparedStatement.setShort(int, short) definition code for java.sql.PreparedStatement.setShort(int, short)

void setShort(int parameterIndex,
              short x)
              throws SQLException sample code for java.sql.SQLException definition code for java.sql.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 sample code for java.sql.SQLException definition code for java.sql.SQLException - if a database access error occurs

setInt sample code for java.sql.PreparedStatement.setInt(int, int) definition code for java.sql.PreparedStatement.setInt(int, int)

void setInt(int parameterIndex,
            int x)
            throws SQLException sample code for java.sql.SQLException definition code for java.sql.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 sample code for java.sql.SQLException definition code for java.sql.SQLException - if a database access error occurs

setLong sample code for java.sql.PreparedStatement.setLong(int, long) definition code for java.sql.PreparedStatement.setLong(int, long)

void setLong(int parameterIndex,
             long x)
             throws SQLException sample code for java.sql.SQLException definition code for java.sql.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 sample code for java.sql.SQLException definition code for java.sql.SQLException - if a database access error occurs

setFloat sample code for java.sql.PreparedStatement.setFloat(int, float) definition code for java.sql.PreparedStatement.setFloat(int, float)

void setFloat(int parameterIndex,
              float x)
              throws SQLException sample code for java.sql.SQLException definition code for java.sql.SQLException 
Sets the designated parameter to the given Java float value. The driver converts this to an SQL FLOAT value when it sends it to the database.

Parameters:
parameterIndex - the first parameter is 1, the second is 2, ...
x - the parameter value
Throws:
SQLException sample code for java.sql.SQLException definition code for java.sql.SQLException - if a database access error occurs

setDouble sample code for java.sql.PreparedStatement.setDouble(int, double) definition code for java.sql.PreparedStatement.setDouble(int, double)

void setDouble(int parameterIndex,
               double x)
               throws SQLException sample code for java.sql.SQLException definition code for java.sql.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 sample code for java.sql.SQLException definition code for java.sql.SQLException - if a database access error occurs

setBigDecimal sample code for java.sql.PreparedStatement.setBigDecimal(int, java.math.BigDecimal) definition code for java.sql.PreparedStatement.setBigDecimal(int, java.math.BigDecimal)

void setBigDecimal(int parameterIndex,
                   BigDecimal sample code for java.math.BigDecimal definition code for java.math.BigDecimal  x)
                   throws SQLException sample code for java.sql.SQLException definition code for java.sql.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 sample code for java.sql.SQLException definition code for java.sql.SQLException - if a database access error occurs

setString sample code for java.sql.PreparedStatement.setString(int, java.lang.String) definition code for java.sql.PreparedStatement.setString(int, java.lang.String)

void setString(int parameterIndex,
               String sample code for java.lang.String definition code for java.lang.String  x)
               throws SQLException sample code for java.sql.SQLException definition code for java.sql.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 sample code for java.sql.SQLException definition code for java.sql.SQLException - if a database access error occurs

setBytes sample code for java.sql.PreparedStatement.setBytes(int, byte[]) definition code for java.sql.PreparedStatement.setBytes(int, byte[])

void setBytes(int parameterIndex,
              byte[] x)
              throws SQLException sample code for java.sql.SQLException definition code for java.sql.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 sample code for java.sql.SQLException definition code for java.sql.SQLException - if a database access error occurs

setDate sample code for java.sql.PreparedStatement.setDate(int, java.sql.Date) definition code for java.sql.PreparedStatement.setDate(int, java.sql.Date)

void setDate(int parameterIndex,
             Date sample code for java.sql.Date definition code for java.sql.Date  x)
             throws SQLException sample code for java.sql.SQLException definition code for java.sql.SQLException 
Sets the designated parameter to the given java.sql.Date value. The driver converts this to an SQL DATE value when it sends it to the database.

Parameters:
parameterIndex - the first parameter is 1, the second is 2, ...
x - the parameter value
Throws:
SQLException sample code for java.sql.SQLException definition code for java.sql.SQLException - if a database access error occurs

setTime sample code for java.sql.PreparedStatement.setTime(int, java.sql.Time) definition code for java.sql.PreparedStatement.setTime(int, java.sql.Time)

void setTime(int parameterIndex,
             Time sample code for java.sql.Time definition code for java.sql.Time  x)
             throws SQLException sample code for java.sql.SQLException definition code for java.sql.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 sample code for java.sql.SQLException definition code for java.sql.SQLException - if a database access error occurs

setTimestamp sample code for java.sql.PreparedStatement.setTimestamp(int, java.sql.Timestamp) definition code for java.sql.PreparedStatement.setTimestamp(int, java.sql.Timestamp)

void setTimestamp(int parameterIndex,
                  Timestamp sample code for java.sql.Timestamp definition code for java.sql.Timestamp  x)
                  throws SQLException sample code for java.sql.SQLException definition code for java.sql.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 sample code for java.sql.SQLException definition code for java.sql.SQLException - if a database access error occurs

setAsciiStream sample code for java.sql.PreparedStatement.setAsciiStream(int, java.io.InputStream, int) definition code for java.sql.PreparedStatement.setAsciiStream(int, java.io.InputStream, int)

void setAsciiStream(int parameterIndex,
                    InputStream sample code for java.io.InputStream definition code for java.io.InputStream  x,
                    int length)
                    throws SQLException sample code for java.sql.SQLException definition code for java.sql.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 sample code for java.sql.SQLException definition code for java.sql.SQLException - if a database access error occurs

setUnicodeStream sample code for java.sql.PreparedStatement.setUnicodeStream(int, java.io.InputStream, int) definition code for java.sql.PreparedStatement.setUnicodeStream(int, java.io.InputStream, int)

@Deprecated
void setUnicodeStream(int parameterIndex,
                                 InputStream sample code for java.io.InputStream definition code for java.io.InputStream  x,
                                 int length)
                      throws SQLException sample code for java.sql.SQLException definition code for java.sql.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.

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 sample code for java.sql.SQLException definition code for java.sql.SQLException - if a database access error occurs

setBinaryStream sample code for java.sql.PreparedStatement.setBinaryStream(int, java.io.InputStream, int) definition code for java.sql.PreparedStatement.setBinaryStream(int, java.io.InputStream, int)

void setBinaryStream(int parameterIndex,
                     InputStream sample code for java.io.InputStream definition code for java.io.InputStream  x,
                     int length)
                     throws SQLException sample code for java.sql.SQLException definition code for java.sql.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 sample code for java.sql.SQLException definition code for java.sql.SQLException - if a database access error occurs

clearParameters sample code for java.sql.PreparedStatement.clearParameters() definition code for java.sql.PreparedStatement.clearParameters()

void clearParameters()
                     throws SQLException sample code for java.sql.SQLException definition code for java.sql.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 sample code for java.sql.SQLException definition code for java.sql.SQLException - if a database access error occurs

setObject sample code for java.sql.PreparedStatement.setObject(int, java.lang.Object, int, int) definition code for java.sql.PreparedStatement.setObject(int, java.lang.Object, int, int)

void setObject(int parameterIndex,
               Object sample code for java.lang.Object definition code for java.lang.Object  x,
               int targetSqlType,
               int scale)
               throws SQLException sample code for java.sql.SQLException definition code for java.sql.SQLException 

Sets the value of the designated parameter with the given object. The second argument must be an object type; for integral values, the java.lang equivalent objects should be used.

The given Java object will be converted to the given targetSqlType before being sent to the database. If the object has a custom mapping (is of a class implementing the interface SQLData), the JDBC driver should call the method SQLData.writeSQL to write it to the SQL data stream. If, on the other hand, the object is of a class implementing Ref, Blob, Clob, Struct, or Array, the driver should pass it to the database as a value of the corresponding SQL type.

Note that this method may be used to pass 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.
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 sample code for java.sql.SQLException definition code for java.sql.SQLException - if a database access error occurs
See Also:
Types sample code for java.sql.Types definition code for java.sql.Types

setObject sample code for java.sql.PreparedStatement.setObject(int, java.lang.Object, int) definition code for java.sql.PreparedStatement.setObject(int, java.lang.Object, int)

void setObject(int parameterIndex,
               Object sample code for java.lang.Object definition code for java.lang.Object  x,
               int targetSqlType)
               throws SQLException sample code for java.sql.SQLException definition code for java.sql.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.

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 sample code for java.sql.SQLException definition code for java.sql.SQLException - if a database access error occurs

setObject sample code for java.sql.PreparedStatement.setObject(int, java.lang.Object) definition code for java.sql.PreparedStatement.setObject(int, java.lang.Object)

void setObject(int parameterIndex,
               Object sample code for java.lang.Object definition code for java.lang.Object  x)
               throws SQLException sample code for java.sql.SQLException definition code for java.sql.SQLException 

Sets the value of the designated parameter using the given object. The second parameter must be of type Object; therefore, the java.lang equivalent objects should be used for built-in types.

The JDBC specification specifies a standard mapping from Java Object types to SQL types. The given argument will be converted to the corresponding SQL type before being sent to the database.

Note that this method may be used to pass datatabase- specific abstract data types, by using a driver-specific Java type. If the object is of a class implementing the interface SQLData, the JDBC driver should call the method SQLData.writeSQL to write it to the SQL data stream. If, on the other hand, the object is of a class implementing Ref, Blob, Clob, Struct, or Array, 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
Throws:
SQLException sample code for java.sql.SQLException definition code for java.sql.SQLException - if a database access error occurs or the type of the given object is ambiguous

execute sample code for java.sql.PreparedStatement.execute() definition code for java.sql.PreparedStatement.execute()

boolean execute()
                throws SQLException sample code for java.sql.SQLException definition code for java.sql.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).

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 sample code for java.sql.SQLException definition code for java.sql.SQLException - if a database access error occurs or an argument is supplied to this method
See Also:
Statement.execute(java.lang.String) sample code for java.sql.Statement.execute(java.lang.String) definition code for java.sql.Statement.execute(java.lang.String) , Statement.getResultSet() sample code for java.sql.Statement.getResultSet() definition code for java.sql.Statement.getResultSet() , Statement.getUpdateCount() sample code for java.sql.Statement.getUpdateCount() definition code for java.sql.Statement.getUpdateCount() , Statement.getMoreResults() sample code for java.sql.Statement.getMoreResults() definition code for java.sql.Statement.getMoreResults()

addBatch sample code for java.sql.PreparedStatement.addBatch() definition code for java.sql.PreparedStatement.addBatch()

void addBatch()
              throws SQLException sample code for java.sql.SQLException definition code for java.sql.SQLException 
Adds a set of parameters to this PreparedStatement object's batch of commands.

Throws:
SQLException sample code for java.sql.SQLException definition code for java.sql.SQLException - if a database access error occurs
Since:
1.2
See Also:
Statement.addBatch(java.lang.String) sample code for java.sql.Statement.addBatch(java.lang.String) definition code for java.sql.Statement.addBatch(java.lang.String)

setCharacterStream sample code for java.sql.PreparedStatement.setCharacterStream(int, java.io.Reader, int) definition code for java.sql.PreparedStatement.setCharacterStream(int, java.io.Reader, int)

void setCharacterStream(int parameterIndex,
                        Reader sample code for java.io.Reader definition code for java.io.Reader  reader,
                        int length)
                        throws SQLException sample code for java.sql.SQLException definition code for java.sql.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.

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 sample code for java.sql.SQLException definition code for java.sql.SQLException - if a database access error occurs
Since:
1.2

setRef sample code for java.sql.PreparedStatement.setRef(int, java.sql.Ref) definition code for java.sql.PreparedStatement.setRef(int, java.sql.Ref)

void setRef(int i,
            Ref sample code for java.sql.Ref definition code for java.sql.Ref  x)
            throws SQLException sample code for java.sql.SQLException definition code for java.sql.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.

Parameters:
i - the first parameter is 1, the second is 2, ...
x - an SQL REF value
Throws:
SQLException sample code for java.sql.SQLException definition code for java.sql.SQLException - if a database access error occurs
Since:
1.2

setBlob sample code for java.sql.PreparedStatement.setBlob(int, java.sql.Blob) definition code for java.sql.PreparedStatement.setBlob(int, java.sql.Blob)

void setBlob(int i,
             Blob sample code for java.sql.Blob definition code for java.sql.Blob  x)
             throws SQLException sample code for java.sql.SQLException definition code for java.sql.SQLException 
Sets the designated parameter to the given Blob object. The driver converts this to an SQL BLOB value when it sends it to the database.

Parameters:
i - the first parameter is 1, the second is 2, ...
x - a Blob object that maps an SQL BLOB value
Throws:
SQLException sample code for java.sql.SQLException definition code for java.sql.SQLException - if a database access error occurs
Since:
1.2

setClob sample code for java.sql.PreparedStatement.setClob(int, java.sql.Clob) definition code for java.sql.PreparedStatement.setClob(int, java.sql.Clob)

void setClob(int i,
             Clob sample code for java.sql.Clob definition code for java.sql.Clob  x)
             throws SQLException sample code for java.sql.SQLException definition code for java.sql.SQLException 
Sets the designated parameter to the given Clob object. The driver converts this to an SQL CLOB value when it sends it to the database.

Parameters:
i - the first parameter is 1, the second is 2, ...
x - a Clob object that maps an SQL CLOB value
Throws:
SQLException sample code for java.sql.SQLException definition code for java.sql.SQLException - if a database access error occurs
Since:
1.2

setArray sample code for java.sql.PreparedStatement.setArray(int, java.sql.Array) definition code for java.sql.PreparedStatement.setArray(int, java.sql.Array)

void setArray(int i,
              Array sample code for java.sql.Array definition code for java.sql.Array  x)
              throws SQLException sample code for java.sql.SQLException definition code for java.sql.SQLException 
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.

Parameters:
i - the first parameter is 1, the second is 2, ...
x - an Array object that maps an SQL ARRAY value
Throws:
SQLException sample code for java.sql.SQLException definition code for java.sql.SQLException - if a database access error occurs
Since:
1.2

getMetaData sample code for java.sql.PreparedStatement.getMetaData() definition code for java.sql.PreparedStatement.getMetaData()

ResultSetMetaData sample code for java.sql.ResultSetMetaData definition code for java.sql.ResultSetMetaData  getMetaData()
                              throws SQLException sample code for java.sql.SQLException definition code for java.sql.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.

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 sample code for java.sql.SQLException definition code for java.sql.SQLException - if a database access error occurs
Since:
1.2

setDate sample code for java.sql.PreparedStatement.setDate(int, java.sql.Date, java.util.Calendar) definition code for java.sql.PreparedStatement.setDate(int, java.sql.Date, java.util.Calendar)

void setDate(int parameterIndex,
             Date sample code for java.sql.Date definition code for java.sql.Date  x,
             Calendar sample code for java.util.Calendar definition code for java.util.Calendar  cal)
             throws SQLException sample code for java.sql.SQLException definition code for java.sql.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.

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 sample code for java.sql.SQLException definition code for java.sql.SQLException - if a database access error occurs
Since:
1.2

setTime sample code for java.sql.PreparedStatement.setTime(int, java.sql.Time, java.util.Calendar) definition code for java.sql.PreparedStatement.setTime(int, java.sql.Time, java.util.Calendar)

void setTime(int parameterIndex,
             Time sample code for java.sql.Time definition code for java.sql.Time  x,
             Calendar sample code for java.util.Calendar definition code for java.util.Calendar  cal)
             throws SQLException sample code for java.sql.SQLException definition code for java.sql.SQLException 
Sets the designated parameter to the given java.sql.Time value, using the given Calendar object. The driver uses the Calendar object to construct an SQL TIME value, which the driver then sends to the database. With a Calendar object, the driver can calculate the time taking into account a custom timezone. If no Calendar object is specified, the driver uses the default timezone, which is that of the virtual machine running the application.

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
Throws:
SQLException sample code for java.sql.SQLException definition code for java.sql.SQLException - if a database access error occurs
Since:
1.2

setTimestamp sample code for java.sql.PreparedStatement.setTimestamp(int, java.sql.Timestamp, java.util.Calendar) definition code for java.sql.PreparedStatement.setTimestamp(int, java.sql.Timestamp, java.util.Calendar)

void setTimestamp(int parameterIndex,
                  Timestamp sample code for java.sql.Timestamp definition code for java.sql.Timestamp  x,
                  Calendar sample code for java.util.Calendar definition code for java.util.Calendar  cal)
                  throws SQLException sample code for java.sql.SQLException definition code for java.sql.SQLException 
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.

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
Throws:
SQLException sample code for java.sql.SQLException definition code for java.sql.SQLException - if a database access error occurs
Since:
1.2

setNull sample code for java.sql.PreparedStatement.setNull(int, int, java.lang.String) definition code for java.sql.PreparedStatement.setNull(int, int, java.lang.String)

void setNull(int paramIndex,
             int sqlType,
             String sample code for java.lang.String definition code for java.lang.String  typeName)
             throws SQLException sample code for java.sql.SQLException definition code for java.sql.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.

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:
paramIndex - the first parameter is 1, the second is 2, ...
sqlType - a value from java.sql.Types
typeName - the fully-qualified name of an SQL user-defined type; ignored if the parameter is not a user-defined type or REF
Throws:
SQLException sample code for java.sql.SQLException definition code for java.sql.SQLException - if a database access error occurs
Since:
1.2

setURL sample code for java.sql.PreparedStatement.setURL(int, java.net.URL) definition code for java.sql.PreparedStatement.setURL(int, java.net.URL)

void setURL(int parameterIndex,
            URL sample code for java.net.URL definition code for java.net.URL  x)
            throws SQLException sample code for java.sql.SQLException definition code for java.sql.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.

Parameters:
parameterIndex - the first parameter is 1, the second is 2, ...
x - the java.net.URL object to be set
Throws:
SQLException sample code for java.sql.SQLException definition code for java.sql.SQLException - if a database access error occurs
Since:
1.4

getParameterMetaData sample code for java.sql.PreparedStatement.getParameterMetaData() definition code for java.sql.PreparedStatement.getParameterMetaData()

ParameterMetaData sample code for java.sql.ParameterMetaData definition code for java.sql.ParameterMetaData  getParameterMetaData()
                                       throws SQLException sample code for java.sql.SQLException definition code for java.sql.SQLException 
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 of this PreparedStatement object's parameters
Throws:
SQLException sample code for java.sql.SQLException definition code for java.sql.SQLException - if a database access error occurs
Since:
1.4
See Also:
ParameterMetaData sample code for java.sql.ParameterMetaData definition code for java.sql.ParameterMetaData