nl.cwi.monetdb.jdbc

Class MonetPreparedStatement

java.lang.Object

nl.cwi.monetdb.jdbc.MonetWrapper

nl.cwi.monetdb.jdbc.MonetStatement

nl.cwi.monetdb.jdbc.MonetPreparedStatement

All Implemented Interfaces:

AutoCloseable, PreparedStatement, Statement, Wrapper

public class MonetPreparedStatement
extends MonetStatement
implements PreparedStatement, AutoCloseable

A PreparedStatement suitable for the MonetDB database. This implementation of the PreparedStatement interface uses the capabilities of the MonetDB/SQL backend to prepare and execute queries. The backend takes care of finding the '?'s in the input and returns the types it expects for them. An example of a server response on a prepare query is:

 % prepare select name from tables where id > ? and id < ?;
 &5 0 2 3 2
 # prepare,      prepare,        prepare # table_name
 # type, digits, scale # name
 # varchar,      int,    int # type
 # 0,    0,      0 # length
 [ "int",        9,      0       ]
 [ "int",        9,      0       ]
 

Version:

0.5v

Author:

Fabian Groffen, Martin van Dinther, Pedro Ferreira

Field Summary

Fields inherited from class nl.cwi.monetdb.jdbc.MonetStatement

closed

Fields inherited from interface java.sql.Statement

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

Method Summary

