Help >

: Class PreparedStatement

Version 7.11

com.wham.jdbc
Class PreparedStatement

java.lang.Object
  |
  +--com.wham.jdbc.PreparedStatement

public class PreparedStatement

extends java.lang.Object

implements java.sql.PreparedStatement

An object that represents a precompiled SQL statement. This class is not implemented. Creation date: (11/21/2002 11:25:45 AM)

Constructor Summary

PreparedStatement(Connection conn, java.lang.String sql)
PreparedStatement constructor comment.

Method Summary

void	addBatch() JDBC 2.0 Adds a set of parameters to the batch.
void	addBatch(java.lang.String sql) JDBC 2.0 Adds a SQL command to the current batch of commmands for the statement.
void	cancel() Cancels this Statement object if both the DBMS and driver support aborting an SQL statement.
void	clearBatch() JDBC 2.0 Makes the set of commands in the current batch empty.
void	clearParameters() Clears the current parameter values immediately.
void	clearWarnings() Clears all the warnings reported on this Statement object.
void	close() Releases this Statement object's database and JDBC resources immediately instead of waiting for this to happen when it is automatically closed.
boolean	execute() Executes any kind of SQL statement.
boolean	execute(java.lang.String sql) Executes a SQL statement that may return multiple results.
int[]	executeBatch() JDBC 2.0 Submits a batch of commands to the database for execution.
java.sql.ResultSet	executeQuery() Executes the SQL query in this PreparedStatement object and returns the result set generated by the query.
java.sql.ResultSet	executeQuery(java.lang.String sql) Executes a SQL statement that returns a single ResultSet.
int	executeUpdate() Executes the SQL INSERT, UPDATE or DELETE statement in this PreparedStatement object.
int	executeUpdate(java.lang.String sql) Executes an SQL INSERT, UPDATE or DELETE statement.
java.sql.Connection	getConnection() JDBC 2.0 Returns the Connection object that produced this Statement object.
int	getFetchDirection() JDBC 2.0 Retrieves the direction for fetching rows from database tables that is the default for result sets generated from this Statement object.
int	getFetchSize() JDBC 2.0 Retrieves the number of result set rows that is the default fetch size for result sets generated from this Statement object.
int	getMaxFieldSize() Returns the maximum number of bytes allowed for any column value.
int	getMaxRows() Retrieves the maximum number of rows that a ResultSet can contain.
java.sql.ResultSetMetaData	getMetaData() JDBC 2.0 Gets the number, types and properties of a ResultSet's columns.
boolean	getMoreResults() Moves to a Statement's next result.
int	getQueryTimeout() Retrieves the number of seconds the driver will wait for a Statement to execute.
java.sql.ResultSet	getResultSet() Returns the current result as a ResultSet object.
int	getResultSetConcurrency() JDBC 2.0 Retrieves the result set concurrency.
int	getResultSetType() JDBC 2.0 Determine the result set type.
int	getUpdateCount() Returns the current result as an update count; if the result is a ResultSet or there are no more results, -1 is returned.
java.sql.SQLWarning	getWarnings() Retrieves the first warning reported by calls on this Statement.
void	setArray(int i, java.sql.Array x) JDBC 2.0 Sets an Array parameter.
void	setAsciiStream(int parameterIndex, java.io.InputStream x, int length) Sets the designated parameter to the given input stream, which will have the specified number of bytes.
void	setBigDecimal(int parameterIndex, java.math.BigDecimal x) Sets the designated parameter to a java.lang.BigDecimal value.
void	setBinaryStream(int parameterIndex, java.io.InputStream x, int length) Sets the designated parameter to the given input stream, which will have the specified number of bytes.
void	setBlob(int i, java.sql.Blob x) JDBC 2.0 Sets a BLOB parameter.
void	setBoolean(int parameterIndex, boolean x) Sets the designated parameter to a Java boolean value.
void	setByte(int parameterIndex, byte x) Sets the designated parameter to a Java byte value.
void	setBytes(int parameterIndex, byte[] x) Sets the designated parameter to a Java array of bytes.
void	setCharacterStream(int parameterIndex, java.io.Reader reader, int length) JDBC 2.0 Sets the designated parameter to the given Reader object, which is the given number of characters long.
void	setClob(int i, java.sql.Clob x) JDBC 2.0 Sets a CLOB parameter.
void	setCursorName(java.lang.String name) Defines the SQL cursor name that will be used by subsequent Statement execute methods.
void	setDate(int parameterIndex, java.sql.Date x) Sets the designated parameter to a java.sql.Date value.
void	setDate(int parameterIndex, java.sql.Date x, java.util.Calendar cal) JDBC 2.0 Sets the designated parameter to a java.sql.Date value, using the given Calendar object.
void	setDouble(int parameterIndex, double x) Sets the designated parameter to a Java double value.
void	setEscapeProcessing(boolean enable) Sets escape processing on or off.
void	setFetchDirection(int direction) JDBC 2.0 Gives the driver a hint as to the direction in which the rows in a result set will be processed.
void	setFetchSize(int rows) JDBC 2.0 Gives the JDBC driver a hint as to the number of rows that should be fetched from the database when more rows are needed.
void	setFloat(int parameterIndex, float x) Sets the designated parameter to a Java float value.
void	setInt(int parameterIndex, int x) Sets the designated parameter to a Java int value.
void	setLong(int parameterIndex, long x) Sets the designated parameter to a Java long value.
void	setMaxFieldSize(int max) Sets the limit for the maximum number of bytes in a column to the given number of bytes.
void	setMaxRows(int max) Sets the limit for the maximum number of rows that any ResultSet can contain to the given number.
void	setNull(int parameterIndex, int sqlType) Sets the designated parameter to SQL NULL.
void	setNull(int paramIndex, int sqlType, java.lang.String typeName) JDBC 2.0 Sets the designated parameter to SQL NULL.
void	setObject(int parameterIndex, java.lang.Object x) Sets the value of a parameter using an object; use the java.lang equivalent objects for integral values.
void	setObject(int parameterIndex, java.lang.Object x, int targetSqlType) Sets the value of the designated parameter with the given object.
void	setObject(int parameterIndex, java.lang.Object x, int targetSqlType, int scale) Sets the value of a parameter using an object.
void	setQueryTimeout(int seconds) Sets the number of seconds the driver will wait for a Statement to execute to the given number of seconds.
void	setRef(int i, java.sql.Ref x) JDBC 2.0 Sets a REF(<structured-type>) parameter.
void	setShort(int parameterIndex, short x) Sets the designated parameter to a Java short value.
void	setString(int parameterIndex, java.lang.String x) Sets the designated parameter to a Java String value.
void	setTime(int parameterIndex, java.sql.Time x) Sets the designated parameter to a java.sql.Time value.
void	setTime(int parameterIndex, java.sql.Time x, java.util.Calendar cal) JDBC 2.0 Sets the designated parameter to a java.sql.Time value, using the given Calendar object.
void	setTimestamp(int parameterIndex, java.sql.Timestamp x) Sets the designated parameter to a java.sql.Timestamp value.
void	setTimestamp(int parameterIndex, java.sql.Timestamp x, java.util.Calendar cal) JDBC 2.0 Sets the designated parameter to a java.sql.Timestamp value, using the given Calendar object.
void	setUnicodeStream(int parameterIndex, java.io.InputStream x, int length) Deprecated.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PreparedStatement

