Contents | Package | Class | Tree | Deprecated | Index | Help Java 1.2 Beta 3
PREV | NEXT SHOW LISTS | HIDE LISTS

Interface java.sql.PreparedStatement

Subinterfaces:
CallableStatement

public interface PreparedStatement
extends Statement

A SQL statement is pre-compiled and stored in a PreparedStatement object. This object can then be used to efficiently execute this statement multiple times.

Note: The setXXX methods for setting IN parameter values must specify types that are compatible with the defined SQL type of the input parameter. For instance, if the IN parameter has SQL type Integer then setInt should be used.

If arbitrary parameter type conversions are required then the setObject method should be used with a target SQL type.

See Also:
prepareStatement, ResultSet

Method Summary
void  addBatch()
JDBC 2.0 Add a set of parameters to the batch.
void  clearParameters()

In general, parameter values remain in force for repeated use of a Statement.

boolean  execute()
Some prepared statements return multiple results; the execute method handles these complex statements as well as the simpler form of statements handled by executeQuery and executeUpdate.
ResultSet  executeQuery()
A prepared SQL query is executed and its ResultSet is returned.
int  executeUpdate()
Execute a SQL INSERT, UPDATE or DELETE statement.
void  setArrayLocator(int i, ArrayLocator x)
Set a LOCATOR(<array>) parameter.
void  setAsciiStream(int parameterIndex, InputStream x, int length)
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.
void  setBigDecimal(int parameterIndex, BigDecimal x)
Set a parameter to a java.math.BigDecimal value.
void  setBinaryStream(int parameterIndex, InputStream x, int length)
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.
void  setBlobLocator(int i, BlobLocator x)
Set a LOCATOR(BLOB) parameter.
void  setBoolean(int parameterIndex, boolean x)
Set a parameter to a Java boolean value.
void  setByte(int parameterIndex, byte x)
Set a parameter to a Java byte value.
void  setBytes(int parameterIndex, byte[] x)
Set a parameter to a Java array of bytes.
void  setCharacterStream(int parameterIndex, Reader reader, int length)
JDBC 2.0 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.
void  setClobLocator(int i, ClobLocator x)
Set a LOCATOR(CLOB) parameter.
void  setDate(int parameterIndex, Date x)
Set a parameter to a java.sql.Date value.
void  setDouble(int parameterIndex, double x)
Set a parameter to a Java double value.
void  setFloat(int parameterIndex, float x)
Set a parameter to a Java float value.
void  setInt(int parameterIndex, int x)
Set a parameter to a Java int value.
void  setLong(int parameterIndex, long x)
Set a parameter to a Java long value.
void  setNull(int parameterIndex, int sqlType)
Set a parameter to SQL NULL.
void  setObject(int parameterIndex, Object x, int targetSqlType, int scale)

Set the value of a parameter using an object; use the java.lang equivalent objects for integral values.

void  setObject(int parameterIndex, Object x, int targetSqlType)
This method is like setObject above, but assumes a scale of zero.
void  setObject(int parameterIndex, Object x)

Set the value of a parameter using an object; use the java.lang equivalent objects for integral values.

void  setRef(int i, Ref x)
Set a REF(<structured-type>) parameter.
void  setShort(int parameterIndex, short x)
Set a parameter to a Java short value.
void  setString(int parameterIndex, String x)
Set a parameter to a Java String value.
void  setStructLocator(int i, StructLocator x)
Set a LOCATOR(<structured-type>) parameter.
void  setTime(int parameterIndex, Time x)
Set a parameter to a java.sql.Time value.
void  setTimestamp(int parameterIndex, Timestamp x)
Set a parameter to a java.sql.Timestamp value.
void  setUnicodeStream(int parameterIndex, InputStream x, int length)
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. Deprecated
 

Method Detail

executeQuery