Modifier and Type	Method and Description
void	addBatch() Adds a set of parameters to this PreparedStatement object's batch of commands.
void	addBatch(String q) override the addBatch from the Statement to throw an SQLException
void	clearParameters() Clears the current parameter values immediately.
void	close() Releases this PreparedStatement object's database and JDBC resources immediately instead of waiting for this to happen when it is automatically closed.
boolean	execute() Executes the SQL statement in this PreparedStatement object, which may be any kind of SQL statement.
boolean	execute(String q) override the execute from the Statement to throw an SQLException
ResultSet	executeQuery() Executes the SQL query in this PreparedStatement object and returns the ResultSet object generated by the query.
ResultSet	executeQuery(String q) override the executeQuery from the Statement to throw an SQLException
int	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.
int	executeUpdate(String q) override the executeUpdate from the Statement to throw an SQLException
protected void	finalize() Call close to release the server-sided handle for this PreparedStatement.
ResultSetMetaData	getMetaData() Retrieves a ResultSetMetaData object that contains information about the columns of the ResultSet object that will be returned when this PreparedStatement object is executed.
ParameterMetaData	getParameterMetaData() Retrieves the number, types and properties of this PreparedStatement object's parameters.
void	setArray(int parameterIndex, Array x) Sets the designated parameter to the given Array object.
void	setAsciiStream(int parameterIndex, InputStream x) Sets the designated parameter to the given input stream, which will have the specified number of bytes.
void	setAsciiStream(int parameterIndex, InputStream x, int length) Sets the designated parameter to the given input stream, which will have the specified number of bytes.
void	setAsciiStream(int parameterIndex, InputStream x, long length) Sets the designated parameter to the given input stream, which will have the specified number of bytes.
void	setBigDecimal(int parameterIndex, BigDecimal x) Sets the designated parameter to the given java.math.BigDecimal value.
void	setBinaryStream(int parameterIndex, InputStream x) Sets the designated parameter to the given input stream, which will have the specified number of bytes.
void	setBinaryStream(int parameterIndex, InputStream x, int length) Sets the designated parameter to the given input stream, which will have the specified number of bytes.
void	setBinaryStream(int parameterIndex, InputStream x, long length) Sets the designated parameter to the given input stream, which will have the specified number of bytes.
void	setBlob(int parameterIndex, Blob x) Sets the designated parameter to the given Blob object.
void	setBlob(int parameterIndex, InputStream x) Sets the designated parameter to the given Blob object.
void	setBlob(int parameterIndex, InputStream is, long length) Sets the designated parameter to a InputStream object.
void	setBoolean(int parameterIndex, boolean x) Sets the designated parameter to the given Java boolean value.
void	setByte(int parameterIndex, byte x) Sets the designated parameter to the given Java byte value.
void	setBytes(int parameterIndex, byte[] x) Sets the designated parameter to the given Java array of bytes.
void	setCharacterStream(int parameterIndex, Reader reader) Sets the designated parameter to the given Reader object, which is the given number of characters long.
void	setCharacterStream(int parameterIndex, Reader reader, int length) Sets the designated parameter to the given Reader object, which is the given number of characters long.
void	setCharacterStream(int parameterIndex, Reader reader, long length) Sets the designated parameter to the given Reader object, which is the given number of characters long.
void	setClob(int parameterIndex, Clob x) Sets the designated parameter to the given Clob object.
void	setClob(int parameterIndex, Reader reader) Sets the designated parameter to the given Clob object.
void	setClob(int parameterIndex, Reader reader, long length) Sets the designated parameter to a Reader object.
void	setDate(int parameterIndex, Date x) Sets the designated parameter to the given java.sql.Date value.
void	setDate(int parameterIndex, Date x, Calendar cal) Sets the designated parameter to the given java.sql.Date value, using the given Calendar object.
void	setDouble(int parameterIndex, double x) Sets the designated parameter to the given Java double value.
void	setFloat(int parameterIndex, float x) Sets the designated parameter to the given Java float value.
void	setInt(int parameterIndex, int x) Sets the designated parameter to the given Java int value.
void	setLong(int parameterIndex, long x) Sets the designated parameter to the given Java long value.
void	setNCharacterStream(int parameterIndex, Reader value) Sets the designated parameter to a Reader object.
void	setNCharacterStream(int parameterIndex, Reader value, long length) Sets the designated parameter to a Reader object.
void	setNClob(int parameterIndex, NClob value) Sets the designated parameter to a java.sql.NClob object.
void	setNClob(int parameterIndex, Reader value) Sets the designated parameter to a java.sql.NClob object.
void	setNClob(int parameterIndex, Reader r, long length) Sets the designated parameter to a Reader object.
void	setNString(int parameterIndex, String value) Sets the designated paramter to the given String object.
void	setNull(int parameterIndex, int sqlType) Sets the designated parameter to SQL NULL.
void	setNull(int parameterIndex, int sqlType, String typeName) Sets the designated parameter to SQL NULL.
void	setObject(int parameterIndex, Object x) Sets the value of the designated parameter using the given object.
void	setObject(int parameterIndex, Object x, int targetSqlType) Sets the value of the designated parameter with the given object.
void	setObject(int parameterIndex, Object x, int targetSqlType, int scale) Sets the value of the designated parameter with the given object.
void	setRef(int parameterIndex, Ref x) Sets the designated parameter to the given REF() value.
void	setRowId(int parameterIndex, RowId x) Sets the designated parameter to the given java.sql.RowId object.
void	setShort(int parameterIndex, short x) Sets the designated parameter to the given Java short value.
void	setSQLXML(int parameterIndex, SQLXML x) Sets the designated parameter to the given java.sql.SQLXML object.
void	setString(int parameterIndex, String x) Sets the designated parameter to the given Java String value.
void	setTime(int parameterIndex, Time x) Sets the designated parameter to the given java.sql.Time value.
void	setTime(int parameterIndex, Time x, Calendar cal) Sets the designated parameter to the given java.sql.Time value, using the given Calendar object.
void	setTimestamp(int parameterIndex, Timestamp x) Sets the designated parameter to the given java.sql.Timestamp value.
void	setTimestamp(int parameterIndex, Timestamp x, Calendar cal) Sets the designated parameter to the given java.sql.Timestamp value, using the given Calendar object.
void	setUnicodeStream(int parameterIndex, InputStream x, int length) Deprecated.
void	setURL(int parameterIndex, URL x) Sets the designated parameter to the given java.net.URL value.

Methods inherited from class nl.cwi.monetdb.jdbc.MonetStatement

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

Methods inherited from class nl.cwi.monetdb.jdbc.MonetWrapper

isWrapperFor, unwrap

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.sql.PreparedStatement

executeLargeUpdate, setObject, setObject

Methods inherited from interface java.sql.Statement