public PreparedStatement(Connection conn,
                         java.lang.String sql)
                  throws java.sql.SQLException

PreparedStatement constructor comment.

Method Detail

addBatch

public void addBatch()
              throws java.sql.SQLException

JDBC 2.0 Adds a set of parameters to the batch.

Specified by:

addBatch in interface java.sql.PreparedStatement

Throws:

java.sql.SQLException - if a database access error occurs

See Also:

Statement.addBatch(java.lang.String)

addBatch

public void addBatch(java.lang.String sql)
              throws java.sql.SQLException

JDBC 2.0 Adds a SQL command to the current batch of commmands for the statement. This method is optional.

Parameters:

sql - typically this is a static SQL INSERT or UPDATE statement

Throws:

java.sql.SQLException - if a database access error occurs, or the driver does not support batch statements

cancel

public void cancel()
            throws java.sql.SQLException

Cancels this Statement object if both the DBMS and driver support aborting an SQL statement. This method can be used by one thread to cancel a statement that is being executed by another thread.

Throws:

java.sql.SQLException - if a database access error occurs

clearBatch

public void clearBatch()
                throws java.sql.SQLException

JDBC 2.0 Makes the set of commands in the current batch empty. This method is optional.

Throws:

java.sql.SQLException - if a database access error occurs or the driver does not support batch statements