public ResultSet executeQuery() throws SQLException
A prepared SQL query is executed and its ResultSet is returned.
Implements:
executeQuery in interface Statement
Returns:
a ResultSet that contains the data produced by the query; never null
Throws:
SQLException - if a database-access error occurs.

executeUpdate

public int executeUpdate() throws SQLException
Execute a SQL INSERT, UPDATE or DELETE statement. In addition, SQL statements that return nothing such as SQL DDL statements can be executed.
Implements:
executeUpdate in interface Statement
Returns:
either the row count for INSERT, UPDATE or DELETE; or 0 for SQL statements that return nothing
Throws:
SQLException - if a database-access error occurs.

setNull

public void setNull(int parameterIndex,
                    int sqlType) throws SQLException
Set a 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 - SQL type code defined by java.sql.Types
Throws:
SQLException - if a database-access error occurs.

setBoolean

public void setBoolean(int parameterIndex,
                       boolean x) throws SQLException
Set a parameter to a Java boolean value. The driver converts this to a 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 - if a database-access error occurs.

setByte

public void setByte(int parameterIndex,
                    byte x) throws SQLException
Set a parameter to a Java byte value. The driver converts this to a 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

public void setShort(int parameterIndex,
                     short x) throws SQLException
Set a parameter to a Java short value. The driver converts this to a 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

public void setInt(int parameterIndex,
                   int x) throws SQLException
Set a parameter to a Java int value. The driver converts this to a 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

public void setLong(int parameterIndex,
                    long x) throws SQLException
Set a parameter to a Java long value. The driver converts this to a 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

public void setFloat(int parameterIndex,
                     float x) throws SQLException
Set a parameter to a Java float value. The driver converts this to a 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 - if a database-access error occurs.

setDouble

public void setDouble(int parameterIndex,
                      double x) throws SQLException
Set a parameter to a Java double value. The driver converts this to a 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

public void setBigDecimal(int parameterIndex,
                          BigDecimal x) throws SQLException
Set a parameter to a java.math.BigDecimal value. The driver converts this to a 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

public void setString(int parameterIndex,
                      String x) throws SQLException