cancel, clearBatch, clearWarnings, closeOnCompletion, execute, execute, execute, executeBatch, executeLargeBatch, executeLargeUpdate, executeLargeUpdate, executeLargeUpdate, executeLargeUpdate, executeUpdate, executeUpdate, executeUpdate, getConnection, getFetchDirection, getFetchSize, getGeneratedKeys, getLargeMaxRows, getLargeUpdateCount, getMaxFieldSize, getMaxRows, getMoreResults, getMoreResults, getQueryTimeout, getResultSet, getResultSetConcurrency, getResultSetHoldability, getResultSetType, getUpdateCount, getWarnings, isClosed, isCloseOnCompletion, isPoolable, setCursorName, setEscapeProcessing, setFetchDirection, setFetchSize, setLargeMaxRows, setMaxFieldSize, setMaxRows, setPoolable, setQueryTimeout

Methods inherited from interface java.sql.Wrapper

isWrapperFor, unwrap

Method Detail

addBatch

public void addBatch()
              throws SQLException

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

Specified by:

addBatch in interface PreparedStatement

Throws:

SQLException - if a database access error occurs

addBatch

public void addBatch(String q)
              throws SQLException

override the addBatch from the Statement to throw an SQLException

Specified by:

addBatch in interface Statement

Overrides:

addBatch in class MonetStatement

Parameters:

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

Throws:

SQLException - so the PreparedStatement can throw this exception

clearParameters

public void clearParameters()

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

Specified by:

clearParameters in interface PreparedStatement

execute

public boolean execute()
                throws SQLException

Executes the SQL statement in this PreparedStatement object, which may be any kind of SQL statement. Some prepared statements return multiple results; the execute method handles these complex statements as well as the simpler form of statements handled by the methods executeQuery and executeUpdate. The execute method returns a boolean to indicate the form of the first result. You must call either the method getResultSet or getUpdateCount to retrieve the result; you must call getMoreResults to move to any subsequent result(s).

Specified by:

execute in interface PreparedStatement

Returns:

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

Throws:

SQLException - if a database access error occurs or an argument is supplied to this method

execute

public boolean execute(String q)
                throws SQLException

override the execute from the Statement to throw an SQLException

Specified by:

execute in interface Statement

Overrides:

execute in class MonetStatement

Parameters:

q - any SQL statement

Returns:

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

Throws:

SQLException - if a database access error occurs

executeQuery

public ResultSet executeQuery()
                       throws SQLException

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

Specified by:

executeQuery in interface PreparedStatement

Returns:

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

Throws:

SQLException - if a database access error occurs or the SQL statement does not return a ResultSet object

executeQuery

public ResultSet executeQuery(String q)
                       throws SQLException

override the executeQuery from the Statement to throw an SQLException

Specified by:

executeQuery in interface Statement

Overrides:

executeQuery in class MonetStatement

Parameters:

q - an SQL statement to be sent to the database, typically a static SQL SELECT statement

Returns:

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

Throws:

SQLException - if a database access error occurs or the given SQL statement produces anything other than a single ResultSet object

executeUpdate

public int executeUpdate()
                  throws 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.

Specified by:

executeUpdate in interface PreparedStatement

Returns:

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

Throws:

SQLException - if a database access error occurs or the SQL statement returns a ResultSet object

executeUpdate

public int executeUpdate(String q)
                  throws SQLException

override the executeUpdate from the Statement to throw an SQLException

Specified by:

executeUpdate in interface Statement

Overrides:

executeUpdate in class MonetStatement

Parameters:

q - an SQL INSERT, UPDATE or DELETE statement or an SQL statement that returns nothing

Returns:

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

Throws:

SQLException - if a database access error occurs or the given SQL statement produces a ResultSet object

getMetaData

public ResultSetMetaData getMetaData()

Retrieves a ResultSetMetaData object that contains information about the columns of the ResultSet object that will be returned when this PreparedStatement object is executed. Because a PreparedStatement object is precompiled, it is possible to know about the ResultSet object that it will return without having to execute it. Consequently, it is possible to invoke the method getMetaData on a PreparedStatement object rather than waiting to execute it and then invoking the ResultSet.getMetaData method on the ResultSet object that is returned.

Specified by:

getMetaData in interface PreparedStatement

Returns:

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

getParameterMetaData

public ParameterMetaData getParameterMetaData()
                                       throws SQLException

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

Specified by:

getParameterMetaData in interface PreparedStatement

Returns:

a ParameterMetaData object that contains information about the number, types and properties of this PreparedStatement object's parameters

Throws:

SQLException - if a database access error occurs

setArray

public void setArray(int parameterIndex,
                     Array x)
              throws 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.