clearParameters

public void clearParameters()
                     throws 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 clearParameters.

Specified by:

clearParameters in interface java.sql.PreparedStatement

Throws:

java.sql.SQLException - if a database access error occurs

clearWarnings

public void clearWarnings()
                   throws java.sql.SQLException

Clears all the warnings reported on this Statement object. After a call to this method, the method getWarnings will return null until a new warning is reported for this Statement.

Throws:

java.sql.SQLException - if a database access error occurs

close

public void close()
           throws java.sql.SQLException

Releases this Statement object's database and JDBC resources immediately instead of waiting for this to happen when it is automatically closed. It is generally good practice to release resources as soon as you are finished with them to avoid tying up database resources.

Note: A Statement is automatically closed when it is garbage collected. When a Statement is closed, its current ResultSet, if one exists, is also closed.

Throws:

java.sql.SQLException - if a database access error occurs

execute

public boolean execute()
                throws java.sql.SQLException

Executes 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 executeQuery and executeUpdate.

Specified by:

execute in interface java.sql.PreparedStatement

Throws:

java.sql.SQLException - if a database access error occurs

See Also:

Statement.execute(java.lang.String)

execute

public boolean execute(java.lang.String sql)
                throws java.sql.SQLException

Executes a SQL statement that may return multiple results. Under some (uncommon) situations a single SQL statement may return multiple result sets and/or update counts. Normally you can ignore this unless you are (1) executing a stored procedure that you know may return multiple results or (2) you are dynamically executing an unknown SQL string. The methods execute, getMoreResults, getResultSet, and getUpdateCount let you navigate through multiple results. The execute method executes a SQL statement and indicates the form of the first result. You can then use getResultSet or getUpdateCount to retrieve the result, and getMoreResults to move to any subsequent result(s).

Parameters:

sql - any SQL statement

Returns:

true if the next result is a ResultSet; false if it is an update count or there are no more results

Throws:

java.sql.SQLException - if a database access error occurs

See Also:

getResultSet(), getUpdateCount(), getMoreResults()

executeBatch

public int[] executeBatch()
                   throws java.sql.SQLException

JDBC 2.0 Submits a batch of commands to the database for execution. This method is optional.

Returns:

an array of update counts containing one element for each command in the batch. The array is ordered according to the order in which commands were inserted into the batch.

Throws:

java.sql.SQLException - if a database access error occurs or the driver does not support batch statements

executeQuery

public java.sql.ResultSet executeQuery()
                                throws java.sql.SQLException

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

Specified by:

executeQuery in interface java.sql.PreparedStatement

Returns:

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

Throws:

java.sql.SQLException - if a database access error occurs

executeQuery

public java.sql.ResultSet executeQuery(java.lang.String sql)
                                throws java.sql.SQLException

Executes a SQL statement that returns a single ResultSet.

Parameters:

sql - typically this is a static SQL SELECT statement

Returns:

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

Throws:

java.sql.SQLException - if a database access error occurs

executeUpdate

public int executeUpdate()
                  throws java.sql.SQLException

Executes the SQL INSERT, UPDATE or DELETE statement in this PreparedStatement object. In addition, SQL statements that return nothing, such as SQL DDL statements, can be executed.

Specified by:

executeUpdate in interface java.sql.PreparedStatement

Returns:

either the row count for INSERT, UPDATE or DELETE statements; or 0 for SQL statements that return nothing