Set a parameter to a Java String value. The driver converts this to a SQL VARCHAR or LONGVARCHAR value (depending on the arguments size relative to the driver's limits on VARCHARs) 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

public void setBytes(int parameterIndex,
                     byte[] x) throws SQLException
Set a parameter to a Java array of bytes. The driver converts this to a SQL VARBINARY or LONGVARBINARY (depending on the argument's size relative to the driver's limits on VARBINARYs) 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

public void setDate(int parameterIndex,
                    Date x) throws SQLException
Set a parameter to a java.sql.Date value. The driver converts this to a 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

public void setTime(int parameterIndex,
                    Time x) throws SQLException
Set a parameter to a java.sql.Time value. The driver converts this to a 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

public void setTimestamp(int parameterIndex,
                         Timestamp x) throws SQLException
Set a parameter to a java.sql.Timestamp value. The driver converts this to a 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

public void setAsciiStream(int parameterIndex,
                           InputStream x,
                           int length) throws SQLException
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. JDBC will read the data from the stream as needed, until it reaches end-of-file. The JDBC driver will do any necessary conversion from 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 which contains the ASCII parameter value
length - the number of bytes in the stream
Throws:
SQLException - if a database-access error occurs.

setUnicodeStream

public void setUnicodeStream(int parameterIndex,
                             InputStream x,
                             int length) throws SQLException
Note: setUnicodeStream() is deprecated.

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. JDBC will read the data from the stream as needed, until it reaches end-of-file. The JDBC driver will do any necessary conversion from UNICODE to the database char format.

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

Parameters:
parameterIndex - the first parameter is 1, the second is 2, ...
x - the java input stream which contains the UNICODE parameter value
length - the number of bytes in the stream
Throws:
SQLException - if a database-access error occurs.

setBinaryStream

public void setBinaryStream(int parameterIndex,
                            InputStream x,
                            int length) throws SQLException
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. JDBC will read the data from the stream as needed, until it reaches end-of-file.

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

public void clearParameters() throws SQLException

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

Throws:
SQLException - if a database-access error occurs.

setObject

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

Set the value of a parameter using an object; use the java.lang equivalent objects for integral values.

The given Java object will be converted to the targetSqlType before being sent to the database.

Note that this method may be used to pass datatabase- specific abstract data types. This is done by using a Driver- specific Java type and using a targetSqlType of java.sql.types.OTHER.

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. For all other types this value will be ignored,
Throws:
SQLException - if a database-access error occurs.
See Also:
Types

setObject

public void setObject(int parameterIndex,
                      Object x,
                      int targetSqlType) throws SQLException
This method is like setObject above, but assumes a scale of zero.
Throws:
SQLException - if a database-access error occurs.

setObject

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

Set the value of a parameter using an object; use the java.lang equivalent objects for integral values.

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

Note that this method may be used to pass datatabase specific abstract data types, by using a Driver specific Java type.

Parameters:
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.

execute

public boolean execute() throws SQLException
Some prepared statements return multiple results; the execute method handles these complex statements as well as the simpler form of statements handled by executeQuery and executeUpdate.
Implements:
execute in interface Statement
Throws:
SQLException - if a database-access error occurs.
See Also:
execute

addBatch

public void addBatch() throws SQLException
JDBC 2.0 Add a set of parameters to the batch.
Implements:
addBatch in interface Statement
Throws:
SQLException - if a database-access error occurs.
See Also:
addBatch

setCharacterStream

public void setCharacterStream(int parameterIndex,
                               Reader reader,
                               int length) throws SQLException
JDBC 2.0 When a very large UNICODE value is input to a LONGVARCHAR parameter, it may be more practical to send it via a java.io.Reader. JDBC will read the data from the stream as needed, until it reaches end-of-file. The JDBC driver will do any necessary conversion from UNICODE to the database char format.

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

Parameters:
parameterIndex - the first parameter is 1, the second is 2, ...
x - the java reader which contains the UNICODE data
length - the number of characters in the stream
Throws:
SQLException - if a database-access error occurs.

setRef

public void setRef(int i,
                   Ref x) throws SQLException
Set a REF(<structured-type>) parameter.
Parameters:
i - the first parameter is 1, the second is 2, ...
x - an object representing data of an SQL REF Type

setBlobLocator

public void setBlobLocator(int i,
                           BlobLocator x) throws SQLException
Set a LOCATOR(BLOB) parameter.
Parameters:
i - the first parameter is 1, the second is 2, ...
x - an object representing data of a locator to a BLOB

setClobLocator

public void setClobLocator(int i,
                           ClobLocator x) throws SQLException
Set a LOCATOR(CLOB) parameter.
Parameters:
i - the first parameter is 1, the second is 2, ...
x - an object representing data of a locator to a CLOB

setStructLocator

public void setStructLocator(int i,
                             StructLocator x) throws SQLException
Set a LOCATOR(<structured-type>) parameter.
Parameters:
i - the first parameter is 1, the second is 2, ...
x - an object representing data of a locator to an instance of a Structured Type

setArrayLocator

public void setArrayLocator(int i,
                            ArrayLocator x) throws SQLException
Set a LOCATOR(<array>) parameter.
Parameters:
i - the first parameter is 1, the second is 2, ...
x - an object representing data of a locator to an SQL array

Contents | Package | Class | Tree | Deprecated | Index | Help Java 1.2 Beta 3
PREV | NEXT SHOW LISTS | HIDE LISTS

Submit a bug or feature
Submit comments/suggestions about new javadoc look.
Java is a trademark or registered trademark of Sun Microsystems, Inc. in the US and other countries.
Copyright 1993-1998 Sun Microsystems, Inc. 901 San Antonio Road, Palo Alto, California, 94303, U.S.A. All Rights Reserved.