Specified by:

setArray in interface PreparedStatement

Parameters:

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

x - an Array object that maps an SQL ARRAY value

Throws:

SQLException - if a database access error occurs

setAsciiStream

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

Sets the designated parameter to the given input stream, which will have the specified number of bytes. When a very large ASCII value is input to a LONGVARCHAR parameter, it may be more practical to send it via a java.io.InputStream. Data will be read from the stream as needed until end-of-file is reached. The JDBC driver will do any necessary conversion from ASCII to the database char format. Note: This stream object can either be a standard Java stream object or your own subclass that implements the standard interface.

Specified by:

setAsciiStream in interface PreparedStatement

Parameters:

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

x - the Java input stream that contains the ASCII parameter value

Throws:

SQLException - if a database access error occurs

SQLFeatureNotSupportedException - the JDBC driver does not support this method

setAsciiStream

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

Sets the designated parameter to the given input stream, which will have the specified number of bytes. When a very large ASCII value is input to a LONGVARCHAR parameter, it may be more practical to send it via a java.io.InputStream. Data will be read from the stream as needed until end-of-file is reached. The JDBC driver will do any necessary conversion from ASCII to the database char format. Note: This stream object can either be a standard Java stream object or your own subclass that implements the standard interface.

Specified by:

setAsciiStream in interface 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:

SQLException - if a database access error occurs

setAsciiStream

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

Sets the designated parameter to the given input stream, which will have the specified number of bytes. When a very large ASCII value is input to a LONGVARCHAR parameter, it may be more practical to send it via a java.io.InputStream. Data will be read from the stream as needed until end-of-file is reached. The JDBC driver will do any necessary conversion from ASCII to the database char format. Note: This stream object can either be a standard Java stream object or your own subclass that implements the standard interface.

Specified by:

setAsciiStream in interface 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:

SQLException - if a database access error occurs

SQLFeatureNotSupportedException - the JDBC driver does not support this method

setBigDecimal

public void setBigDecimal(int parameterIndex,
                          BigDecimal x)
                   throws SQLException

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

Specified by:

setBigDecimal in interface PreparedStatement

Parameters:

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

x - the parameter value

Throws:

SQLException - if a database access error occurs

setBinaryStream

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

Sets the designated parameter to the given input stream, which will have the specified number of bytes. When a very large binary value is input to a LONGVARBINARY parameter, it may be more practical to send it via a java.io.InputStream object. The data will be read from the stream as needed until end-of-file is reached. Note: This stream object can either be a standard Java stream object or your own subclass that implements the standard interface.

Specified by:

setBinaryStream in interface PreparedStatement

Parameters:

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

x - the java input stream which contains the binary parameter value

Throws:

SQLException - if a database access error occurs

SQLFeatureNotSupportedException - the JDBC driver does not support this method

setBinaryStream

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

Sets the designated parameter to the given input stream, which will have the specified number of bytes. When a very large binary value is input to a LONGVARBINARY parameter, it may be more practical to send it via a java.io.InputStream object. The data will be read from the stream as needed until end-of-file is reached. Note: This stream object can either be a standard Java stream object or your own subclass that implements the standard interface.

Specified by:

setBinaryStream in interface 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:

SQLException - if a database access error occurs

SQLFeatureNotSupportedException - the JDBC driver does not support this method

setBinaryStream

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

Sets the designated parameter to the given input stream, which will have the specified number of bytes. When a very large binary value is input to a LONGVARBINARY parameter, it may be more practical to send it via a java.io.InputStream object. The data will be read from the stream as needed until end-of-file is reached. Note: This stream object can either be a standard Java stream object or your own subclass that implements the standard interface.

Specified by:

setBinaryStream in interface 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:

SQLException - if a database access error occurs

SQLFeatureNotSupportedException - the JDBC driver does not support this method

setBlob

public void setBlob(int parameterIndex,
                    InputStream x)
             throws 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.

Specified by:

setBlob in interface PreparedStatement

Parameters:

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

x - a Blob object that maps an SQL BLOB value

Throws:

SQLException - if a database access error occurs

setBlob

public void setBlob(int parameterIndex,
                    Blob x)
             throws 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.

Specified by:

setBlob in interface PreparedStatement

Parameters:

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

x - a Blob object that maps an SQL BLOB value