Throws:

java.sql.SQLException - if a database access error occurs

executeUpdate

public int executeUpdate(java.lang.String sql)
                  throws java.sql.SQLException

Executes an SQL INSERT, UPDATE or DELETE statement. In addition, SQL statements that return nothing, such as SQL DDL statements, can be executed.

Parameters:

sql - a SQL INSERT, UPDATE or DELETE statement or a SQL statement that returns nothing

Returns:

either the row count for INSERT, UPDATE or DELETE or 0 for SQL statements that return nothing

Throws:

java.sql.SQLException - if a database access error occurs

getConnection

public java.sql.Connection getConnection()
                                  throws java.sql.SQLException

JDBC 2.0 Returns the Connection object that produced this Statement object.

Returns:

the connection that produced this statement

Throws:

java.sql.SQLException - if a database access error occurs

getFetchDirection

public int getFetchDirection()
                      throws java.sql.SQLException

JDBC 2.0 Retrieves the direction for fetching rows from database tables that is the default for result sets generated from this Statement object. If this Statement object has not set a fetch direction by calling the method setFetchDirection, the return value is implementation-specific.

Returns:

the default fetch direction for result sets generated from this Statement object

Throws:

java.sql.SQLException - if a database access error occurs

getFetchSize

public int getFetchSize()
                 throws java.sql.SQLException

JDBC 2.0 Retrieves the number of result set rows that is the default fetch size for result sets generated from this Statement object. If this Statement object has not set a fetch size by calling the method setFetchSize, the return value is implementation-specific.

Returns:

the default fetch size for result sets generated from this Statement object

Throws:

java.sql.SQLException - if a database access error occurs

getMaxFieldSize

public int getMaxFieldSize()
                    throws java.sql.SQLException

Returns the maximum number of bytes allowed for any column value. This limit is the maximum number of bytes that can be returned for any column value. The limit applies only to BINARY, VARBINARY, LONGVARBINARY, CHAR, VARCHAR, and LONGVARCHAR columns. If the limit is exceeded, the excess data is silently discarded.

Returns:

the current max column size limit; zero means unlimited

Throws:

java.sql.SQLException - if a database access error occurs

getMaxRows

public int getMaxRows()
               throws java.sql.SQLException

Retrieves the maximum number of rows that a ResultSet can contain. If the limit is exceeded, the excess rows are silently dropped.

Returns:

the current max row limit; zero means unlimited

Throws:

java.sql.SQLException - if a database access error occurs

getMetaData

public java.sql.ResultSetMetaData getMetaData()
                                       throws java.sql.SQLException

JDBC 2.0 Gets the number, types and properties of a ResultSet's columns.

Specified by:

getMetaData in interface java.sql.PreparedStatement

Returns:

the description of a ResultSet's columns

Throws:

java.sql.SQLException - if a database access error occurs

getMoreResults

public boolean getMoreResults()
                       throws java.sql.SQLException

Moves to a Statement's next result. It returns true if this result is a ResultSet. This method also implicitly closes any current ResultSet obtained with getResultSet. There are no more results when (!getMoreResults() && (getUpdateCount() == -1)

Returns:

true if the next result is a ResultSet; false if it is an update count or there are no more results

Throws:

java.sql.SQLException - if a database access error occurs

See Also:

execute()

getQueryTimeout

public int getQueryTimeout()
                    throws java.sql.SQLException

Retrieves the number of seconds the driver will wait for a Statement to execute. If the limit is exceeded, a SQLException is thrown.

Returns:

the current query timeout limit in seconds; zero means unlimited

Throws:

java.sql.SQLException - if a database access error occurs

getResultSet

public java.sql.ResultSet getResultSet()
                                throws java.sql.SQLException

Returns the current result as a ResultSet object. This method should be called only once per result.

Returns:

the current result as a ResultSet; null if the result is an update count or there are no more results

Throws:

java.sql.SQLException - if a database access error occurs

See Also:

execute()

getResultSetConcurrency

public int getResultSetConcurrency()
                            throws java.sql.SQLException

