Prev Class | Next Class | Frames | No Frames |
Summary: Nested | Field | Method | Constr | Detail: Nested | Field | Method | Constr |
java.lang.Object
org.hsqldb.jdbc.jdbcStatement
org.hsqldb.jdbc.jdbcPreparedStatement
PreparedStatement
object. This object can then be used to
efficiently execute this statement multiple times.
Note: The setter methods (setShort
,
setString
, and so on) for setting IN parameter values
must specify types that are compatible with the defined SQL type of
the input parameter. For instance, if the IN parameter has SQL type
INTEGER
, then the method setInt
should be
used.
If arbitrary parameter type conversions are required, the method
setObject
should be used with a target SQL type.
In the following example of setting a parameter, con
represents an active connection:
PreparedStatement pstmt = con.prepareStatement("UPDATE EMPLOYEES SET SALARY = ? WHERE ID = ?"); pstmt.setBigDecimal(1, 153833.00) pstmt.setInt(2, 110592)<!-- end generic documentation --> <!-- start Release-specific documentation -->
int
values that are defined only in the JDBC 2 or greater
version of
ResultSet
interface. For this reason, when the
product is compiled under JDK 1.1.x, these values are defined in
jdbcResultSet
.
In a JRE 1.1.x environment, calling JDBC 2 methods that take or return the
JDBC2-only ResultSet
values can be achieved by referring
to them in parameter specifications and return value comparisons,
respectively, as follows:
jdbcResultSet.FETCH_FORWARD jdbcResultSet.TYPE_FORWARD_ONLY jdbcResultSet.TYPE_SCROLL_INSENSITIVE jdbcResultSet.CONCUR_READ_ONLY // etc.However, please note that code written in such a manner will not be compatible for use with other JDBC 2 drivers, since they expect and use
ResultSet
, rather than jdbcResultSet
. Also
note, this feature is offered solely as a convenience to developers
who must work under JDK 1.1.x due to operating constraints, yet wish to
use some of the more advanced features available under the JDBC 2
specification.
(fredt@users)jdbcConnection.prepareStatement
, jdbcResultSet
Method Summary | |
void |
|
void |
|
void |
|
void |
|
boolean |
|
boolean |
|
int[] |
|
ResultSet |
|
ResultSet |
|
int |
|
int |
|
ResultSetMetaData |
|
ParameterMetaData |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
String |
|
public void addBatch() throws SQLException
<!-- start generic documentation --> Adds a set of parameters to thisPreparedStatement
object's batch of commands. <!-- end generic documentation --> <!-- start release-specific documentation --><!-- end release-specific documentation -->HSQLDB-Specific Information:
Since 1.7.2, this feature is supported.
- Since:
- JDK 1.2 (JDK 1.1.x developers: read the new overview for jdbcPreparedStatement)
- See Also:
jdbcStatement.addBatch(String)
public void addBatch(String sql) throws SQLException
This method should always throw if called for a PreparedStatement or CallableStatment.
- Overrides:
- addBatch in interface jdbcStatement
- Parameters:
sql
- ignored
public void clearParameters() throws SQLException
<!-- start generic documentation --> 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 methodclearParameters
. <!-- end generic documentation -->
public void close() throws SQLException
Does the specialized work required to free this object's resources and that of it's parent class.
- Overrides:
- close in interface jdbcStatement
public boolean execute() throws SQLException
<!-- start generic documentation --> Executes the SQL statement in thisPreparedStatement
object, which may be any kind of SQL statement. Some prepared statements return multiple results; theexecute
method handles these complex statements as well as the simpler form of statements handled by the methodsexecuteQuery
andexecuteUpdate
. Theexecute
method returns aboolean
to indicate the form of the first result. You must call either the methodgetResultSet
orgetUpdateCount
to retrieve the result; you must callgetMoreResults
to move to any subsequent result(s). <!-- end generic documentation --> <!-- start release-specific documentation -->HSQLDB-Specific Information:
Including 1.8.0, prepared statements do not generate multiple fetchable results. In future versions, it will be possible that statements generate multiple fetchable results under certain conditions.
- Returns:
true
if the first result is aResultSet
object;false
if the first result is an update count or there is no result
- See Also:
jdbcStatement.execute
,jdbcStatement.getResultSet()
,jdbcStatement.getUpdateCount()
,jdbcStatement.getMoreResults
public boolean execute(String sql) throws SQLException
This method should always throw if called for a PreparedStatement or CallableStatment.
- Overrides:
- execute in interface jdbcStatement
- Parameters:
sql
- ignored
- Returns:
- nothing
public int[] executeBatch() throws SQLException
<!-- start generic documentation --> Submits a batch of commands to the database for execution and if all commands execute successfully, returns an array of update counts. Theint
elements of the array that is returned are ordered to correspond to the commands in the batch, which are ordered according to the order in which they were added to the batch. The elements in the array returned by the methodexecuteBatch
may be one of the following:A driver is not required to implement this method. The possible implementations and return values have been modified in the Java 2 SDK, Standard Edition, version 1.3 to accommodate the option of continuing to proccess commands in a batch update after a
- A number greater than or equal to zero -- indicates that the command was processed successfully and is an update count giving the number of rows in the database that were affected by the command's execution
- A value of
SUCCESS_NO_INFO
-- indicates that the command was processed successfully but that the number of rows affected is unknown If one of the commands in a batch update fails to execute properly, this method throws aBatchUpdateException
, and a JDBC driver may or may not continue to process the remaining commands in the batch. However, the driver's behavior must be consistent with a particular DBMS, either always continuing to process commands or never continuing to process commands. If the driver continues processing after a failure, the array returned by the methodBatchUpdateException.getUpdateCounts
will contain as many elements as there are commands in the batch, and at least one of the elements will be the following:- A value of
EXECUTE_FAILED
-- indicates that the command failed to execute successfully and occurs only if a driver continues to process commands after a command failsBatchUpdateException
obejct has been thrown. <!-- end generic documentation --> <!-- start release-specific documentation --><!-- end release-specific documentation -->HSQLDB-Specific Information:
Starting with HSQLDB 1.7.2, this feature is supported. HSQLDB stops execution of commands in a batch when one of the commands results in an exception. The size of the returned array equals the number of commands that were executed successfully. When the product is built under the JAVA1 target, an exception is never thrown and it is the responsibility of the client software to check the size of the returned update count array to determine if any batch items failed. To build and run under the JAVA2 target, JDK/JRE 1.3 or higher must be used.
- Overrides:
- executeBatch in interface jdbcStatement
- Returns:
- an array of update counts containing one element for each command in the batch. The elements of the array are ordered according to the order in which commands were added to the batch.
- Since:
- JDK 1.3 (JDK 1.1.x developers: read the new overview for jdbcStatement)
public ResultSet executeQuery() throws SQLException
<!-- start generic documentation --> Executes the SQL query in thisPreparedStatement
object and returns theResultSet
object generated by the query. <!-- end generic documentation -->
- Returns:
- a
ResultSet
object that contains the data produced by the query; nevernull
public ResultSet executeQuery(String sql) throws SQLException
This method should always throw if called for a PreparedStatement or CallableStatment.
- Overrides:
- executeQuery in interface jdbcStatement
- Parameters:
sql
- ignored
- Returns:
- nothing
public int executeUpdate() throws SQLException
<!-- start generic documentation --> Executes the SQL statement in thisPreparedStatement
object, which must be an SQLINSERT
,UPDATE
orDELETE
statement; or an SQL statement that returns nothing, such as a DDL statement. <!-- end generic documentation -->
- Returns:
- either (1) the row count for
INSERT
,UPDATE
, orDELETE
statements or (2) 0 for SQL statements that return nothing
public int executeUpdate(String sql) throws SQLException
This method should always throw if called for a PreparedStatement or CallableStatment.
- Overrides:
- executeUpdate in interface jdbcStatement
- Parameters:
sql
- ignored
- Returns:
- nothing
public ResultSetMetaData getMetaData() throws SQLException
<!-- start generic documentation --> Retrieves aResultSetMetaData
object that contains information about the columns of theResultSet
object that will be returned when thisPreparedStatement
object is executed. Because aPreparedStatement
object is precompiled, it is possible to know about theResultSet
object that it will return without having to execute it. Consequently, it is possible to invoke the methodgetMetaData
on aPreparedStatement
object rather than waiting to execute it and then invoking theResultSet.getMetaData
method on theResultSet
object that is returned. NOTE: Using this method may be expensive for some drivers due to the lack of underlying DBMS support. <!-- end generic documentation --> <!-- start release-specific documentation --><!-- end release-specific documentation -->HSQLDB-Specific Information:
Since 1.7.2, this feature is supported. If the statement generates an update count, then null is returned.
- Returns:
- the description of a
ResultSet
object's columns ornull
if the driver cannot return aResultSetMetaData
object
- Since:
- JDK 1.2 (JDK 1.1.x developers: read the new overview for jdbcPreparedStatement)
public ParameterMetaData getParameterMetaData() throws SQLException
<!-- start generic documentation --> Retrieves the number, types and properties of thisPreparedStatement
object's parameters. <!-- end generic documentation --> <!-- start release-specific documentation --><!-- end release-specific documentation -->HSQLDB-Specific Information:
Since 1.7.2, this feature is supported.
- Returns:
- a
ParameterMetaData
object that contains information about the number, types and properties of thisPreparedStatement
object's parameters
- Since:
- JDK 1.4, HSQL 1.7.0
- See Also:
java.sql.ParameterMetaData
public void setArray(int i, Array x) throws SQLException
<!-- start generic documentation --> Sets the designated parameter to the givenArray
object. The driver converts this to an SQLARRAY
value when it sends it to the database. <!-- end generic documentation --> <!-- start release-specific documentation --><!-- end release-specific documentation -->HSQLDB-Specific Information:
HSQLDB 1.7.2 does not support the SQL ARRAY type. Calling this method throws an exception.
- Parameters:
i
- the first parameter is 1, the second is 2, ...x
- anArray
object that maps an SQLARRAY
value
- Since:
- JDK 1.2 (JDK 1.1.x developers: read the new overview for jdbcPreparedStatement)
public void setAsciiStream(int parameterIndex, java.io.InputStream x, int length) throws SQLException
<!-- start generic documentation --> 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 aLONGVARCHAR
parameter, it may be more practical to send it via ajava.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. <!-- end generic documentation --> <!-- start release-specific documentation --><!-- end release-specific documentation -->HSQLDB-Specific Information:
This method uses the default platform character encoding to convert bytes from the stream into the characters of a String. In the future this is likely to change to always treat the stream as ASCII. Before HSQLDB 1.7.0,setAsciiStream
andsetUnicodeStream
were identical.
- Parameters:
parameterIndex
- the first parameter is 1, the second is 2, ...x
- the Java input stream that contains the ASCII parameter valuelength
- the number of bytes in the stream
public void setBigDecimal(int parameterIndex, BigDecimal x) throws SQLException
<!-- start generic documentation --> Sets the designated parameter to the givenjava.math.BigDecimal
value. The driver converts this to an SQLNUMERIC
value when it sends it to the database. <!-- end generic documentation -->
- Parameters:
parameterIndex
- the first parameter is 1, the second is 2, ...x
- the parameter value
public void setBinaryStream(int parameterIndex, java.io.InputStream x, int length) throws SQLException
<!-- start generic documentation --> 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 aLONGVARBINARY
parameter, it may be more practical to send it via ajava.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. <!-- end generic documentation --> <!-- start release-specific documentation --><!-- end release-specific documentation -->HSQLDB-Specific Information:
Since 1.7.2, this method works according to the standard.
- Parameters:
parameterIndex
- the first parameter is 1, the second is 2, ...x
- the java input stream which contains the binary parameter valuelength
- the number of bytes in the stream
public void setBlob(int i, Blob x) throws SQLException
<!-- start generic documentation --> Sets the designated parameter to the givenBlob
object. The driver converts this to an SQLBLOB
value when it sends it to the database. <!-- end generic documentation --> <!-- start release-specific documentation --><!-- end release-specific documentation -->HSQLDB-Specific Information:
Previous to 1.7.2, this feature was not supported. Since 1.7.2, setBlob is supported. With 1.7.2, setting Blob objects is limited to those of length less than or equal to Integer.MAX_VALUE. In 1.7.2, setBlob(i,x) is roughly equivalent (null and length handling not shown) to:setBinaryStream(i, x.getBinaryStream(), (int) x.length());
- Parameters:
i
- the first parameter is 1, the second is 2, ...x
- aBlob
object that maps an SQLBLOB
value
- Since:
- JDK 1.2 (JDK 1.1.x developers: read the new overview for jdbcPreparedStatement)
public void setBoolean(int parameterIndex, boolean x) throws SQLException
<!-- start generic documentation --> Sets the designated parameter to the given Javaboolean
value. The driver converts this to an SQLBIT
value when it sends it to the database. <!-- end generic documentation --> <!-- start release-specific documentation --><!-- end release-specific documentation -->HSQLDB-Specific Information:
Since 1.7.2, HSQLDB uses the BOOLEAN type instead of BIT, as per SQL 200n (SQL 3).
- Parameters:
parameterIndex
- the first parameter is 1, the second is 2, ...x
- the parameter value
public void setByte(int parameterIndex, byte x) throws SQLException
<!-- start generic documentation --> Sets the designated parameter to the given Javabyte
value. The driver converts this to an SQLTINYINT
value when it sends it to the database. <!-- end generic documentation -->
- Parameters:
parameterIndex
- the first parameter is 1, the second is 2, ...x
- the parameter value
public void setBytes(int paramIndex, byte[] x) throws SQLException
<!-- start generic documentation --> Sets the designated parameter to the given Java array of bytes. The driver converts this to an SQLVARBINARY
orLONGVARBINARY
(depending on the argument's size relative to the driver's limits onVARBINARY
values) when it sends it to the database. <!-- end generic documentation --> <!-- start release-specific documentation --><!-- start release-specific documentation -->HSQLDB-Specific Information:
Including 1.7.2, HSQLDB stores all XXXBINARY values the same way; there is no appreciable difference between BINARY, VARBINARY and LONGVARBINARY.
- Parameters:
paramIndex
- the first parameter is 1, the second is 2, ...x
- the parameter value
public void setCharacterStream(int parameterIndex, java.io.Reader reader, int length) throws SQLException
<!-- start generic documentation --> Sets the designated parameter to the givenReader
object, which is the given number of characters long. When a very large UNICODE value is input to aLONGVARCHAR
parameter, it may be more practical to send it via ajava.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. <!-- end generic documentation --> <!-- start release-specific documentation --><!-- end release-specific documentation -->HSQLDB-Specific Information:
HSQLDB stores CHARACTER and related SQL types as Unicode so this method does not perform any conversion.
- Parameters:
parameterIndex
- the first parameter is 1, the second is 2, ...reader
- thejava.io.Reader
object that contains the Unicode datalength
- the number of characters in the stream
- Since:
- JDK 1.2 (JDK 1.1.x developers: read the new overview for jdbcPreparedStatement)
public void setClob(int i, Clob x) throws SQLException
<!-- start generic documentation --> Sets the designated parameter to the givenClob
object. The driver converts this to an SQLCLOB
value when it sends it to the database. <!-- end generic documentation --> <!-- start release-specific documentation --><!-- end release-specific documentation -->HSQLDB-Specific Information:
Previous to 1.7.2, this feature was not supported. Since 1.7.2, setClob is supported. With 1.7.2, setting Blob objects is limited to those of length less than or equal to Integer.MAX_VALUE. In 1.7.2, setClob(i,x) is rougly equivalent (null and length handling not shown) to:setCharacterStream(i, x.getCharacterStream(), (int) x.length());
- Parameters:
i
- the first parameter is 1, the second is 2, ...x
- aClob
object that maps an SQLCLOB
value
- Since:
- JDK 1.2 (JDK 1.1.x developers: read the new overview for jdbcPreparedStatement)
public void setDate(int parameterIndex, Date x) throws SQLException
<!-- start generic documentation --> Sets the designated parameter to the givenjava.sql.Date
value. The driver converts this to an SQLDATE
value when it sends it to the database. <!-- end generic documentation -->
- Parameters:
parameterIndex
- the first parameter is 1, the second is 2, ...x
- the parameter value
public void setDate(int parameterIndex, Date x, Calendar cal) throws SQLException
<!-- start generic documentation --> Sets the designated parameter to the givenjava.sql.Date
value, using the givenCalendar
object. The driver uses theCalendar
object to construct an SQLDATE
value,which the driver then sends to the database. With a aCalendar
object, the driver can calculate the date taking into account a custom timezone. If noCalendar
object is specified, the driver uses the default timezone, which is that of the virtual machine running the application. <!-- end generic documentation -->
- Parameters:
parameterIndex
- the first parameter is 1, the second is 2, ...x
- the parameter valuecal
- theCalendar
object the driver will use to construct the date
- Since:
- JDK 1.2 (JDK 1.1.x developers: read the new overview for jdbcPreparedStatement)
public void setDouble(int parameterIndex, double x) throws SQLException
<!-- start generic documentation --> Sets the designated parameter to the given Javadouble
value. The driver converts this to an SQLDOUBLE
value when it sends it to the database. <!-- end generic documentation --> <!-- start release-specific documentation --><!-- start release-specific documentation -->HSQLDB-Specific Information:
Since 1.7.1, HSQLDB handles Java positive/negative Infinity and NaNdouble
values consistent with the Java Language Specification; these special values are now correctly stored to and retrieved from the database.
- Parameters:
parameterIndex
- the first parameter is 1, the second is 2, ...x
- the parameter value
public void setEscapeProcessing(boolean enable) throws SQLException
<!-- start generic documentation --> Sets escape processing on or off. <!-- end generic documentation --> <!-- start release-specific documentation --><!-- end release-specific documentation -->HSQLDB-Specific Information:
Since 1.7.0, the implementation follows the standard behaviour by overriding the same method in jdbcStatement class. In other words, calling this method has no effect.
- Overrides:
- setEscapeProcessing in interface jdbcStatement
- Parameters:
enable
-true
to enable escape processing;false
to disable it
public void setFloat(int parameterIndex, float x) throws SQLException
<!-- start generic documentation --> Sets the designated parameter to the given Javafloat
value. The driver converts this to an SQLFLOAT
value when it sends it to the database. <!-- end generic documentation --> <!-- start release-specific documentation --><!-- start release-specific documentation -->HSQLDB-Specific Information:
Since 1.7.1, HSQLDB handles Java positive/negative Infinity and NaNfloat
values consistent with the Java Language Specification; these special values are now correctly stored to and retrieved from the database.
- Parameters:
parameterIndex
- the first parameter is 1, the second is 2, ...x
- the parameter value
public void setInt(int parameterIndex, int x) throws SQLException
<!-- start generic documentation --> Sets the designated parameter to the given Javaint
value. The driver converts this to an SQLINTEGER
value when it sends it to the database. <!-- end generic documentation -->
- Parameters:
parameterIndex
- the first parameter is 1, the second is 2, ...x
- the parameter value
public void setLong(int parameterIndex, long x) throws SQLException
<!-- start generic documentation --> Sets the designated parameter to the given Javalong
value. The driver converts this to an SQLBIGINT
value when it sends it to the database. <!-- end generic documentation -->
- Parameters:
parameterIndex
- the first parameter is 1, the second is 2, ...x
- the parameter value
public void setNull(int paramIndex, int sqlType) throws SQLException
<!-- start generic documentation --> Sets the designated parameter to SQLNULL
. Note: You must specify the parameter's SQL type. <!-- end generic documentation --> <!-- start release-specific documentation --><!-- end release-specific documentation -->HSQLDB-Specific Information:
HSQLDB ignores the sqlType argument.
- Parameters:
paramIndex
- the first parameter is 1, the second is 2, ...sqlType
- the SQL type code defined injava.sql.Types
public void setNull(int paramIndex, int sqlType, String typeName) throws SQLException
<!-- start generic documentation --> Sets the designated parameter to SQLNULL
. This version of the methodsetNull
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. <!-- end generic documentation --> <!-- start release-specific documentation --><!-- end release-specific documentation -->HSQLDB-Specific Information:
HSQLDB ignores the sqlType and typeName arguments.
- Parameters:
paramIndex
- the first parameter is 1, the second is 2, ...sqlType
- a value fromjava.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
- Since:
- JDK 1.2 (JDK 1.1.x developers: read the new overview for jdbcPreparedStatement)
public void setObject(int parameterIndex, Object x) throws SQLException
<!-- start generic documentation --> Sets the value of the designated parameter using the given object. The second parameter must be of typeObject
; therefore, thejava.lang
equivalent objects should be used for built-in types. The JDBC specification specifies a standard mapping from JavaObject
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 interfaceSQLData
, the JDBC driver should call the methodSQLData.writeSQL
to write it to the SQL data stream. If, on the other hand, the object is of a class implementingRef
,Blob
,Clob
,Struct
, orArray
, 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. <!-- end generic documentation --> <!-- start release-specific documentation -->HSQLDB-Specific Information:
Since 1.7.2, this method supports conversions listed in the conversion table B-5 of the JDBC 3 specification.
- Parameters:
parameterIndex
- the first parameter is 1, the second is 2, ...x
- the object containing the input parameter value
public void setObject(int parameterIndex, Object x, int targetSqlType) throws SQLException
<!-- start generic documentation --> Sets the value of the designated parameter with the given object. This method is like the methodsetObject
above, except that it assumes a scale of zero. <!-- end generic documentation --> <!-- start release-specific documentation --><!-- end release-specific documentation -->HSQLDB-Specific Information:
Since 1.7.2, this method supports conversions listed in the conversion table B-5 of the JDBC 3 specification.
- Parameters:
parameterIndex
- the first parameter is 1, the second is 2, ...x
- the object containing the input parameter valuetargetSqlType
- the SQL type (as defined in java.sql.Types) to be sent to the database
- See Also:
setObject(int,Object)
public void setObject(int parameterIndex, Object x, int targetSqlType, int scale) throws SQLException
<!-- start generic documentation --> Sets the value of the designated parameter with the given object. The second argument must be an object type; for integral values, thejava.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 interfaceSQLData
), the JDBC driver should call the methodSQLData.writeSQL
to write it to the SQL data stream. If, on the other hand, the object is of a class implementingRef
,Blob
,Clob
,Struct
, orArray
, 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. <!-- end generic documentation --> <!-- start release-specific documentation --><!-- start release-specific documentation -->HSQLDB-Specific Information:
Inculding 1.7.1,this method was identical tosetObject(int, Object, int)
. That is, this method simply called setObject(int, Object, int), ignoring the scale specification. Since 1.7.2, this method supports the conversions listed in the conversion table B-5 of the JDBC 3 specification. The scale argument is not used.
- Parameters:
parameterIndex
- the first parameter is 1, the second is 2, ...x
- the object containing the input parameter valuetargetSqlType
- 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. Up to and including HSQLDB 1.7.0, this parameter is ignored.
- See Also:
java.sql.Types
,setObject(int,Object,int)
public void setRef(int i, Ref x) throws SQLException
<!-- start generic documentation --> Sets the designated parameter to the givenREF(<structured-type>)
value. The driver converts this to an SQLREF
value when it sends it to the database. <!-- end generic documentation --> <!-- start release-specific documentation --><!-- end release-specific documentation -->HSQLDB-Specific Information:
HSQLDB 1.7.2 does not support the SQL REF type. Calling this method throws an exception.
- Parameters:
i
- the first parameter is 1, the second is 2, ...x
- an SQLREF
value
- Since:
- JDK 1.2 (JDK 1.1.x developers: read the new overview for jdbcPreparedStatement)
public void setShort(int parameterIndex, short x) throws SQLException
<!-- start generic documentation --> Sets the designated parameter to the given Javashort
value. The driver converts this to an SQLSMALLINT
value when it sends it to the database. <!-- end generic documentation -->
- Parameters:
parameterIndex
- the first parameter is 1, the second is 2, ...x
- the parameter value
public void setString(int parameterIndex, String x) throws SQLException
<!-- start generic documentation --> Sets the designated parameter to the given JavaString
value. The driver converts this to an SQLVARCHAR
orLONGVARCHAR
value (depending on the argument's size relative to the driver's limits onVARCHAR
values) when it sends it to the database. <!-- end generic documentation --> <!-- start release-specific documentation --><!-- start release-specific documentation -->HSQLDB-Specific Information:
Including 1.7.2, HSQLDB stores all XXXCHAR values as java.lang.String objects; there is no appreciable difference between CHAR, VARCHAR and LONGVARCHAR.
- Parameters:
parameterIndex
- the first parameter is 1, the second is 2, ...x
- the parameter value
public void setTime(int parameterIndex, Time x) throws SQLException
<!-- start generic documentation --> Sets the designated parameter to the givenjava.sql.Time
value. The driver converts this to an SQLTIME
value when it sends it to the database. <!-- end generic documentation -->
- Parameters:
parameterIndex
- the first parameter is 1, the second is 2, ...x
- the parameter value
public void setTime(int parameterIndex, Time x, Calendar cal) throws SQLException
<!-- start generic documentation --> Sets the designated parameter to the givenjava.sql.Time
value, using the givenCalendar
object. The driver uses theCalendar
object to construct an SQLTIME
value, which the driver then sends to the database. With a aCalendar
object, the driver can calculate the time taking into account a custom timezone. If noCalendar
object is specified, the driver uses the default timezone, which is that of the virtual machine running the application. <!-- end generic documentation -->
- Parameters:
parameterIndex
- the first parameter is 1, the second is 2, ...x
- the parameter valuecal
- theCalendar
object the driver will use to construct the time
- Since:
- JDK 1.2 (JDK 1.1.x developers: read the new overview for jdbcPreparedStatement)
public void setTimestamp(int parameterIndex, Timestamp x) throws SQLException
<!-- start generic documentation --> Sets the designated parameter to the givenjava.sql.Timestamp
value. The driver converts this to an SQLTIMESTAMP
value when it sends it to the database. <!-- end generic documentation -->
- Parameters:
parameterIndex
- the first parameter is 1, the second is 2, ...x
- the parameter value
public void setTimestamp(int parameterIndex, Timestamp x, Calendar cal) throws SQLException
<!-- start generic documentation --> Sets the designated parameter to the givenjava.sql.Timestamp
value, using the givenCalendar
object. The driver uses theCalendar
object to construct an SQLTIMESTAMP
value, which the driver then sends to the database. With aCalendar
object, the driver can calculate the timestamp taking into account a custom timezone. If noCalendar
object is specified, the driver uses the default timezone, which is that of the virtual machine running the application. <!-- end generic documentation -->
- Parameters:
parameterIndex
- the first parameter is 1, the second is 2, ...x
- the parameter valuecal
- theCalendar
object the driver will use to construct the timestamp
- Since:
- JDK 1.2 (JDK 1.1.x developers: read the new overview for jdbcPreparedStatement)
public void setURL(int parameterIndex, java.net.URL x) throws SQLException
<!-- start generic documentation --> Sets the designated parameter to the givenjava.net.URL
value. The driver converts this to an SQLDATALINK
value when it sends it to the database. <!-- end generic documentation --> <!-- start release-specific documentation --><!-- end release-specific documentation -->HSQLDB-Specific Information:
HSQLDB 1.7.2 does not support the DATALINK SQL type for which this method is intended. Calling this method throws an exception.
- Parameters:
parameterIndex
- the first parameter is 1, the second is 2, ...x
- thejava.net.URL
object to be set
- Since:
- JDK 1.4, HSQL 1.7.0
public void setUnicodeStream(int parameterIndex, java.io.InputStream x, int length) throws SQLException
Deprecated. Sun does not include a reason, but presumably this is because setCharacterStream is now prefered
<!-- start generic documentation --> 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 aLONGVARCHAR
parameter, it may be more practical to send it via ajava.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. <!-- end generic documentation --> <!-- start release-specific documentation --><!-- end release-specific documentation -->HSQLDB-Specific Information:
Since 1.7.0, this method complies with behavior as defined by the JDBC3 specification.
- Parameters:
parameterIndex
- the first parameter is 1, the second is 2, ...x
- ajava.io.InputStream
object that contains the Unicode parameter value as two-byte Unicode characterslength
- the number of bytes in the stream
public String toString()
Retrieves a String representation of this object. The representation is of the form: class-name@hash[sql=[char-sequence], parameters=[p1, ...pi, ...pn]] p1, ...pi, ...pn are the String representations of the currently set parameter values that will be used with the non-batch execution methods.
- Returns:
- a String representation of this object