Throws:

SQLException - if a database access error occurs

setBlob

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

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

Specified by:

setBlob in interface PreparedStatement

Parameters:

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

is - an object that contains the data to set the parameter value to

length - the number of bytes in the parameter data

Throws:

SQLException - if a database access error occurs

setBoolean

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

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

Specified by:

setBoolean in interface PreparedStatement

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

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.

Specified by:

setByte in interface PreparedStatement

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

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.

Specified by:

setBytes in interface PreparedStatement

Parameters:

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

x - the parameter value

Throws:

SQLException - if a database access error occurs

setCharacterStream

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

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

Parameters:

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

reader - the java.io.Reader object that contains the Unicode data

length - the number of characters in the stream

Throws:

SQLException - if a database access error occurs

setCharacterStream

public void setCharacterStream(int parameterIndex,
                               Reader reader)
                        throws SQLException

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

Parameters:

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

reader - the java.io.Reader object that contains the Unicode data

Throws:

SQLException - if a database access error occurs

setCharacterStream

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

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

Parameters:

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

reader - the java.io.Reader object that contains the Unicode data

length - the number of characters in the stream

Throws:

SQLException - if a database access error occurs

setClob

public void setClob(int parameterIndex,
                    Clob x)
             throws 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.

Specified by:

setClob in interface PreparedStatement

Parameters:

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

x - a Clob object that maps an SQL CLOB value

Throws:

SQLException - if a database access error occurs

setClob

public void setClob(int parameterIndex,
                    Reader reader)
             throws 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.

Specified by:

setClob in interface PreparedStatement

Parameters:

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

reader - an object that contains the data to set the parameter value to

Throws:

SQLException - if a database access error occurs

setClob

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

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

Specified by:

setClob in interface PreparedStatement

Parameters:

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

reader - An object that contains the data to set the parameter value to.

length - the number of characters in the parameter data.

Throws:

SQLException - if a database access error occurs

setDate

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

Specified by:

setDate in interface PreparedStatement

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,
                    Calendar cal)
             throws SQLException

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

Specified by:

setDate in interface 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:

SQLException - if a database access error occurs

setDouble

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

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

Specified by:

setDouble in interface PreparedStatement

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

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.

Specified by:

setFloat in interface PreparedStatement

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

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.

Specified by:

setInt in interface PreparedStatement

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

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.

Specified by:

setLong in interface PreparedStatement

Parameters:

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

x - the parameter value

Throws:

SQLException - if a database access error occurs

setNCharacterStream

public void setNCharacterStream(int parameterIndex,
                                Reader value)
                         throws SQLException

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

Specified by:

setNCharacterStream in interface PreparedStatement

Parameters:

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

value - the parameter value

Throws:

SQLException - if a database access error occurs

SQLFeatureNotSupportedException - the JDBC driver does not support this method

setNCharacterStream

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

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

Specified by:

setNCharacterStream in interface PreparedStatement

Parameters:

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

value - the parameter value

length - the number of characters in the parameter data.

Throws:

SQLException - if a database access error occurs

SQLFeatureNotSupportedException - the JDBC driver does not support this method

setNClob

public void setNClob(int parameterIndex,
                     Reader value)
              throws SQLException

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

Specified by:

setNClob in interface PreparedStatement

Parameters:

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

value - the parameter value

Throws:

SQLException - if a database access error occurs

SQLFeatureNotSupportedException - the JDBC driver does not support this method

setNClob

public void setNClob(int parameterIndex,
                     NClob value)
              throws SQLException

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

Specified by:

setNClob in interface PreparedStatement

Parameters:

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

value - the parameter value

Throws:

SQLException - if a database access error occurs

SQLFeatureNotSupportedException - the JDBC driver does not support this method

setNClob

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

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

Specified by:

setNClob in interface PreparedStatement

Parameters:

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

r - An object that contains the data to set the parameter value to

length - the number of characters in the parameter data

Throws:

SQLException - if a database access error occurs

SQLFeatureNotSupportedException - the JDBC driver does not support this method

setNString

public void setNString(int parameterIndex,
                       String value)
                throws SQLException

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

Specified by:

setNString in interface PreparedStatement

Parameters:

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

value - the parameter value

Throws:

SQLException - if a database access error occurs