JDBC 2.0 Retrieves the result set concurrency.

getResultSetType

public int getResultSetType()
                     throws java.sql.SQLException

JDBC 2.0 Determine the result set type.

getUpdateCount

public int getUpdateCount()
                   throws java.sql.SQLException

Returns the current result as an update count; if the result is a ResultSet or there are no more results, -1 is returned. This method should be called only once per result.

Returns:

the current result as an update count; -1 if it is a ResultSet or there are no more results

Throws:

java.sql.SQLException - if a database access error occurs

See Also:

execute()

getWarnings

public java.sql.SQLWarning getWarnings()
                                throws java.sql.SQLException

Retrieves the first warning reported by calls on this Statement. Subsequent Statement warnings will be chained to this SQLWarning.

The warning chain is automatically cleared each time a statement is (re)executed.

Note: If you are processing a ResultSet, any warnings associated with ResultSet reads will be chained on the ResultSet object.

Returns:

the first SQLWarning or null

Throws:

java.sql.SQLException - if a database access error occurs

setArray

public void setArray(int i,
                     java.sql.Array x)
              throws java.sql.SQLException

JDBC 2.0 Sets an Array parameter.

Specified by:

setArray in interface java.sql.PreparedStatement

Parameters:

i - the first parameter is 1, the second is 2, ...

x - an object representing an SQL array

Throws:

java.sql.SQLException - if a database access error occurs

setAsciiStream

public void setAsciiStream(int parameterIndex,
                           java.io.InputStream x,
                           int length)
                    throws 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. 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.

Specified by:

setAsciiStream in interface java.sql.PreparedStatement

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:

java.sql.SQLException - if a database access error occurs

setBigDecimal

public void setBigDecimal(int parameterIndex,
                          java.math.BigDecimal x)
                   throws java.sql.SQLException

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

Specified by:

setBigDecimal in interface java.sql.PreparedStatement

Parameters:

parameterIndex - the first parameter is 1, the second is 2, ...

x - the parameter value

Throws:

java.sql.SQLException - if a database access error occurs

setBinaryStream

public void setBinaryStream(int parameterIndex,
                            java.io.InputStream x,
                            int length)
                     throws 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. 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.

Specified by:

setBinaryStream in interface java.sql.PreparedStatement

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:

java.sql.SQLException - if a database access error occurs

setBlob

public void setBlob(int i,
                    java.sql.Blob x)
             throws java.sql.SQLException

JDBC 2.0 Sets a BLOB parameter.

Specified by:

setBlob in interface java.sql.PreparedStatement

Parameters:

i - the first parameter is 1, the second is 2, ...

x - an object representing a BLOB

Throws:

java.sql.SQLException - if a database access error occurs

setBoolean

public void setBoolean(int parameterIndex,
                       boolean x)
                throws java.sql.SQLException

Sets the designated parameter to a Java boolean value. The driver converts this to an SQL BIT value when it sends it to the database.

Specified by:

setBoolean in interface java.sql.PreparedStatement

Parameters:

parameterIndex - the first parameter is 1, the second is 2, ...

x - the parameter value

Throws:

java.sql.SQLException - if a database access error occurs

setByte

public void setByte(int parameterIndex,
                    byte x)
             throws java.sql.SQLException

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

Specified by:

setByte in interface java.sql.PreparedStatement

Parameters:

parameterIndex - the first parameter is 1, the second is 2, ...

x - the parameter value

Throws:

java.sql.SQLException - if a database access error occurs

setBytes

public void setBytes(int parameterIndex,
                     byte[] x)
              throws java.sql.SQLException

Sets the designated parameter to a 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 VARBINARYs) when it sends it to the database.

Specified by:

setBytes in interface java.sql.PreparedStatement

Parameters:

parameterIndex - the first parameter is 1, the second is 2, ...

x - the parameter value

Throws:

java.sql.SQLException - if a database access error occurs

setCharacterStream

public void setCharacterStream(int parameterIndex,
                               java.io.Reader reader,
                               int length)
                        throws java.sql.SQLException

