org.hsqldb.jdbc.jdbcStatement
org.hsqldb.jdbc.jdbcPreparedStatement
|
|||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||
java.lang.Object
An object that represents a precompiled SQL statement.
An SQL statement is precompiled and stored in a
PreparedStatement object. This object can then be used to
efficiently execute this statement multiple times.
Note: The setter methods (setShort,
setString, and so on) for setting IN parameter values
must specify types that are compatible with the defined SQL type of
the input parameter. For instance, if the IN parameter has SQL type
INTEGER, then the method setInt should be
used.
If arbitrary parameter type conversions are required, the method
setObject should be used with a target SQL type.
In the following example of setting a parameter, con
represents an active connection:
PreparedStatement pstmt = con.prepareStatement("UPDATE EMPLOYEES
SET SALARY = ? WHERE ID = ?");
pstmt.setBigDecimal(1, 153833.00)
pstmt.setInt(2, 110592)
Multi thread use:
A PreparedStatement object is stateful and should not normally be shared by multiple threads. If it has to be shared, the calls to set the parameters, calls to add batch statements, the execute call and any post-execute calls should be made within a block synchronized on the PreparedStatement Object.
JRE 1.1.x Notes:
In general, JDBC 2 support requires Java 1.2 and above, and JDBC3 requires Java 1.4 and above. In HSQLDB, support for methods introduced in different versions of JDBC depends on the JDK version used for compiling and building HSQLDB.
Since 1.7.0, it is possible to build the product so that
all JDBC 2 methods can be called while executing under the version 1.1.x
Java Runtime EnvironmentTM.
However, in addition to requiring explicit casts to the org.hsqldb.jdbcXXX
interface implementations, some of these method calls require
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
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)
(boucherb@users)
jdbcConnection.prepareStatement(java.lang.String),
jdbcResultSet| Field Summary | |
protected boolean |
isRowCount
Whether this statement generates only a single row update count in response to execution. |
protected int[] |
parameterModes
The (IN, IN OUT, or OUT) modes of parameters |
protected int[] |
parameterTypes
The SQL types of the parameters. |
protected Object[] |
parameterValues
The parameter values for the next non-batch execution. |
protected Object |
pmd
This object's one and only ParameterMetaData object. |
protected Result |
pmdDescriptor
Description of parameter metadata. |
protected jdbcResultSetMetaData |
rsmd
This object's one and one ResultSetMetaData object. |
protected Result |
rsmdDescriptor
Description of result set metadata. |
protected String |
sql
The SQL character sequence that this object represents. |
protected int |
statementID
The id with which this object's corresponding CompiledStatement object is registered in the engine's CompiledStatementManager object. |
| Fields inherited from class org.hsqldb.jdbc.jdbcStatement |
batchResultOut, connection, maxRows, resultIn, resultOut, rsType |
| 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 | |
void |
addBatch()
Adds a set of parameters to this PreparedStatement
object's batch of commands. |
void |
addBatch(String sql)
This method should always throw if called for a PreparedStatement or CallableStatment. |
protected void |
checkIsRowCount(boolean yes)
Checks if execution does or does not generate a single row update count, throwing if the argument, yes, does not match. |
protected void |
checkSetParameterIndex(int i)
Checks if the specified parameter index value is valid in terms of setting an IN or IN OUT parameter value. |
void |
clearParameters()
Clears the current parameter values immediately. |
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 the SQL statement in this PreparedStatement
object, which may be any kind of SQL statement.
|
boolean |
execute(String sql)
This method should always throw if called for a PreparedStatement or CallableStatment. |
ResultSet |
executeQuery()
Executes the SQL query in this PreparedStatement object
and returns the ResultSet object generated by the query. |
ResultSet |
executeQuery(String sql)
This method should always throw if called for a PreparedStatement or CallableStatment. |
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 sql)
This method should always throw if called for a PreparedStatement or CallableStatment. |
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 i,
Array x)
Sets the designated parameter to the given Array object.
|
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 |
setBigDecimal(int parameterIndex,
BigDecimal x)
Sets the designated parameter to the given java.math.BigDecimal value.
|
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 |
setBlob(int i,
Blob x)
Sets the designated parameter to the given Blob 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 paramIndex,
byte[] x)
Sets the designated parameter to the given Java array of bytes. |
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 |
setClob(int i,
Clob x)
Sets the designated parameter to the given Clob 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 |
setEscapeProcessing(boolean enable)
Sets escape processing on or off. |
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 |
setNull(int paramIndex,
int sqlType)
Sets the designated parameter to SQL NULL. |
void |
setNull(int paramIndex,
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 i,
Ref x)
Sets the designated parameter to the given REF(<structured-type>) value.
|
void |
setShort(int parameterIndex,
short x)
Sets the designated parameter to the given Java short
value. |
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. Sun does not include a reason, but presumably this is because setCharacterStream is now prefered |
void |
setURL(int parameterIndex,
URL x)
Sets the designated parameter to the given java.net.URL
value. |
String |
toString()
Retrieves a String representation of this object. |
| Methods inherited from class org.hsqldb.jdbc.jdbcStatement |
cancel, clearBatch, clearWarnings, execute, execute, execute, executeBatch, executeUpdate, executeUpdate, executeUpdate, getConnection, getFetchDirection, getFetchSize, getGeneratedKeys, getMaxFieldSize, getMaxRows, getMoreResults, getMoreResults, getQueryTimeout, getResultSet, getResultSetConcurrency, getResultSetHoldability, getResultSetType, getUpdateCount, getWarnings, setCursorName, setFetchDirection, setFetchSize, setMaxFieldSize, setMaxRows, setQueryTimeout |
| Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
| Field Detail |
protected Object[] parameterValues
protected int[] parameterTypes
protected int[] parameterModes
protected Result rsmdDescriptor
Note that getColumnDisplaySize() will not necessarily the same as that returned by a a retrieved ResultSet object's ResultSetMetaData object. This is because we currently approximate the value by scanning certain columns of the row data to find the approximate max length of the String representation
protected Result pmdDescriptor
protected jdbcResultSetMetaData rsmd
protected Object pmd
protected String sql
protected int statementID
protected boolean isRowCount
| Method Detail |
public void setEscapeProcessing(boolean enable)
throws SQLException
HSQLDB-Specific Information:
Starting with HSQLDB 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.
setEscapeProcessing in interface StatementsetEscapeProcessing in class jdbcStatementenable - true to enable escape processing;
false to disable it
SQLException - if a database access error occurs
public boolean execute()
throws SQLException
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
executeQueryand 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).
HSQLDB-Specific Information:
Up to and including HSQLDB 1.7.0, statements never return multiple
result sets.
Starting with HSQLDB 1.7.2, statements may return multiple result
sets under certain conditions.
With 1.7.2 (contrary to the generic documentation above) support for
preparation of DDL statements and character sequences representing
multiple SQL commands is not available. Support for preparation of
single, non-parametric DDL commands may become supported before the
final release of 1.7.2 or in a subsequent point release. Limited support
for parametric DDL may or may not become supported.
execute in interface PreparedStatementtrue if the first result is a ResultSet
object; false if the first result is an update
count or there is no result
SQLException - if a database access error occurs or an argument
is supplied to this methodjdbcStatement.execute(java.lang.String),
jdbcStatement.getResultSet(),
jdbcStatement.getUpdateCount(),
jdbcStatement.getMoreResults()
public ResultSet executeQuery()
throws SQLException
PreparedStatement object
and returns the ResultSet object generated by the query.
executeQuery in interface PreparedStatementResultSet object that contains the data produced
by the query; never null
SQLException - if a database access error occurs or the SQL
statement does not return a ResultSet object
public int executeUpdate()
throws SQLException
PreparedStatement
object, which must be an SQL INSERT,
UPDATE or DELETE statement; or an SQL
statement that returns nothing, such as a DDL statement.
executeUpdate in interface PreparedStatementINSERT,
UPDATE, or DELETE
statements or (2) 0 for SQL statements that
return nothing
SQLException - if a database access error occurs or the SQL
statement returns a ResultSet object
public void setNull(int paramIndex,
int sqlType)
throws SQLException
NULL. Note: You must specify the parameter's SQL type.
HSQLDB-Specific Information:
Up to HSQLDB 1.7.2, the sqlType argument is ignored.
setNull in interface PreparedStatementparamIndex - the first parameter is 1, the second is 2, ...sqlType - the SQL type code defined in java.sql.Types
SQLException - if a database access error occurs
public void setBoolean(int parameterIndex,
boolean x)
throws SQLException
boolean
value. The driver converts this to an SQL BIT value
when it sends it to the database.
HSQLDB-Specific Information:
HSQLDB 1.7.2 uses the BOOLEAN type instead of BIT.
setBoolean in interface PreparedStatementparameterIndex - the first parameter is 1, the second is 2, ...x - the parameter value
SQLException - if a database access error occurs
public void setByte(int parameterIndex,
byte x)
throws SQLException
byte value.
The driver converts this to an SQL TINYINT value when
it sends it to the database.
setByte in interface PreparedStatementparameterIndex - the first parameter is 1, the second is 2, ...x - the parameter value
SQLException - if a database access error occurs
public void setShort(int parameterIndex,
short x)
throws SQLException
short
value. The driver converts this to an SQL SMALLINT
value when it sends it to the database.
setShort in interface PreparedStatementparameterIndex - the first parameter is 1, the second is 2, ...x - the parameter value
SQLException - if a database access error occurs
public void setInt(int parameterIndex,
int x)
throws SQLException
int value.
The driver converts this to an SQL INTEGER value when
it sends it to the database.
setInt in interface PreparedStatementparameterIndex - the first parameter is 1, the second is 2, ...x - the parameter value
SQLException - if a database access error occurs
public void setLong(int parameterIndex,
long x)
throws SQLException
long value.
The driver converts this to an SQL BIGINT value when
it sends it to the database.
setLong in interface PreparedStatementparameterIndex - the first parameter is 1, the second is 2, ...x - the parameter value
SQLException - if a database access error occurs
public void setFloat(int parameterIndex,
float x)
throws SQLException
float value.
The driver converts this to an SQL FLOAT value when
it sends it to the database.
HSQLDB-Specific Information:
With 1.7.1 and greater, HSQLDB handleS Java positive/negative Infinity or
NaN
float values properly. These values are sent to the
database and stored there.
setFloat in interface PreparedStatementparameterIndex - the first parameter is 1, the second is 2, ...x - the parameter value
SQLException - if a database access error occurs
public void setDouble(int parameterIndex,
double x)
throws SQLException
double value.
The driver converts this to an SQL DOUBLE value when it
sends it to the database.
HSQLDB-Specific Information:
With 1.7.1 and greater, HSQLDB handleS Java positive/negative Infinity or
NaN
float values properly. These values are sent to the
database and stored there.
setDouble in interface PreparedStatementparameterIndex - the first parameter is 1, the second is 2, ...x - the parameter value
SQLException - if a database access error occurs
public void setBigDecimal(int parameterIndex,
BigDecimal x)
throws SQLException
java.math.BigDecimal value.
The driver converts this to an SQL NUMERIC value when
it sends it to the database.
setBigDecimal in interface PreparedStatementparameterIndex - the first parameter is 1, the second is 2, ...x - the parameter value
SQLException - if a database access error occurs
public void setString(int parameterIndex,
String x)
throws SQLException
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.
HSQLDB-Specific Information:
HSQLDB 1.7.2 stores all XXXCHAR values as
java.lang.String objects, so there is no appreciable difference between
VARCHAR and LONGVARCHAR.
setString in interface PreparedStatementparameterIndex - the first parameter is 1, the second is 2, ...x - the parameter value
SQLException - if a database access error occurs
public void setBytes(int paramIndex,
byte[] x)
throws SQLException
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.
HSQLDB-Specific Information:
HSQLDB stores all XXXBINARY values
the same way and there is no appreciable difference between
VARBINARY and LONGVARBINARY.
setBytes in interface PreparedStatementparamIndex - the first parameter is 1, the second is 2, ...x - the parameter value
SQLException - if a database access error occurs
public void setDate(int parameterIndex,
Date x)
throws SQLException
java.sql.Date value. The driver converts this
to an SQL DATE value when it sends it to the database.
setDate in interface PreparedStatementparameterIndex - the first parameter is 1, the second is 2, ...x - the parameter value
SQLException - if a database access error occurs
public void setTime(int parameterIndex,
Time x)
throws SQLException
java.sql.Time
value. The driver converts this to an SQL TIME value when it
sends it to the database.
setTime in interface PreparedStatementparameterIndex - the first parameter is 1, the second is 2, ...x - the parameter value
SQLException - if a database access error occurs
public void setTimestamp(int parameterIndex,
Timestamp x)
throws SQLException
java.sql.Timestamp value. The driver converts this to
an SQL TIMESTAMP value when it sends it to the
database.
setTimestamp in interface PreparedStatementparameterIndex - the first parameter is 1, the second is 2, ...x - the parameter value
SQLException - if a database access error occurs
public void setAsciiStream(int parameterIndex,
InputStream x,
int length)
throws SQLException
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.
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 and
setUnicodeStream were identical.
setAsciiStream in interface PreparedStatementparameterIndex - 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
SQLException - if a database access error occurs
public void setUnicodeStream(int parameterIndex,
InputStream x,
int length)
throws SQLException
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.
HSQLDB-Specific Information:
Beginning with HSQLDB 1.7.0, this method complies with behavior as
defined by the JDBC3 specification.
setUnicodeStream in interface PreparedStatementparameterIndex - 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 characterslength - the number of bytes in the stream
SQLException - if a database access error occurs
public void setBinaryStream(int parameterIndex,
InputStream x,
int length)
throws SQLException
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.
HSQLDB-Specific Information:
Starting with 1.7.2, this method works according to the standard.
setBinaryStream in interface PreparedStatementparameterIndex - 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
SQLException - if a database access error occurs
public void clearParameters()
throws SQLException
In general, parameter values remain in force for repeated use of a
statement. Setting a parameter value automatically clears its
previous value. However, in some cases it is useful to immediately
release the resources used by the current parameter values; this can
be done by calling the method clearParameters.
clearParameters in interface PreparedStatementSQLException - if a database access error occurs
public void setObject(int parameterIndex,
Object x,
int targetSqlType,
int scale)
throws SQLException
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.
HSQLDB-Specific Information:
Up to and including HSQLDB 1.7.1, calling this method is identical to
In 1.7.2, this method supports conversions listed in the conversion
table B-5 of the JDBC 3 specification. The scale argument is not
used.
setObject(int, Object, int).
That is, this method simply calls setObject(int, Object, int),
ignoring the scale specification.
setObject in interface PreparedStatementparameterIndex - 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.
SQLException - if a database access error occursTypes,
setObject(int,Object,int)
public void setObject(int parameterIndex,
Object x,
int targetSqlType)
throws SQLException
setObject
above, except that it assumes a scale of zero.
HSQLDB-Specific Information:
In 1.7.2, this method supports conversions listed in the conversion
table B-5 of the JDBC 3 specification.
setObject in interface PreparedStatementparameterIndex - 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
SQLException - if a database access error occurssetObject(int,Object)
public void setObject(int parameterIndex,
Object x)
throws SQLException
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.
HSQLDB-Specific Information:
In 1.7.2, this method supports conversions listed in the conversion
table B-5 of the JDBC 3 specification.
setObject in interface PreparedStatementparameterIndex - the first parameter is 1, the second is 2, ...x - the object containing the input parameter value
SQLException - if a database access error occurs or the type
of the given object is ambiguous
public void addBatch()
throws SQLException
PreparedStatement
object's batch of commands.
HSQLDB-Specific Information:
Since HSQLDB 1.7.2, this feature is supported.
addBatch in interface PreparedStatementSQLException - if a database access error occursjdbcStatement.addBatch(java.lang.String)
public void setCharacterStream(int parameterIndex,
Reader reader,
int length)
throws SQLException
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.
HSQLDB-Specific Information:
HSQLDB stores CHARACTER and related SQL types as Unicode so
this method does not perform any conversion.
setCharacterStream in interface PreparedStatementparameterIndex - the first parameter is 1, the second is 2, ...reader - the java.io.Reader object that contains the
Unicode datalength - the number of characters in the stream
SQLException - if a database access error occurs
public void setRef(int i,
Ref x)
throws SQLException
REF(<structured-type>) value.
The driver converts this to an SQL REF value when it
sends it to the database.
HSQLDB-Specific Information:
HSQLDB 1.7.2 does not support the SQL REF type. Calling this method
throws an exception.
setRef in interface PreparedStatementi - the first parameter is 1, the second is 2, ...x - an SQL REF value
SQLException - if a database access error occurs
public void setBlob(int i,
Blob x)
throws SQLException
Blob object.
The driver converts this to an SQL BLOB value when it
sends it to the database.
HSQLDB-Specific Information:
Up to and including HSQLDB 1.7.1, this feature is not supported.
Starting with 1.7.2, setBlob is supported for Blob objects 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());
setBlob in interface PreparedStatementi - the first parameter is 1, the second is 2, ...x - a Blob object that maps an SQL BLOB
value
SQLException - if a database access error occurs
public void setClob(int i,
Clob x)
throws SQLException
Clob object.
The driver converts this to an SQL CLOB value when it
sends it to the database.
HSQLDB-Specific Information:
Up to and including HSQLDB 1.7.1, this feature was not supported.
Starting with 1.7.2, setClob is supported for Clob objects 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());
setClob in interface PreparedStatementi - the first parameter is 1, the second is 2, ...x - a Clob object that maps an SQL CLOB
value
SQLException - if a database access error occurs
public void setArray(int i,
Array x)
throws SQLException
Array object.
The driver converts this to an SQL ARRAY value when it
sends it to the database.
HSQLDB-Specific Information:
HSQLDB 1.7.2 does not support the SQL ARRAY type. Calling this method
throws an exception.
setArray in interface PreparedStatementi - the first parameter is 1, the second is 2, ...x - an Array object that maps an SQL ARRAY
value
SQLException - if a database access error occurs
public ResultSetMetaData getMetaData()
throws SQLException
ResultSetMetaData object that contains
information about the columns of the ResultSet object
that will be returned when this PreparedStatement object
is executed.
Because a PreparedStatement object is precompiled, it is
possible to know about the ResultSet object that it will
return without having to execute it. Consequently, it is possible
to invoke the method getMetaData on a
PreparedStatement object rather than waiting to execute
it and then invoking the ResultSet.getMetaData method
on the ResultSet object that is returned.
NOTE: Using this method may be expensive for some drivers due to the lack of underlying DBMS support.
HSQLDB-Specific Information:
Starting with HSQLDB 1.7.2, this feature is supported. If the statement
generates an update count, then null is returned.
getMetaData in interface PreparedStatementResultSet object's columns or
null if the driver cannot return a
ResultSetMetaData object
SQLException - if a database access error occurs
public void setDate(int parameterIndex,
Date x,
Calendar cal)
throws SQLException
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
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.
setDate in interface PreparedStatementparameterIndex - the first parameter is 1, the second is 2, ...x - the parameter valuecal - the Calendar object the driver will use
to construct the date
SQLException - if a database access error occurs
public void setTime(int parameterIndex,
Time x,
Calendar cal)
throws SQLException
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
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.
setTime in interface PreparedStatementparameterIndex - the first parameter is 1, the second is 2, ...x - the parameter valuecal - the Calendar object the driver will use
to construct the time
SQLException - if a database access error occurs
public void setTimestamp(int parameterIndex,
Timestamp x,
Calendar cal)
throws SQLException
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.
setTimestamp in interface PreparedStatementparameterIndex - the first parameter is 1, the second is 2, ...x - the parameter valuecal - the Calendar object the driver will use
to construct the timestamp
SQLException - if a database access error occurs
public void setNull(int paramIndex,
int sqlType,
String typeName)
throws SQLException
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.
HSQLDB-Specific Information:
HSQLDB ignores the typeName argument.
setNull in interface PreparedStatementparamIndex - the first parameter is 1, the second is 2, ...sqlType - a value from java.sql.TypestypeName - the fully-qualified name of an SQL user-defined type;
ignored if the parameter is not a user-defined type or REF
SQLException - if a database access error occurs
public void setURL(int parameterIndex,
URL x)
throws SQLException
java.net.URL
value. The driver converts this to an SQL DATALINK value
when it sends it to the database.
HSQLDB-Specific Information:
HSQLDB 1.7.2 does not support DATALINK SQL type for which this method
is intended. Calling this method throws an exception.
setURL in interface PreparedStatementparameterIndex - the first parameter is 1, the second is 2, ...x - the java.net.URL object to be set
SQLException - if a database access error occurs
public ParameterMetaData getParameterMetaData()
throws SQLException
PreparedStatement object's parameters.
HSQLDB-Specific Information:
Starting with HSQLDB 1.7.2, this feature is supported.
getParameterMetaData in interface PreparedStatementParameterMetaData object that contains information
about the number, types and properties of this
PreparedStatement object's parameters
SQLException - if a database access error occursParameterMetaData
protected void checkIsRowCount(boolean yes)
throws SQLException
yes - if true, check that execution generates a single
row update count, else check that execution generates
something other than a single row update count.
SQLException - if the argument, yes, does not match
protected void checkSetParameterIndex(int i)
throws SQLException
i - The parameter index to check
SQLException - if the specified parameter index is invalid
public void addBatch(String sql)
throws SQLException
addBatch in interface StatementaddBatch in class jdbcStatementsql - ignored
SQLException - alwaysjdbcStatement.executeBatch()
public ResultSet executeQuery(String sql)
throws SQLException
executeQuery in interface StatementexecuteQuery in class jdbcStatementsql - ignored
SQLException - always
public boolean execute(String sql)
throws SQLException
execute in interface Statementexecute in class jdbcStatementsql - ignored
SQLException - alwaysjdbcStatement.getResultSet(),
jdbcStatement.getUpdateCount(),
jdbcStatement.getMoreResults()
public int executeUpdate(String sql)
throws SQLException
executeUpdate in interface StatementexecuteUpdate in class jdbcStatementsql - ignored
SQLException - always
public void close()
throws SQLException
jdbcStatementStatement 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 Statement
object that is already closed has no effect.
Note: A Statement 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.
HSQLDB-Specific Information:
close in interface Statementclose in class jdbcStatementSQLException - if a database access error occurspublic String toString()
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.
|
|||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||