SQLFeatureNotSupportedException - the JDBC driver does not support this method

setNull

public void setNull(int parameterIndex,
                    int sqlType)
             throws SQLException

Sets the designated parameter to SQL NULL. Note: You must specify the parameter's SQL type.

Specified by:

setNull in interface PreparedStatement

Parameters:

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

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

Throws:

SQLException - if a database access error occurs

setNull

public void setNull(int parameterIndex,
                    int sqlType,
                    String typeName)
             throws SQLException

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

Specified by:

setNull in interface 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-defined type; ignored if the parameter is not a user-defined type or REF

Throws:

SQLException - if a database access error occurs

setObject

public void setObject(int parameterIndex,
                      Object x)
               throws 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.

Specified by:

setObject in interface PreparedStatement

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 or the type of the given object is ambiguous

setObject

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

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

Specified by:

setObject in interface 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:

SQLException - if a database access error occurs

setObject

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

Sets the value of the designated parameter with the given object. The second argument must be an object type; for integral values, the java.lang equivalent objects should be used. 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. To meet the requirements of this interface, the Java object is converted in the driver, instead of using a SQL CAST construct.

Specified by:

setObject in interface 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 Java Object types InputStream and Reader, this is the length of the data in the stream or reader. For all other types, this value will be ignored.

Throws:

SQLException - if a database access error occurs

See Also:

Types

setRef

public void setRef(int parameterIndex,
                   Ref x)
            throws SQLException

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

Specified by:

setRef in interface PreparedStatement

Parameters:

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

x - an SQL REF value

Throws:

SQLException - if a database access error occurs

SQLFeatureNotSupportedException - the JDBC driver does not support this method

setRowId

public void setRowId(int parameterIndex,
                     RowId x)
              throws SQLException

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

Specified by:

setRowId in interface PreparedStatement

Parameters:

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

x - the parameter value

Throws:

SQLException - if a database access error occurs

SQLFeatureNotSupportedException - the JDBC driver does not support this method

setShort

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

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

Specified by:

setShort in interface PreparedStatement

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

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.

Specified by:

setString in interface PreparedStatement

Parameters:

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

x - the parameter value

Throws:

SQLException - if a database access error occurs

setSQLXML

public void setSQLXML(int parameterIndex,
                      SQLXML x)
               throws SQLException

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

Specified by:

setSQLXML in interface PreparedStatement

Parameters:

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

x - a SQLXML object that maps an SQL XML value

Throws:

SQLException - if a database access error occurs

SQLFeatureNotSupportedException - the JDBC driver does not support this method

setTime

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

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

Specified by:

setTime in interface PreparedStatement

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,
                    Calendar cal)
             throws 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.

Specified by:

setTime in interface 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:

SQLException - if a database access error occurs

setTimestamp

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

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

Specified by:

setTimestamp in interface PreparedStatement

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,
                         Calendar cal)
                  throws 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.

Specified by:

setTimestamp in interface 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:

SQLException - if a database access error occurs

setUnicodeStream

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

Deprecated.

Sets the designated parameter to the given input stream, which will have the specified number of bytes. A Unicode character has two bytes, with the first byte being the high byte, and the second being the low byte. When a very large Unicode value is input to a LONGVARCHAR parameter, it may be more practical to send it via a java.io.InputStream object. The data will be read from the stream as needed until end-of-file is reached. The JDBC driver will do any necessary conversion from Unicode to the database char format. 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 PreparedStatement

Parameters:

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

x - a java.io.InputStream object that contains the Unicode parameter value as two-byte Unicode characters

length - the number of bytes in the stream

Throws:

SQLException - if a database access error occurs

setURL

public void setURL(int parameterIndex,
                   URL x)
            throws SQLException

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

Specified by:

setURL in interface PreparedStatement

Parameters:

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

x - the java.net.URL object to be set

Throws:

SQLException - if a database access error occurs

close

public void close()

Releases this PreparedStatement 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. Calling the method close on a PreparedStatement object that is already closed has no effect. Note: A PreparedStatement object is automatically closed when it is garbage collected. When a Statement object is closed, its current ResultSet object, if one exists, is also closed.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Statement

Overrides:

close in class MonetStatement

finalize

protected void finalize()

Call close to release the server-sided handle for this PreparedStatement.

Overrides:

finalize in class Object