JDBC 2.0 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. 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.

Specified by:

setCharacterStream in interface java.sql.PreparedStatement

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:

java.sql.SQLException - if a database access error occurs

setClob

public void setClob(int i,
                    java.sql.Clob x)
             throws java.sql.SQLException

JDBC 2.0 Sets a CLOB parameter.

Specified by:

setClob in interface java.sql.PreparedStatement

Parameters:

i - the first parameter is 1, the second is 2, ...

x - an object representing a CLOB

Throws:

java.sql.SQLException - if a database access error occurs

setCursorName

public void setCursorName(java.lang.String name)
                   throws java.sql.SQLException

Defines the SQL cursor name that will be used by subsequent Statement execute methods. This name can then be used in SQL positioned update/delete statements to identify the current row in the ResultSet generated by this statement. If the database doesn't support positioned update/delete, this method is a noop. To insure that a cursor has the proper isolation level to support updates, the cursor's SELECT statement should be of the form 'select for update ...'. If the 'for update' phrase is omitted, positioned updates may fail.

Note: By definition, positioned update/delete execution must be done by a different Statement than the one which generated the ResultSet being used for positioning. Also, cursor names must be unique within a connection.

Parameters:

name - the new cursor name, which must be unique within a connection

Throws:

java.sql.SQLException - if a database access error occurs

setDate

public void setDate(int parameterIndex,
                    java.sql.Date x)
             throws java.sql.SQLException

Sets the designated parameter to a java.sql.Date value. The driver converts this to an SQL DATE value when it sends it to the database.

Specified by:

setDate in interface java.sql.PreparedStatement

Parameters:

parameterIndex - the first parameter is 1, the second is 2, ...

x - the parameter value

Throws:

java.sql.SQLException - if a database access error occurs

setDate

public void setDate(int parameterIndex,
                    java.sql.Date x,
                    java.util.Calendar cal)
             throws java.sql.SQLException

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

Specified by:

setDate in interface java.sql.PreparedStatement

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:

java.sql.SQLException - if a database access error occurs

setDouble

public void setDouble(int parameterIndex,
                      double x)
               throws java.sql.SQLException

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

Specified by:

setDouble in interface java.sql.PreparedStatement

Parameters:

parameterIndex - the first parameter is 1, the second is 2, ...

x - the parameter value

Throws:

java.sql.SQLException - if a database access error occurs

setEscapeProcessing

public void setEscapeProcessing(boolean enable)
                         throws java.sql.SQLException

Sets escape processing on or off. If escape scanning is on (the default), the driver will do escape substitution before sending the SQL to the database. Note: Since prepared statements have usually been parsed prior to making this call, disabling escape processing for prepared statements will have no effect.

Parameters:

enable - true to enable; false to disable

Throws:

java.sql.SQLException - if a database access error occurs

setFetchDirection

public void setFetchDirection(int direction)
                       throws java.sql.SQLException

JDBC 2.0 Gives the driver a hint as to the direction in which the rows in a result set will be processed. The hint applies only to result sets created using this Statement object. The default value is ResultSet.FETCH_FORWARD.

Note that this method sets the default fetch direction for result sets generated by this Statement object. Each result set has its own methods for getting and setting its own fetch direction.

Parameters:

direction - the initial direction for processing rows

Throws:

java.sql.SQLException - if a database access error occurs or the given direction is not one of ResultSet.FETCH_FORWARD, ResultSet.FETCH_REVERSE, or ResultSet.FETCH_UNKNOWN

setFetchSize

public void setFetchSize(int rows)
                  throws java.sql.SQLException

JDBC 2.0 Gives the JDBC driver a hint as to the number of rows that should be fetched from the database when more rows are needed. The number of rows specified affects only result sets created using this statement. If the value specified is zero, then the hint is ignored. The default value is zero.

Parameters:

rows - the number of rows to fetch

Throws:

java.sql.SQLException - if a database access error occurs, or the condition 0 <= rows <= this.getMaxRows() is not satisfied.

setFloat

public void setFloat(int parameterIndex,
                     float x)
              throws java.sql.SQLException

Sets the designated parameter to a Java float value. The driver converts this to an SQL FLOAT value when it sends it to the database.

Specified by:

setFloat in interface java.sql.PreparedStatement

Parameters:

parameterIndex - the first parameter is 1, the second is 2, ...

x - the parameter value

Throws:

java.sql.SQLException - if a database access error occurs

setInt

public void setInt(int parameterIndex,
                   int x)
            throws java.sql.SQLException

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

Specified by:

setInt in interface java.sql.PreparedStatement

Parameters:

parameterIndex - the first parameter is 1, the second is 2, ...

x - the parameter value

Throws:

java.sql.SQLException - if a database access error occurs

setLong

public void setLong(int parameterIndex,
                    long x)
             throws java.sql.SQLException

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

Specified by:

setLong in interface java.sql.PreparedStatement

Parameters:

parameterIndex - the first parameter is 1, the second is 2, ...

x - the parameter value

Throws:

java.sql.SQLException - if a database access error occurs

setMaxFieldSize

public void setMaxFieldSize(int max)
                     throws java.sql.SQLException

Sets the limit for the maximum number of bytes in a column to the given number of bytes. This is the maximum number of bytes that can be returned for any column value. This limit applies only to BINARY, VARBINARY, LONGVARBINARY, CHAR, VARCHAR, and LONGVARCHAR fields. If the limit is exceeded, the excess data is silently discarded. For maximum portability, use values greater than 256.

Parameters:

max - the new max column size limit; zero means unlimited

Throws:

java.sql.SQLException - if a database access error occurs

setMaxRows

public void setMaxRows(int max)
                throws java.sql.SQLException

Sets the limit for the maximum number of rows that any ResultSet can contain to the given number. If the limit is exceeded, the excess rows are silently dropped.

Parameters:

max - the new max rows limit; zero means unlimited

Throws:

java.sql.SQLException - if a database access error occurs

setNull

public void setNull(int parameterIndex,
                    int sqlType)
             throws java.sql.SQLException

Sets the designated parameter to SQL NULL.

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

Specified by:

setNull in interface java.sql.PreparedStatement

Parameters:

parameterIndex - the first parameter is 1, the second is 2, ...

sqlType - the SQL type code defined in java.sql.Types

Throws:

java.sql.SQLException - if a database access error occurs

setNull

public void setNull(int paramIndex,
                    int sqlType,
                    java.lang.String typeName)
             throws java.sql.SQLException

JDBC 2.0 Sets the designated parameter to SQL NULL. This version of setNull should be used for user-named types and REF type parameters. Examples of user-named 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-named 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-named 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-named or REF type, the given typeName is ignored.

Specified by:

setNull in interface java.sql.PreparedStatement

Parameters:

parameterIndex - 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-named type, ignored if the parameter is not a user-named type or REF

Throws:

java.sql.SQLException - if a database access error occurs

setObject

public void setObject(int parameterIndex,
                      java.lang.Object x)
               throws java.sql.SQLException

Sets 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. If the object is of a class implementing SQLData, the JDBC driver should call its method 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, then 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 those interfaces.

Specified by:

setObject in interface java.sql.PreparedStatement

Parameters:

parameterIndex - the first parameter is 1, the second is 2, ...

x - the object containing the input parameter value

Throws:

java.sql.SQLException - if a database access error occurs

setObject

public void setObject(int parameterIndex,
                      java.lang.Object x,
                      int targetSqlType)
               throws java.sql.SQLException

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

Specified by:

setObject in interface java.sql.PreparedStatement

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:

java.sql.SQLException - if a database access error occurs

setObject

public void setObject(int parameterIndex,
                      java.lang.Object x,
                      int targetSqlType,
                      int scale)
               throws java.sql.SQLException

Sets the value of a parameter using an 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 targetSqlType before being sent to the database. If the object has a custom mapping (is of a class implementing SQLData), the JDBC driver should call its method 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 datatabase- specific abstract data types.

Specified by:

setObject in interface java.sql.PreparedStatement

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:

java.sql.SQLException - if a database access error occurs

See Also:

Types

setQueryTimeout

public void setQueryTimeout(int seconds)
                     throws java.sql.SQLException

Sets the number of seconds the driver will wait for a Statement to execute to the given number of seconds. If the limit is exceeded, a SQLException is thrown.

Parameters:

seconds - the new query timeout limit in seconds; zero means unlimited

Throws:

java.sql.SQLException - if a database access error occurs

setRef

public void setRef(int i,
                   java.sql.Ref x)
            throws java.sql.SQLException

JDBC 2.0 Sets a REF(<structured-type>) parameter.

Specified by:

setRef in interface java.sql.PreparedStatement

Parameters:

i - the first parameter is 1, the second is 2, ...

x - an object representing data of an SQL REF Type

Throws:

java.sql.SQLException - if a database access error occurs

setShort

public void setShort(int parameterIndex,
                     short x)
              throws java.sql.SQLException

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

Specified by:

setShort in interface java.sql.PreparedStatement

Parameters:

parameterIndex - the first parameter is 1, the second is 2, ...

x - the parameter value

Throws:

java.sql.SQLException - if a database access error occurs

setString

public void setString(int parameterIndex,
                      java.lang.String x)
               throws java.sql.SQLException

Sets the designated parameter to a 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 VARCHARs) when it sends it to the database.

Specified by:

setString in interface java.sql.PreparedStatement

Parameters:

parameterIndex - the first parameter is 1, the second is 2, ...

x - the parameter value

Throws:

java.sql.SQLException - if a database access error occurs

setTime

public void setTime(int parameterIndex,
                    java.sql.Time x)
             throws java.sql.SQLException

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

Specified by:

setTime in interface java.sql.PreparedStatement

Parameters:

parameterIndex - the first parameter is 1, the second is 2, ...

x - the parameter value

Throws:

java.sql.SQLException - if a database access error occurs

setTime

public void setTime(int parameterIndex,
                    java.sql.Time x,
                    java.util.Calendar cal)
             throws java.sql.SQLException

JDBC 2.0 Sets the designated parameter to a java.sql.Time value, using the given Calendar object. The driver uses the Calendar object to construct an SQL TIME, which the driver then sends to the database. With a a Calendar object, the driver can calculate the time taking into account a custom timezone and locale. If no Calendar object is specified, the driver uses the default timezone and locale.

Specified by:

setTime in interface java.sql.PreparedStatement

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:

java.sql.SQLException - if a database access error occurs

setTimestamp

public void setTimestamp(int parameterIndex,
                         java.sql.Timestamp x)
                  throws java.sql.SQLException

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

Specified by:

setTimestamp in interface java.sql.PreparedStatement

Parameters:

parameterIndex - the first parameter is 1, the second is 2, ...

x - the parameter value

Throws:

java.sql.SQLException - if a database access error occurs

setTimestamp

public void setTimestamp(int parameterIndex,
                         java.sql.Timestamp x,
                         java.util.Calendar cal)
                  throws java.sql.SQLException

JDBC 2.0 Sets the designated parameter to a java.sql.Timestamp value, using the given Calendar object. The driver uses the Calendar object to construct an SQL TIMESTAMP, which the driver then sends to the database. With a a Calendar object, the driver can calculate the timestamp taking into account a custom timezone and locale. If no Calendar object is specified, the driver uses the default timezone and locale.

Specified by:

setTimestamp in interface java.sql.PreparedStatement

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:

java.sql.SQLException - if a database access error occurs

setUnicodeStream

public void setUnicodeStream(int parameterIndex,
                             java.io.InputStream x,
                             int length)
                      throws java.sql.SQLException

Deprecated.

Sets the designated parameter to the given input stream, which will have the specified number of bytes. 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. The byte format of the Unicode stream must be Java UTF-8, as defined in the Java Virtual Machine Specification.

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

Specified by:

setUnicodeStream in interface java.sql.PreparedStatement

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:

java.sql.SQLException - if a database access error occurs