public class JDBCPreparedStatement
extends java.lang.Object
implements java.sql.PreparedStatement
A 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)
From version 2.0, the implementation meets the JDBC specification requirement that any existing ResultSet is closed when execute() or executeQuery() methods are called. The connection property close_result=true is required for this behaviour.
JDBCPreparedStatement objects are backed by a true compiled parameteric representation. Hence, there are now significant performance gains to be had by using a JDBCPreparedStatement object in preference to a JDBCStatement object when a short-running SQL statement is to be executed more than once.
When it can be otherwise avoided, it should be considered poor practice to fully prepare (construct), parameterize, execute, fetch and close a JDBCParameterMetaData object for each execution cycle. Indeed, because the prepare and execute phases both represent a round-trip to the engine, this practice is likely to be noticeably less performant for short-running statements (and possibly even orders of magnitude less performant over network connections for short-running statements) than the equivalent process using JDBCStatement objects, albeit far more convenient, less error prone and certainly much less resource-intensive, especially when large binary and character values are involved, due to the optimized parameterization facility.
Instead, when developing an application that is not totally oriented toward the execution of ad hoc SQL, it is recommended to expend some effort toward identifying the SQL statements that are good candidates for regular reuse and adapting the structure of the application accordingly. Often, this is done by recording the text of candidate SQL statements in an application resource object (which has the nice side-benefit of isolating and hiding differences in SQL dialects across different drivers) and caching for possible reuse the PreparedStatement objects derived from the recorded text.
Starting with 2.0, when built under a JDBC 4 environment, statement caching can be transparently enabled or disabled on a statement-by-statement basis by invoking setPoolable(true | false), respectively, upon Statement objects of interest.
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.
(fredt@users)
(campbell-burnet@users)
JDBCConnection.prepareStatement(java.lang.String),
JDBCResultSet| Modifier and Type | Method and Description |
|---|---|
void |
addBatch()
Adds a set of parameters to this
PreparedStatement
object's batch of commands. |
void |
addBatch(java.lang.String sql)
This method should always throw if called for a PreparedStatement or
CallableStatement.
|
void |
cancel()
Cancels this
Statement object if both the DBMS and
driver support aborting an SQL statement. |
void |
clearBatch()
Empties this
Statement object's current list of
SQL commands. |
void |
clearParameters()
Clears the current parameter values immediately.
|
void |
clearWarnings()
Clears all the warnings reported on this
Statement
object. |
void |
close()
Does the specialized work required to free this object's resources and
that of it's parent class.
|
void |
closeOnCompletion()
Specifies that this
Statement will be closed when all its
dependent result sets are closed. |
boolean |
execute()
Executes the SQL statement in this
PreparedStatement object,
which may be any kind of SQL statement. |
boolean |
execute(java.lang.String sql)
This method should always throw if called for a PreparedStatement or
CallableStatement.
|
boolean |
execute(java.lang.String sql,
int autoGeneratedKeys) |
boolean |
execute(java.lang.String sql,
int[] columnIndexes) |
boolean |
execute(java.lang.String sql,
java.lang.String[] columnNames) |
int[] |
executeBatch()
Submits a batch of commands to the database for execution and
if all commands execute successfully, returns an array of update counts.
|
long |
executeLargeUpdate()
Executes the SQL statement in this
PreparedStatement object,
which must be an SQL Data Manipulation Language (DML) statement,
such as INSERT, UPDATE or
DELETE; or an SQL statement that returns nothing,
such as a DDL statement. |
java.sql.ResultSet |
executeQuery()
Executes the SQL query in this
PreparedStatement object
and returns the ResultSet object generated by the query. |
java.sql.ResultSet |
executeQuery(java.lang.String sql)
This method should always throw if called for a PreparedStatement or
CallableStatement.
|
int |
executeUpdate()
Executes the SQL statement in this
PreparedStatement object,
(JDBC4 clarification:)
which must be an SQL Data Manipulation Language (DML) statement, such as INSERT, UPDATE or
DELETE; or an SQL statement that returns nothing,
such as a DDL statement. |
int |
executeUpdate(java.lang.String sql)
This method should always throw if called for a PreparedStatement or
CallableStatement.
|
int |
executeUpdate(java.lang.String sql,
int autoGeneratedKeys)
Statement methods that must be overridden in this class and throw
an exception.
|
int |
executeUpdate(java.lang.String sql,
int[] columnIndexes) |
int |
executeUpdate(java.lang.String sql,
java.lang.String[] columnNames) |
java.sql.Connection |
getConnection()
Retrieves the
Connection object
that produced this Statement object. |
int |
getFetchDirection()
Retrieves the direction for fetching rows from
database tables that is the default for result sets
generated from this
Statement object. |
int |
getFetchSize()
Retrieves the number of result set rows that is the default
fetch size for
ResultSet objects
generated from this Statement object. |
java.sql.ResultSet |
getGeneratedKeys()
Retrieves any auto-generated keys created as a result of executing this
Statement object. |
int |
getMaxFieldSize()
Retrieves the maximum number of bytes that can be
returned for character and binary column values in a
ResultSet
object produced by this Statement object. |
int |
getMaxRows()
Retrieves the maximum number of rows that a
ResultSet object produced by this
Statement object can contain. |
java.sql.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. |
boolean |
getMoreResults()
Moves to this
Statement object's next result, returns
true if it is a ResultSet object, and
implicitly closes any current ResultSet
object(s) obtained with the method getResultSet. |
boolean |
getMoreResults(int current)
Moves to this
Statement object's next result, deals with
any current ResultSet object(s) according to the instructions
specified by the given flag, and returns
true if the next result is a ResultSet object. |
java.sql.ParameterMetaData |
getParameterMetaData()
Retrieves the number, types and properties of this
PreparedStatement object's parameters. |
int |
getQueryTimeout()
Retrieves the number of seconds the driver will
wait for a
Statement object to execute. |
java.sql.ResultSet |
getResultSet()
Retrieves the current result as a
ResultSet object. |
int |
getResultSetConcurrency()
Retrieves the result set concurrency for
ResultSet objects
generated by this Statement object. |
int |
getResultSetHoldability()
Retrieves the result set holdability for
ResultSet objects
generated by this Statement object. |
int |
getResultSetType()
Retrieves the result set type for
ResultSet objects
generated by this Statement object. |
int |
getUpdateCount()
Retrieves the current result as an update count;
if the result is a
ResultSet object or there are no more results, -1
is returned. |
java.sql.SQLWarning |
getWarnings()
Retrieves the first warning reported by calls on this
Statement object. |
boolean |
isClosed()
Retrieves whether this
Statement object has been closed. |
boolean |
isCloseOnCompletion()
Returns a value indicating whether this
Statement will be
closed when all its dependent result sets are closed. |
boolean |
isPoolable()
Returns a value indicating whether the
Statement
is poolable or not. |
boolean |
isWrapperFor(java.lang.Class<?> iface)
Returns true if this either implements the interface argument or is directly or indirectly a wrapper
for an object that does.
|
void |
setArray(int parameterIndex,
java.sql.Array x)
Sets the designated parameter to the given
java.sql.Array object. |
void |
setAsciiStream(int parameterIndex,
java.io.InputStream x)
Sets the designated parameter to the given input stream.
|
void |
setAsciiStream(int parameterIndex,
java.io.InputStream x,
int length)
Sets the designated parameter to the given input stream, which will have
the specified number of bytes.
|
void |
setAsciiStream(int parameterIndex,
java.io.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,
java.math.BigDecimal x)
Sets the designated parameter to the given
java.math.BigDecimal value. |
void |
setBinaryStream(int parameterIndex,
java.io.InputStream x)
Sets the designated parameter to the given input stream.
|
void |
setBinaryStream(int parameterIndex,
java.io.InputStream x,
int length)
Sets the designated parameter to the given input stream, which will have
the specified number of bytes.
|
void |
setBinaryStream(int parameterIndex,
java.io.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,
java.sql.Blob x)
Sets the designated parameter to the given
java.sql.Blob object. |
void |
setBlob(int parameterIndex,
java.io.InputStream inputStream)
Sets the designated parameter to a
InputStream object. |
void |
setBlob(int parameterIndex,
java.io.InputStream inputStream,
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,
java.io.Reader reader)
Sets the designated parameter to the given
Reader
object. |
void |
setCharacterStream(int parameterIndex,
java.io.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,
java.io.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,
java.sql.Clob x)
Sets the designated parameter to the given
java.sql.Clob object. |
void |
setClob(int parameterIndex,
java.io.Reader reader)
Sets the designated parameter to a
Reader object. |
void |
setClob(int parameterIndex,
java.io.Reader reader,
long length)
Sets the designated parameter to a
Reader object. |
void |
setCursorName(java.lang.String name)
Sets the SQL cursor name to the given
String, which
will be used by subsequent Statement object
execute methods. |
void |
setDate(int parameterIndex,
java.sql.Date x)
(JDBC4 clarification:)
Sets the designated parameter to the given
java.sql.Date value
using the default time zone of the virtual machine that is running
the application. |
void |
setDate(int parameterIndex,
java.sql.Date x,
java.util.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 |
setFetchDirection(int direction)
Gives the driver a hint as to the direction in which
rows will be processed in
ResultSet
objects created using this Statement object. |
void |
setFetchSize(int rows)
(JDBC4 clarification:)
Gives the JDBC driver a hint as to the number of rows that should
be fetched from the database when more rows are needed for
ResultSet objects generated by this Statement. |
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 |
setMaxFieldSize(int max)
(JDBC4 clarification:) Sets the limit for the maximum number of bytes in a
ResultSet
Sets the limit for the maximum number of bytes that can be returned for
character and binary column values in a ResultSet
object produced by this Statement object. |
void |
setMaxRows(int max)
(JDBC4 clarification:)
Sets the limit for the maximum number of rows that any
ResultSet object generated by this Statement
object can contain to the given number. |
void |
setNCharacterStream(int parameterIndex,
java.io.Reader value)
Sets the designated parameter to a
Reader object. |
void |
setNCharacterStream(int parameterIndex,
java.io.Reader value,
long length)
Sets the designated parameter to a
Reader object. |
void |
setNClob(int parameterIndex,
java.sql.NClob value)
Sets the designated parameter to a
java.sql.NClob object. |
void |
setNClob(int parameterIndex,
java.io.Reader reader)
Sets the designated parameter to a
Reader object. |
void |
setNClob(int parameterIndex,
java.io.Reader reader,
long length)
Sets the designated parameter to a
Reader object. |
void |
setNString(int parameterIndex,
java.lang.String value)
Sets the designated parameter to the given
String object. |
void |
setNull(int parameterIndex,
int sqlType)
Sets the designated parameter to SQL
NULL. |
void |
setNull(int parameterIndex,
int sqlType,
java.lang.String typeName)
Sets the designated parameter to SQL
NULL. |
void |
setObject(int parameterIndex,
java.lang.Object x) |
void |
setObject(int parameterIndex,
java.lang.Object x,
int targetSqlType)
Sets the value of the designated parameter with the given object.
|
void |
setObject(int parameterIndex,
java.lang.Object x,
int targetSqlType,
int scaleOrLength)
Sets the value of the designated parameter with the given object.
|
void |
setPoolable(boolean poolable)
Requests that a
Statement be pooled or not pooled. |
void |
setQueryTimeout(int seconds)
Sets the number of seconds the driver will wait for a
Statement object to execute to the given number of seconds. |
void |
setRef(int parameterIndex,
java.sql.Ref x)
Sets the designated parameter to the given
REF(<structured-type>) value. |
void |
setRowId(int parameterIndex,
java.sql.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,
java.sql.SQLXML xmlObject)
Sets the designated parameter to the given
java.sql.SQLXML object. |
void |
setString(int parameterIndex,
java.lang.String x)
Sets the designated parameter to the given Java
String value. |
void |
setTime(int parameterIndex,
java.sql.Time x)
Sets the designated parameter to the given
java.sql.Time value. |
void |
setTime(int parameterIndex,
java.sql.Time x,
java.util.Calendar cal)
Sets the designated parameter to the given
java.sql.Time value,
using the given Calendar object. |
void |
setTimestamp(int parameterIndex,
java.sql.Timestamp x)
Sets the designated parameter to the given
java.sql.Timestamp value. |
void |
setTimestamp(int parameterIndex,
java.sql.Timestamp x,
java.util.Calendar cal)
Sets the designated parameter to the given
java.sql.Timestamp value,
using the given Calendar object. |
void |
setUnicodeStream(int parameterIndex,
java.io.InputStream x,
int length)
Deprecated.
Sun does not include a reason, but presumably
this is because setCharacterStream is now preferred
|
void |
setURL(int parameterIndex,
java.net.URL x)
Sets the designated parameter to the given
java.net.URL value. |
java.lang.String |
toString()
Retrieves a String representation of this object.
|
<T> T |
unwrap(java.lang.Class<T> iface)
Returns an object that implements the given interface to allow access to
non-standard methods, or standard methods not exposed by the proxy.
|
public java.sql.ResultSet executeQuery()
throws java.sql.SQLException
PreparedStatement object
and returns the ResultSet object generated by the query.
executeQuery in interface java.sql.PreparedStatementResultSet object that contains the data produced by the
query; never nulljava.sql.SQLException - if a database access error occurs,
this method is called on a closed PreparedStatement or the SQL
statement does not return a ResultSet objectpublic int executeUpdate()
throws java.sql.SQLException
PreparedStatement object,
(JDBC4 clarification:)
which must be an SQL Data Manipulation Language (DML) statement, such as INSERT, UPDATE or
DELETE; or an SQL statement that returns nothing,
such as a DDL statement.
executeUpdate in interface java.sql.PreparedStatementjava.sql.SQLException - if a database access error occurs,
this method is called on a closed PreparedStatement
or the SQL
statement returns a ResultSet objectpublic void setNull(int parameterIndex,
int sqlType)
throws java.sql.SQLException
NULL.
Note: You must specify the parameter's SQL type.
HSQLDB currently ignores the sqlType argument.
setNull in interface java.sql.PreparedStatementparameterIndex - the first parameter is 1, the second is 2, ...sqlType - the SQL type code defined in java.sql.Typesjava.sql.SQLException - if a database access error occurs or
this method is called on a closed PreparedStatementjava.sql.SQLFeatureNotSupportedException - if sqlType is
a ARRAY, BLOB, CLOB,
DATALINK, JAVA_OBJECT, NCHAR,
NCLOB, NVARCHAR, LONGNVARCHAR,
REF, ROWID, SQLXML
or STRUCT data type and the JDBC driver does not support
this data typepublic void setBoolean(int parameterIndex,
boolean x)
throws java.sql.SQLException
boolean value.
The driver converts this
(JDBC4 Modified:)
to an SQL BIT or BOOLEAN value when it sends it to the database.
HSQLDB supports BOOLEAN type for boolean values. This method can also be used to set the value of a parameter of the SQL type BIT(1), which is a bit string consisting of a 0 or 1.
setBoolean in interface java.sql.PreparedStatementparameterIndex - the first parameter is 1, the second is 2, ...x - the parameter valuejava.sql.SQLException - if a database access error occurs or
this method is called on a closed PreparedStatementpublic void setByte(int parameterIndex,
byte x)
throws java.sql.SQLException
byte value.
The driver converts this
to an SQL TINYINT value when it sends it to the database.
setByte in interface java.sql.PreparedStatementparameterIndex - the first parameter is 1, the second is 2, ...x - the parameter valuejava.sql.SQLException - if a database access error occurs or
this method is called on a closed PreparedStatementpublic void setShort(int parameterIndex,
short x)
throws java.sql.SQLException
short value.
The driver converts this
to an SQL SMALLINT value when it sends it to the database.
setShort in interface java.sql.PreparedStatementparameterIndex - the first parameter is 1, the second is 2, ...x - the parameter valuejava.sql.SQLException - if a database access error occurs or
this method is called on a closed PreparedStatementpublic void setInt(int parameterIndex,
int x)
throws java.sql.SQLException
int value.
The driver converts this
to an SQL INTEGER value when it sends it to the database.
setInt in interface java.sql.PreparedStatementparameterIndex - the first parameter is 1, the second is 2, ...x - the parameter valuejava.sql.SQLException - if a database access error occurs or
this method is called on a closed PreparedStatementpublic void setLong(int parameterIndex,
long x)
throws java.sql.SQLException
long value.
The driver converts this
to an SQL BIGINT value when it sends it to the database.
setLong in interface java.sql.PreparedStatementparameterIndex - the first parameter is 1, the second is 2, ...x - the parameter valuejava.sql.SQLException - if a database access error occurs or
this method is called on a closed PreparedStatementpublic void setFloat(int parameterIndex,
float x)
throws java.sql.SQLException
float value.
The driver converts this
(JDBC4 correction:)
to an SQL REAL value when it sends it to the database.
Since 1.7.1, HSQLDB handles Java positive/negative Infinity
and NaN float values consistent with the Java Language
Specification; these special values are now correctly stored
to and retrieved from the database.
setFloat in interface java.sql.PreparedStatementparameterIndex - the first parameter is 1, the second is 2, ...x - the parameter valuejava.sql.SQLException - if a database access error occurs or
this method is called on a closed PreparedStatementpublic void setDouble(int parameterIndex,
double x)
throws java.sql.SQLException
double value.
The driver converts this
to an SQL DOUBLE value when it sends it to the database.
Since 1.7.1, HSQLDB handles Java positive/negative Infinity
and NaN double values consistent with the Java Language
Specification; these special values are now correctly stored
to and retrieved from the database.
setDouble in interface java.sql.PreparedStatementparameterIndex - the first parameter is 1, the second is 2, ...x - the parameter valuejava.sql.SQLException - if a database access error occurs or
this method is called on a closed PreparedStatementpublic void setBigDecimal(int parameterIndex,
java.math.BigDecimal x)
throws java.sql.SQLException
java.math.BigDecimal value.
The driver converts this to an SQL NUMERIC value when
it sends it to the database.
setBigDecimal in interface java.sql.PreparedStatementparameterIndex - the first parameter is 1, the second is 2, ...x - the parameter valuejava.sql.SQLException - if a database access error occurs or
this method is called on a closed PreparedStatementpublic void setString(int parameterIndex,
java.lang.String x)
throws java.sql.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.
Including 2.0, HSQLDB represents all XXXCHAR values internally as java.lang.String objects; there is no appreciable difference between CHAR, VARCHAR and LONGVARCHAR.
setString in interface java.sql.PreparedStatementparameterIndex - the first parameter is 1, the second is 2, ...x - the parameter valuejava.sql.SQLException - if a database access error occurs or
this method is called on a closed PreparedStatementpublic void setBytes(int parameterIndex,
byte[] x)
throws java.sql.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.
Including 2.0, HSQLDB represents all XXXBINARY values the same way internally; there is no appreciable difference between BINARY, VARBINARY and LONGVARBINARY as far as JDBC is concerned.
setBytes in interface java.sql.PreparedStatementparameterIndex - the first parameter is 1, the second is 2, ...x - the parameter valuejava.sql.SQLException - if a database access error occurs or
this method is called on a closed PreparedStatementpublic void setDate(int parameterIndex,
java.sql.Date x)
throws java.sql.SQLException
java.sql.Date value
using the default time zone of the virtual machine that is running
the application.
The driver converts this
to an SQL DATE value when it sends it to the database.
When a setXXX method is used to set a parameter of type TIMESTAMP WITH TIME ZONE or TIME WITH TIME ZONE the time zone of the client application is used as time zone
setDate in interface java.sql.PreparedStatementparameterIndex - the first parameter is 1, the second is 2, ...x - the parameter valuejava.sql.SQLException - if a database access error occurs or
this method is called on a closed PreparedStatementpublic void setTime(int parameterIndex,
java.sql.Time x)
throws java.sql.SQLException
java.sql.Time value.
The driver converts this
to an SQL TIME value when it sends it to the database.
When a setXXX method is used to set a parameter of type TIMESTAMP WITH TIME ZONE or TIME WITH TIME ZONE the time zone of the client application is used as time zone
setTime in interface java.sql.PreparedStatementparameterIndex - the first parameter is 1, the second is 2, ...x - the parameter valuejava.sql.SQLException - if a database access error occurs or
this method is called on a closed PreparedStatementpublic void setTimestamp(int parameterIndex,
java.sql.Timestamp x)
throws java.sql.SQLException
java.sql.Timestamp value.
The driver
converts this to an SQL TIMESTAMP value when it sends it to the
database.
When a setXXX method is used to set a parameter of type TIMESTAMP WITH TIME ZONE or TIME WITH TIME ZONE the time zone of the client application is used as time zone.
When this method is used to set a parameter of type TIME or TIME WITH TIME ZONE, then the nanosecond value of the Timestamp object will be used if the TIME parameter accepts fractional seconds.
setTimestamp in interface java.sql.PreparedStatementparameterIndex - the first parameter is 1, the second is 2, ...x - the parameter valuejava.sql.SQLException - if a database access error occurs or
this method is called on a closed PreparedStatementpublic void setAsciiStream(int parameterIndex,
java.io.InputStream x,
int length)
throws java.sql.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.
From HSQLDB 2.0 this method uses the US-ASCII character encoding to convert bytes from the stream into the characters of a String.
This method does not use streaming to send the data, whether the target is a CLOB or other binary object.
For long streams (larger than a few megabytes) with CLOB targets, it is more efficient to use a version of setCharacterStream which takes the a length parameter.
setAsciiStream in interface java.sql.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 streamjava.sql.SQLException - if a database access error occurs or
this method is called on a closed PreparedStatementpublic void setUnicodeStream(int parameterIndex,
java.io.InputStream x,
int length)
throws java.sql.SQLException
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.
(JDBC4 added:)
The byte format of the Unicode stream must be a Java UTF-8, as defined in the
Java Virtual Machine Specification.
Note: This stream object can either be a standard Java stream object or your own subclass that implements the standard interface.
From 1.7.0 to 1.8.0.x, this method complies with behavior as defined by the JDBC3 specification (the stream is treated as though it has UTF16 encoding).
Starting with 2.0, this method behaves according to the JDBC4 specification (the stream is treated as though it has UTF-8 encoding, as defined in the Java Virtual Machine Specification) when built under JDK 1.6+; otherwise, it behaves as defined by the JDBC3 specification. Regardless, this method is deprecated: please use setCharacterStream(...) instead.
setUnicodeStream in interface java.sql.PreparedStatementparameterIndex - the first parameter is 1, the second is 2, ...x - a java.io.InputStream object that contains the
Unicode parameter value
(JDBC4 deleted:)
[as two-byte Unicode characters]length - the number of bytes in the streamjava.sql.SQLException - if a database access error occurs or
this method is called on a closed PreparedStatementjava.sql.SQLFeatureNotSupportedException - if the JDBC driver does not support
this methodpublic void setBinaryStream(int parameterIndex,
java.io.InputStream x,
int length)
throws java.sql.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.
Since 1.7.2, this method works according to the standard.
setBinaryStream in interface java.sql.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 streamjava.sql.SQLException - if a database access error occurs or
this method is called on a closed PreparedStatementpublic void clearParameters()
throws java.sql.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 java.sql.PreparedStatementjava.sql.SQLException - if a database access error occurs or
this method is called on a closed PreparedStatementpublic void setObject(int parameterIndex,
java.lang.Object x,
int targetSqlType,
int scaleOrLength)
throws java.sql.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.
If the second argument is an InputStream then the stream must contain
the number of bytes specified by scaleOrLength. If the second argument is a
Reader then the reader must contain the number of characters specified
by scaleOrLength. If these conditions are not true the driver will generate a
SQLException when the prepared statement is executed.
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, NClob,
Struct, java.net.URL,
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.
setObject in interface java.sql.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.scaleOrLength - 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.java.sql.SQLException - if a database access error occurs,
this method is called on a closed PreparedStatement or
if the Java Object specified by x is an InputStream
or Reader object and the value of the scale parameter is less
than zerojava.sql.SQLFeatureNotSupportedException - if targetSqlType is
a ARRAY, BLOB, CLOB,
DATALINK, JAVA_OBJECT, NCHAR,
NCLOB, NVARCHAR, LONGNVARCHAR,
REF, ROWID, SQLXML
or STRUCT data type and the JDBC driver does not support
this data typeTypespublic void setObject(int parameterIndex,
java.lang.Object x,
int targetSqlType)
throws java.sql.SQLException
setObject
above, except that it assumes a scale of zero.
Since 1.7.2, this method supports conversions listed in the conversion table B-5 of the JDBC 3 specification.
setObject in interface java.sql.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 databasejava.sql.SQLException - if a database access error occurs or
this method is called on a closed PreparedStatementjava.sql.SQLFeatureNotSupportedException - if targetSqlType is
a ARRAY, BLOB, CLOB,
DATALINK, JAVA_OBJECT, NCHAR,
NCLOB, NVARCHAR, LONGNVARCHAR,
REF, ROWID, SQLXML
or STRUCT data type and the JDBC driver does not support
this data typesetObject(int,Object)public void setObject(int parameterIndex,
java.lang.Object x)
throws java.sql.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 database-
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, (JDBC4 new:) [ NClob ],
Struct, java.net.URL, (JDBC4 new:) [ RowId, SQLXML ]
or Array, the driver should pass it to the database as a
value of the corresponding SQL type.
Note: Not all databases allow for a non-typed Null to be sent to
the backend. For maximum portability, the setNull or the
setObject(int parameterIndex, Object x, int sqlType)
method should be used
instead of setObject(int parameterIndex, Object x).
Note: 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.
Since 1.7.2, this method supports conversions listed in the conversion table B-5 of the JDBC 3 specification.
setObject in interface java.sql.PreparedStatementparameterIndex - the first parameter is 1, the second is 2, ...x - the object containing the input parameter valuejava.sql.SQLException - if a database access error occurs,
this method is called on a closed PreparedStatement
or the type of the given object is ambiguouspublic boolean execute()
throws java.sql.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 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).
If the statement is a call to a PROCEDURE, it may return multiple multiple fetchable results.
execute in interface java.sql.PreparedStatementtrue if the first result is a ResultSet
object; false if the first result is an update
count or there is no resultjava.sql.SQLException - if a database access error occurs,
this method is called on a closed PreparedStatement
or an argument is supplied to this methodJDBCStatement.execute(java.lang.String),
JDBCStatement.getResultSet(),
JDBCStatement.getUpdateCount(),
JDBCStatement.getMoreResults()public void addBatch()
throws java.sql.SQLException
PreparedStatement
object's batch of commands.
Since 1.7.2, this feature is supported.
addBatch in interface java.sql.PreparedStatementjava.sql.SQLException - if a database access error occurs or
this method is called on a closed PreparedStatementJDBCStatement.addBatch(java.lang.String)public void setCharacterStream(int parameterIndex,
java.io.Reader reader,
int length)
throws java.sql.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.
From HSQLDB 2.0 this method uses streaming to send data when the target is a CLOB.
HSQLDB represents CHARACTER and related SQL types as UTF16 Unicode internally, so this method does not perform any conversion.
setCharacterStream in interface java.sql.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 streamjava.sql.SQLException - if a database access error occurs or
this method is called on a closed PreparedStatementpublic void setRef(int parameterIndex,
java.sql.Ref x)
throws java.sql.SQLException
REF(<structured-type>) value.
The driver converts this to an SQL REF value when it
sends it to the database.
Including 2.0 HSQLDB does not support the SQL REF type. Calling this method throws an exception.
setRef in interface java.sql.PreparedStatementparameterIndex - the first parameter is 1, the second is 2, ...x - an SQL REF valuejava.sql.SQLException - if a database access error occurs or
this method is called on a closed PreparedStatementjava.sql.SQLFeatureNotSupportedException - if the JDBC driver does not support this methodpublic void setBlob(int parameterIndex,
java.sql.Blob x)
throws java.sql.SQLException
java.sql.Blob object.
The driver converts this to an SQL BLOB value when it
sends it to the database.
For parameters of type Blob, setBlob works normally.
In addition since 1.7.2, setBlob is supported for BINARY and VARBINARY parameters. In this context, the Blob object is hard-limited to those of length less than or equal to Integer.MAX_VALUE. In practice, soft limits such as available heap and maximum disk usage per file (such as the transaction log) dictate a much smaller maximum length.
For BINARY and VARBINARY parameter types setBlob(i,x) is roughly equivalent (null and length handling not shown) to:
setBinaryStream(i, x.getBinaryStream(), (int) x.length());
setBlob in interface java.sql.PreparedStatementparameterIndex - the first parameter is 1, the second is 2, ...x - a Blob object that maps an SQL BLOB valuejava.sql.SQLException - if a database access error occurs or
this method is called on a closed PreparedStatementjava.sql.SQLFeatureNotSupportedException - if the JDBC driver does not support this methodpublic void setClob(int parameterIndex,
java.sql.Clob x)
throws java.sql.SQLException
java.sql.Clob object.
The driver converts this to an SQL CLOB value when it
sends it to the database.
For parameters of type Clob, setClob works normally.
In addition since 1.7.2, setClob is supported for CHARACTER and VARCHAR parameters. In this context, the Clob object is hard-limited to those of length less than or equal to Integer.MAX_VALUE. In practice, soft limits such as available heap and maximum disk usage per file (such as the transaction log) dictate a much smaller maximum length.
For CHARACTER and VARCHAR parameter types setClob(i,x) is roughly equivalent (null and length handling not shown) to:
setCharacterStream(i, x.getCharacterStream(), (int) x.length());
setClob in interface java.sql.PreparedStatementparameterIndex - the first parameter is 1, the second is 2, ...x - a Clob object that maps an SQL CLOB valuejava.sql.SQLException - if a database access error occurs or
this method is called on a closed PreparedStatementjava.sql.SQLFeatureNotSupportedException - if the JDBC driver does not support this methodpublic void setArray(int parameterIndex,
java.sql.Array x)
throws java.sql.SQLException
java.sql.Array object.
The driver converts this to an SQL ARRAY value when it
sends it to the database.
From version 2.0, HSQLDB supports the SQL ARRAY type.
setArray in interface java.sql.PreparedStatementparameterIndex - the first parameter is 1, the second is 2, ...x - an Array object that maps an SQL ARRAY valuejava.sql.SQLException - if a database access error occurs or
this method is called on a closed PreparedStatementjava.sql.SQLFeatureNotSupportedException - if the JDBC driver does not support this methodpublic java.sql.ResultSetMetaData getMetaData()
throws java.sql.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 pre-compiled, 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.
Since 1.7.2, this feature is supported and is inexpensive as it is backed by underlying DBMS support. If the statement generates an update count, then null is returned.
getMetaData in interface java.sql.PreparedStatementResultSet object's columns or
null if the driver cannot return a
ResultSetMetaData objectjava.sql.SQLException - if a database access error occurs or
this method is called on a closed PreparedStatementjava.sql.SQLFeatureNotSupportedException - if the JDBC driver does not support
this methodpublic void setDate(int parameterIndex,
java.sql.Date x,
java.util.Calendar cal)
throws java.sql.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 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 java.sql.PreparedStatementparameterIndex - the first parameter is 1, the second is 2, ...x - the parameter valuecal - the Calendar object the driver will use
to construct the datejava.sql.SQLException - if a database access error occurs or
this method is called on a closed PreparedStatementpublic void setTime(int parameterIndex,
java.sql.Time x,
java.util.Calendar cal)
throws java.sql.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 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.
When a setXXX method is used to set a parameter of type TIMESTAMP WITH TIME ZONE or TIME WITH TIME ZONE the time zone (including Daylight Saving Time) of the Calendar is used as time zone for the value.
setTime in interface java.sql.PreparedStatementparameterIndex - the first parameter is 1, the second is 2, ...x - the parameter valuecal - the Calendar object the driver will use
to construct the timejava.sql.SQLException - if a database access error occurs or
this method is called on a closed PreparedStatementpublic void setTimestamp(int parameterIndex,
java.sql.Timestamp x,
java.util.Calendar cal)
throws java.sql.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.
When a setXXX method is used to set a parameter of type TIMESTAMP WITH TIME ZONE or TIME WITH TIME ZONE the time zone (including Daylight Saving Time) of the Calendar is used as time zone.
In this case, if the Calendar argument is null, then the default Calendar for the clients JVM is used as the Calendar
When this method is used to set a parameter of type TIME or TIME WITH TIME ZONE, then the nanosecond value of the Timestamp object is used if the TIME parameter accepts fractional seconds.
setTimestamp in interface java.sql.PreparedStatementparameterIndex - the first parameter is 1, the second is 2, ...x - the parameter valuecal - the Calendar object the driver will use
to construct the timestampjava.sql.SQLException - if a database access error occurs or
this method is called on a closed PreparedStatementpublic void setNull(int parameterIndex,
int sqlType,
java.lang.String typeName)
throws java.sql.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 simply ignores the sqlType and typeName arguments.
setNull in interface java.sql.PreparedStatementparameterIndex - 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 REFjava.sql.SQLException - if a database access error occurs or
this method is called on a closed PreparedStatementjava.sql.SQLFeatureNotSupportedException - if sqlType is
a ARRAY, BLOB, CLOB,
DATALINK, JAVA_OBJECT, NCHAR,
NCLOB, NVARCHAR, LONGNVARCHAR,
REF, ROWID, SQLXML
or STRUCT data type and the JDBC driver does not support
this data type or if the JDBC driver does not support this methodpublic int[] executeBatch()
throws java.sql.SQLException
int 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 method executeBatch
may be one of the following:
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 a BatchUpdateException, 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 method
BatchUpdateException.getUpdateCounts
will contain as many elements as there are commands in the batch, and
at least one of the elements will be the following:
EXECUTE_FAILED -- indicates that the command failed
to execute successfully and occurs only if a driver continues to
process commands after a command fails
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 BatchUpdateException object has been thrown.
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.
executeBatch in interface java.sql.Statementjava.sql.SQLException - if a database access error occurs,
this method is called on a closed Statement or the
driver does not support batch statements. Throws BatchUpdateException
(a subclass of SQLException) if one of the commands sent to the
database fails to execute properly or attempts to return a result set.addBatch(),
DatabaseMetaData.supportsBatchUpdates()public void setEscapeProcessing(boolean enable)
throws java.sql.SQLException
As per JDBC spec, calling this method has no effect.
setEscapeProcessing in interface java.sql.Statementenable - true to enable escape processing;
false to disable itjava.sql.SQLException - if a database access error occurspublic void addBatch(java.lang.String sql)
throws java.sql.SQLException
addBatch in interface java.sql.Statementsql - ignoredjava.sql.SQLException - alwayspublic java.sql.ResultSet executeQuery(java.lang.String sql)
throws java.sql.SQLException
executeQuery in interface java.sql.Statementsql - ignoredjava.sql.SQLException - alwayspublic boolean execute(java.lang.String sql)
throws java.sql.SQLException
execute in interface java.sql.Statementsql - ignoredjava.sql.SQLException - alwayspublic int executeUpdate(java.lang.String sql)
throws java.sql.SQLException
executeUpdate in interface java.sql.Statementsql - ignoredjava.sql.SQLException - alwayspublic void close()
throws java.sql.SQLException
close in interface java.lang.AutoCloseableclose in interface java.sql.Statementjava.sql.SQLException - if a database access error occurspublic java.lang.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.
toString in class java.lang.Objectpublic void setURL(int parameterIndex,
java.net.URL x)
throws java.sql.SQLException
java.net.URL value.
The driver converts this to an SQL DATALINK value
when it sends it to the database.
Including 2.0, HSQLDB does not support the DATALINK SQL type for which this method is intended. Calling this method throws an exception.
setURL in interface java.sql.PreparedStatementparameterIndex - the first parameter is 1, the second is 2, ...x - the java.net.URL object to be setjava.sql.SQLException - if a database access error occurs or
this method is called on a closed PreparedStatementjava.sql.SQLFeatureNotSupportedException - if the JDBC driver does not support this methodpublic java.sql.ParameterMetaData getParameterMetaData()
throws java.sql.SQLException
PreparedStatement object's parameters.
Since 1.7.2, this feature is supported.
getParameterMetaData in interface java.sql.PreparedStatementParameterMetaData object that contains information
about the number, types and properties for each
parameter marker of this PreparedStatement objectjava.sql.SQLException - if a database access error occurs or
this method is called on a closed PreparedStatementParameterMetaDatapublic int executeUpdate(java.lang.String sql,
int autoGeneratedKeys)
throws java.sql.SQLException
executeUpdate in interface java.sql.Statementjava.sql.SQLExceptionpublic boolean execute(java.lang.String sql,
int autoGeneratedKeys)
throws java.sql.SQLException
execute in interface java.sql.Statementjava.sql.SQLExceptionpublic int executeUpdate(java.lang.String sql,
int[] columnIndexes)
throws java.sql.SQLException
executeUpdate in interface java.sql.Statementjava.sql.SQLExceptionpublic boolean execute(java.lang.String sql,
int[] columnIndexes)
throws java.sql.SQLException
execute in interface java.sql.Statementjava.sql.SQLExceptionpublic int executeUpdate(java.lang.String sql,
java.lang.String[] columnNames)
throws java.sql.SQLException
executeUpdate in interface java.sql.Statementjava.sql.SQLExceptionpublic boolean execute(java.lang.String sql,
java.lang.String[] columnNames)
throws java.sql.SQLException
execute in interface java.sql.Statementjava.sql.SQLExceptionpublic boolean getMoreResults(int current)
throws java.sql.SQLException
Statement object's next result, deals with
any current ResultSet object(s) according to the instructions
specified by the given flag, and returns
true if the next result is a ResultSet object.
There are no more results when the following is true:
// stmt is a Statement object
((stmt.getMoreResults(current) == false) && (stmt.getUpdateCount() == -1))
HSQLDB supports this feature.
This is used with CallableStatement objects that return multiple ResultSet objects.
getMoreResults in interface java.sql.Statementcurrent - one of the following Statement
constants indicating what should happen to current
ResultSet objects obtained using the method
getResultSet:
Statement.CLOSE_CURRENT_RESULT,
Statement.KEEP_CURRENT_RESULT, or
Statement.CLOSE_ALL_RESULTStrue if the next result is a ResultSet
object; false if it is an update count or there are no
more resultsjava.sql.SQLException - if a database access error occurs,
this method is called on a closed Statement or the argument
supplied is not one of the following:
Statement.CLOSE_CURRENT_RESULT,
Statement.KEEP_CURRENT_RESULT, or
Statement.CLOSE_ALL_RESULTSexecute()public java.sql.ResultSet getGeneratedKeys()
throws java.sql.SQLException
Statement object. If this Statement object did
not generate any keys, an empty ResultSet
object is returned.
(JDBC4 clarification:)
Note:If the columns which represent the auto-generated keys were not specified, the JDBC driver implementation will determine the columns which best represent the auto-generated keys.
Starting with version 2.0, HSQLDB supports this feature with single-row and multi-row insert, update and merge statements.
This method returns a result set only if the executeUpdate methods that was used is one of the three methods that have the extra parameter indicating return of generated keys
If the executeUpdate method did not specify the columns which represent the auto-generated keys the IDENTITY column or GENERATED column(s) of the table are returned.
The executeUpdate methods with column indexes or column names return the post-insert or post-update values of the specified columns, whether the columns are generated or not. This allows values that have been modified by execution of triggers to be returned.
If column names or indexes provided by the user in the executeUpdate() method calls do not correspond to table columns (incorrect names or indexes larger than the column count), an empty result is returned.
getGeneratedKeys in interface java.sql.StatementResultSet object containing the auto-generated key(s)
generated by the execution of this Statement objectjava.sql.SQLException - if a database access error occurs or
this method is called on a closed Statementjava.sql.SQLFeatureNotSupportedException - if the JDBC driver does not support this methodpublic int getResultSetHoldability()
throws java.sql.SQLException
ResultSet objects
generated by this Statement object.
getResultSetHoldability in interface java.sql.StatementResultSet.HOLD_CURSORS_OVER_COMMIT or
ResultSet.CLOSE_CURSORS_AT_COMMITjava.sql.SQLException - if a database access error occurs or
this method is called on a closed Statementpublic boolean isClosed()
Statement object has been closed. A Statement is closed if the
method close has been called on it, or if it is automatically closed.isClosed in interface java.sql.StatementStatement object is closed; false if it is still openpublic void setRowId(int parameterIndex,
java.sql.RowId x)
throws java.sql.SQLException
java.sql.RowId object. The
driver converts this to a SQL ROWID value when it sends it
to the databasesetRowId in interface java.sql.PreparedStatementparameterIndex - the first parameter is 1, the second is 2, ...x - the parameter valuejava.sql.SQLException - if a database access error occurs or
this method is called on a closed PreparedStatementjava.sql.SQLFeatureNotSupportedException - if the JDBC driver does not support this methodpublic void setNString(int parameterIndex,
java.lang.String value)
throws java.sql.SQLException
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.setNString in interface java.sql.PreparedStatementparameterIndex - of the first parameter is 1, the second is 2, ...value - the parameter valuejava.sql.SQLException - if the driver does not support national
character sets; if the driver can detect that a data conversion
error could occur ; if a database access error occurs; or
this method is called on a closed PreparedStatementjava.sql.SQLFeatureNotSupportedException - if the JDBC driver does not support this methodpublic void setNCharacterStream(int parameterIndex,
java.io.Reader value,
long length)
throws java.sql.SQLException
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.setNCharacterStream in interface java.sql.PreparedStatementparameterIndex - of the first parameter is 1, the second is 2, ...value - the parameter valuelength - the number of characters in the parameter data.java.sql.SQLException - if the driver does not support national
character sets; if the driver can detect that a data conversion
error could occur ; if a database access error occurs; or
this method is called on a closed PreparedStatementjava.sql.SQLFeatureNotSupportedException - if the JDBC driver does not support this methodpublic void setNClob(int parameterIndex,
java.sql.NClob value)
throws java.sql.SQLException
java.sql.NClob object. The driver converts this to a
SQL NCLOB value when it sends it to the database.setNClob in interface java.sql.PreparedStatementparameterIndex - of the first parameter is 1, the second is 2, ...value - the parameter valuejava.sql.SQLException - if the driver does not support national
character sets; if the driver can detect that a data conversion
error could occur ; if a database access error occurs; or
this method is called on a closed PreparedStatementjava.sql.SQLFeatureNotSupportedException - if the JDBC driver does not support this methodpublic void setClob(int parameterIndex,
java.io.Reader reader,
long length)
throws java.sql.SQLException
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 send to the server as a LONGVARCHAR or a CLOBsetClob in interface java.sql.PreparedStatementparameterIndex - index of 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.java.sql.SQLException - if a database access error occurs, this method is called on
a closed PreparedStatement, if parameterIndex does not correspond to a parameter
marker in the SQL statement, or if the length specified is less than zero.java.sql.SQLFeatureNotSupportedException - if the JDBC driver does not support this methodpublic void setBlob(int parameterIndex,
java.io.InputStream inputStream,
long length)
throws java.sql.SQLException
InputStream object. The input stream 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 send to the server as a LONGVARBINARY or a BLOB
In HSQLDB 2.0, this method uses streaming to send the data when the stream is assigned to a BLOB target. For other binary targets the stream is read on the client side and a byte array is sent.
setBlob in interface java.sql.PreparedStatementparameterIndex - index of the first parameter is 1,
the second is 2, ...inputStream - An object that contains the data to set the parameter
value to.length - the number of bytes in the parameter data.java.sql.SQLException - if a database access error occurs,
this method is called on a closed PreparedStatement,
if parameterIndex does not correspond
to a parameter marker in the SQL statement, if the length specified
is less than zero or if the number of bytes in the input stream does not match
the specified length.java.sql.SQLFeatureNotSupportedException - if the JDBC driver does not support this methodpublic void setNClob(int parameterIndex,
java.io.Reader reader,
long length)
throws java.sql.SQLException
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 send to the server as a LONGNVARCHAR or a NCLOBsetNClob in interface java.sql.PreparedStatementparameterIndex - index of 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.java.sql.SQLException - if parameterIndex does not correspond to a parameter
marker in the SQL statement; if the length specified is less than zero;
if the driver does not support national character sets;
if the driver can detect that a data conversion
error could occur; if a database access error occurs or
this method is called on a closed PreparedStatementjava.sql.SQLFeatureNotSupportedException - if the JDBC driver does not support this methodpublic void setSQLXML(int parameterIndex,
java.sql.SQLXML xmlObject)
throws java.sql.SQLException
java.sql.SQLXML object.
The driver converts this to an
SQL XML value when it sends it to the database.
setSQLXML in interface java.sql.PreparedStatementparameterIndex - index of the first parameter is 1, the second is 2, ...xmlObject - a SQLXML object that maps an SQL XML valuejava.sql.SQLException - if a database access error occurs,
this method is called on a closed PreparedStatement
or the java.xml.transform.Result,
Writer or OutputStream has not been closed for
the SQLXML objectjava.sql.SQLFeatureNotSupportedException - if the JDBC driver does not support this methodpublic void setAsciiStream(int parameterIndex,
java.io.InputStream x,
long length)
throws java.sql.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.
From HSQLDB 2.0 this method uses the US-ASCII character encoding to convert bytes from the stream into the characters of a String.
This method does not use streaming to send the data, whether the target is a CLOB or other binary object.
For long streams (larger than a few megabytes) with CLOB targets, it is more efficient to use a version of setCharacterStream which takes the a length parameter.
setAsciiStream in interface java.sql.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 streamjava.sql.SQLException - if a database access error occurs or
this method is called on a closed PreparedStatementpublic void setBinaryStream(int parameterIndex,
java.io.InputStream x,
long length)
throws java.sql.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.
This method uses streaming to send the data when the stream is assigned to a BLOB target. For other binary targets the stream is read on the client side and a byte array is sent.
setBinaryStream in interface java.sql.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 streamjava.sql.SQLException - if a database access error occurs or
this method is called on a closed PreparedStatementpublic void setCharacterStream(int parameterIndex,
java.io.Reader reader,
long length)
throws java.sql.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.
This method uses streaming to send data when the target is a CLOB.
setCharacterStream in interface java.sql.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 streamjava.sql.SQLException - if a database access error occurs or
this method is called on a closed PreparedStatementpublic void setAsciiStream(int parameterIndex,
java.io.InputStream x)
throws java.sql.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.
Note: Consult your JDBC driver documentation to determine if
it might be more efficient to use a version of
setAsciiStream which takes a length parameter.
In HSQLDB 2.0, this method does not use streaming to send the data, whether the target is a CLOB or other binary object. For long streams (larger than a few megabytes), it is more efficient to use a version of setCharacterStream which takes the a length parameter.
setAsciiStream in interface java.sql.PreparedStatementparameterIndex - the first parameter is 1, the second is 2, ...x - the Java input stream that contains the ASCII parameter valuejava.sql.SQLException - if parameterIndex does not correspond to a parameter
marker in the SQL statement; if a database access error occurs or
this method is called on a closed PreparedStatementjava.sql.SQLFeatureNotSupportedException - if the JDBC driver does not support this methodpublic void setBinaryStream(int parameterIndex,
java.io.InputStream x)
throws java.sql.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.
Note: Consult your JDBC driver documentation to determine if
it might be more efficient to use a version of
setBinaryStream which takes a length parameter.
This method does not use streaming to send the data, whether the target is a CLOB or other binary object.
For long streams (larger than a few megabytes) with CLOB targets, it is more efficient to use a version of setCharacterStream which takes the a length parameter.
setBinaryStream in interface java.sql.PreparedStatementparameterIndex - the first parameter is 1, the second is 2, ...x - the java input stream which contains the binary parameter valuejava.sql.SQLException - if parameterIndex does not correspond to a parameter
marker in the SQL statement; if a database access error occurs or
this method is called on a closed PreparedStatementjava.sql.SQLFeatureNotSupportedException - if the JDBC driver does not support this methodpublic void setCharacterStream(int parameterIndex,
java.io.Reader reader)
throws java.sql.SQLException
Reader
object.
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.
Note: Consult your JDBC driver documentation to determine if
it might be more efficient to use a version of
setCharacterStream which takes a length parameter.
In HSQLDB 2.0, this method does not use streaming to send the data, whether the target is a CLOB or other binary object. For long streams (larger than a few megabytes), it is more efficient to use a version of setCharacterStream which takes the a length parameter.
setCharacterStream in interface java.sql.PreparedStatementparameterIndex - the first parameter is 1, the second is 2, ...reader - the java.io.Reader object that contains the
Unicode datajava.sql.SQLException - if parameterIndex does not correspond to a parameter
marker in the SQL statement; if a database access error occurs or
this method is called on a closed PreparedStatementjava.sql.SQLFeatureNotSupportedException - if the JDBC driver does not support this methodpublic void setNCharacterStream(int parameterIndex,
java.io.Reader value)
throws java.sql.SQLException
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.
Note: This stream object can either be a standard Java stream object or your own subclass that implements the standard interface.
Note: Consult your JDBC driver documentation to determine if
it might be more efficient to use a version of
setNCharacterStream which takes a length parameter.
setNCharacterStream in interface java.sql.PreparedStatementparameterIndex - of the first parameter is 1, the second is 2, ...value - the parameter valuejava.sql.SQLException - if parameterIndex does not correspond to a parameter
marker in the SQL statement; if the driver does not support national
character sets; if the driver can detect that a data conversion
error could occur; if a database access error occurs; or
this method is called on a closed PreparedStatementjava.sql.SQLFeatureNotSupportedException - if the JDBC driver does not support this methodpublic void setClob(int parameterIndex,
java.io.Reader reader)
throws java.sql.SQLException
Reader object.
This method differs from the setCharacterStream (int, Reader) 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
Note: Consult your JDBC driver documentation to determine if
it might be more efficient to use a version of
setClob which takes a length parameter.
setClob in interface java.sql.PreparedStatementparameterIndex - index of the first parameter is 1, the second is 2, ...reader - An object that contains the data to set the parameter value to.java.sql.SQLException - if parameterIndex does not correspond to a parameter
marker in the SQL statement; if a database access error occurs; this method is called on
a closed PreparedStatementor if parameterIndex does not correspond to a parameter
marker in the SQL statementjava.sql.SQLFeatureNotSupportedException - if the JDBC driver does not support this methodpublic void setBlob(int parameterIndex,
java.io.InputStream inputStream)
throws java.sql.SQLException
InputStream object.
This method differs from the setBinaryStream (int, InputStream)
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
Note: Consult your JDBC driver documentation to determine if
it might be more efficient to use a version of
setBlob which takes a length parameter.
setBlob in interface java.sql.PreparedStatementparameterIndex - index of the first parameter is 1,
the second is 2, ...inputStream - An object that contains the data to set the parameter
value to.java.sql.SQLException - if parameterIndex does not correspond to a parameter
marker in the SQL statement; if a database access error occurs;
this method is called on a closed PreparedStatement or
if parameterIndex does not correspond
to a parameter marker in the SQL statement,java.sql.SQLFeatureNotSupportedException - if the JDBC driver does not support this methodpublic void setNClob(int parameterIndex,
java.io.Reader reader)
throws java.sql.SQLException
Reader object.
This method differs from the setCharacterStream (int, Reader) 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
Note: Consult your JDBC driver documentation to determine if
it might be more efficient to use a version of
setNClob which takes a length parameter.
setNClob in interface java.sql.PreparedStatementparameterIndex - index of the first parameter is 1, the second is 2, ...reader - An object that contains the data to set the parameter value to.java.sql.SQLException - if parameterIndex does not correspond to a parameter
marker in the SQL statement;
if the driver does not support national character sets;
if the driver can detect that a data conversion
error could occur; if a database access error occurs or
this method is called on a closed PreparedStatementjava.sql.SQLFeatureNotSupportedException - if the JDBC driver does not support this methodpublic int getMaxFieldSize()
throws java.sql.SQLException
ResultSet
object produced by this Statement object.
This limit applies only to BINARY, VARBINARY,
LONGVARBINARY, CHAR, VARCHAR,
(JDBC4 new:) NCHAR, NVARCHAR, LONGNVARCHAR
and LONGVARCHAR columns. If the limit is exceeded, the
excess data is silently discarded.
HSQLDB always returns zero, meaning there is no limit.
getMaxFieldSize in interface java.sql.Statementjava.sql.SQLException - if a database access error occurs or
this method is called on a closed StatementsetMaxFieldSize(int)public void setMaxFieldSize(int max)
throws java.sql.SQLException
ResultSet
Sets the limit for the maximum number of bytes that can be returned for
character and binary column values in a ResultSet
object produced by this Statement object.
This limit applies
only to BINARY, VARBINARY,
LONGVARBINARY, CHAR, VARCHAR,
(JDBC4 new:) NCHAR, NVARCHAR, LONGNVARCHAR and
LONGVARCHAR fields. If the limit is exceeded, the excess data
is silently discarded. For maximum portability, use values
greater than 256.
To present, calls to this method are simply ignored; HSQLDB always stores the full number of bytes when dealing with any of the field types mentioned above. These types all have an absolute maximum element upper bound determined by the Java array index limit java.lang.Integer.MAX_VALUE. For XXXBINARY types, this translates to Integer.MAX_VALUE bytes. For XXXCHAR types, this translates to 2 * Integer.MAX_VALUE bytes (2 bytes / character).
In practice, field sizes are limited to values much smaller than the absolute maximum element upper bound, in particular due to limits imposed on the maximum available Java heap memory.
setMaxFieldSize in interface java.sql.Statementmax - the new column size limit in bytes; zero means there is no limitjava.sql.SQLException - if a database access error occurs,
this method is called on a closed Statement
or the condition max >= 0 is not satisfiedgetMaxFieldSize()public int getMaxRows()
throws java.sql.SQLException
ResultSet object produced by this
Statement object can contain. If this limit is exceeded,
the excess rows are silently dropped.
getMaxRows in interface java.sql.StatementResultSet
object produced by this Statement object;
zero means there is no limitjava.sql.SQLException - if a database access error occurs or
this method is called on a closed StatementsetMaxRows(int)public void setMaxRows(int max)
throws java.sql.SQLException
ResultSet object generated by this Statement
object can contain to the given number.
If the limit is exceeded, the excess
rows are silently dropped.
setMaxRows in interface java.sql.Statementmax - the new max rows limit; zero means there is no limitjava.sql.SQLException - if a database access error occurs,
this method is called on a closed Statement
or the condition max >= 0 is not satisfiedgetMaxRows()public int getQueryTimeout()
throws java.sql.SQLException
Statement object to execute.
If the limit is exceeded, a
SQLException is thrown.
To present, HSQLDB always returns zero, meaning there is no limit.
getQueryTimeout in interface java.sql.Statementjava.sql.SQLException - if a database access error occurs or
this method is called on a closed StatementsetQueryTimeout(int)public void setQueryTimeout(int seconds)
throws java.sql.SQLException
Statement object to execute to the given number of seconds.
If the limit is exceeded, an SQLException is thrown. A JDBC
(JDBC4 clarification:)
driver must apply this limit to the execute,
executeQuery and executeUpdate methods. JDBC driver
implementations may also apply this limit to ResultSet methods
(consult your driver vendor documentation for details).
The maximum number of seconds to wait is 32767.
setQueryTimeout in interface java.sql.Statementseconds - the new query timeout limit in seconds; zero means
there is no limitjava.sql.SQLException - if a database access error occurs,
this method is called on a closed Statement
or the condition seconds >= 0 is not satisfiedgetQueryTimeout()public void cancel()
throws java.sql.SQLException
Statement object if both the DBMS and
driver support aborting an SQL statement.
This method can be used by one thread to cancel a statement that
is being executed by another thread.
HSQLDB version 2.3.4 and later supports aborting an SQL query or data update statement.
cancel in interface java.sql.Statementjava.sql.SQLException - if a database access error occurs or
this method is called on a closed Statementjava.sql.SQLFeatureNotSupportedException - if the JDBC driver does not support
this methodpublic java.sql.SQLWarning getWarnings()
throws java.sql.SQLException
Statement object.
Subsequent Statement object warnings will be chained to this
SQLWarning object.
The warning chain is automatically cleared each time
a statement is (re)executed. This method may not be called on a closed
Statement object; doing so will cause an SQLException
to be thrown.
Note: If you are processing a ResultSet object, any
warnings associated with reads on that ResultSet object
will be chained on it rather than on the Statement
object that produced it.
From 1.9 HSQLDB, produces Statement warnings.
getWarnings in interface java.sql.StatementSQLWarning object or null
if there are no warningsjava.sql.SQLException - if a database access error occurs or
this method is called on a closed Statementpublic void clearWarnings()
throws java.sql.SQLException
Statement
object. After a call to this method,
the method getWarnings will return
null until a new warning is reported for this
Statement object.
Supported in HSQLDB 1.9.
clearWarnings in interface java.sql.Statementjava.sql.SQLException - if a database access error occurs or
this method is called on a closed Statementpublic void setCursorName(java.lang.String name)
throws java.sql.SQLException
String, which
will be used by subsequent Statement object
execute methods. This name can then be
used in SQL positioned update or delete statements to identify the
current row in the ResultSet object generated by this
statement. If the database does not support positioned update/delete,
this method is a noop. To insure that a cursor has the proper isolation
level to support updates, the cursor's SELECT statement
should have the form SELECT FOR UPDATE. If
FOR UPDATE is not present, positioned updates may fail.
Note: By definition, the execution of positioned updates and
deletes must be done by a different Statement object than
the one that generated the ResultSet object being used for
positioning. Also, cursor names must be unique within a connection.
Including 2.0, HSQLDB does not support named cursors; calls to this method are ignored.
setCursorName in interface java.sql.Statementname - the new cursor name, which must be unique within
a connectionjava.sql.SQLException - if a database access error occurs or
this method is called on a closed Statementjava.sql.SQLFeatureNotSupportedException - if the JDBC driver does not support this methodpublic java.sql.ResultSet getResultSet()
throws java.sql.SQLException
ResultSet object.
This method should be called only once per result.
Without an interceding call to executeXXX, each invocation of this method will produce a new, initialized ResultSet instance referring to the current result, if any.
getResultSet in interface java.sql.StatementResultSet object or
null if the result is an update count or there are no more resultsjava.sql.SQLException - if a database access error occurs or
this method is called on a closed Statementexecute()public int getUpdateCount()
throws java.sql.SQLException
ResultSet object or there are no more results, -1
is returned. This method should be called only once per result.
getUpdateCount in interface java.sql.StatementResultSet object or there are no more resultsjava.sql.SQLException - if a database access error occurs or
this method is called on a closed Statementexecute()public boolean getMoreResults()
throws java.sql.SQLException
Statement object's next result, returns
true if it is a ResultSet object, and
implicitly closes any current ResultSet
object(s) obtained with the method getResultSet.
There are no more results when the following is true:
// stmt is a Statement object
((stmt.getMoreResults() == false) && (stmt.getUpdateCount() == -1))
getMoreResults in interface java.sql.Statementtrue if the next result is a ResultSet
object; false if it is an update count or there are
no more resultsjava.sql.SQLException - if a database access error occurs or
this method is called on a closed Statementexecute()public void setFetchDirection(int direction)
throws java.sql.SQLException
ResultSet
objects created using this Statement object. The
default value is ResultSet.FETCH_FORWARD.
Note that this method sets the default fetch direction for
result sets generated by this Statement object.
Each result set has its own methods for getting and setting
its own fetch direction.
Up to 1.8.0.x, HSQLDB supports only FETCH_FORWARD;
Setting any other value would throw an SQLException
stating that the operation is not supported.
Starting with 2.0, HSQLDB accepts any valid value.
setFetchDirection in interface java.sql.Statementdirection - the initial direction for processing rowsjava.sql.SQLException - if a database access error occurs,
this method is called on a closed Statement
or the given direction
is not one of ResultSet.FETCH_FORWARD,
ResultSet.FETCH_REVERSE, or ResultSet.FETCH_UNKNOWNgetFetchDirection()public int getFetchDirection()
throws java.sql.SQLException
Statement object.
If this Statement object has not set
a fetch direction by calling the method setFetchDirection,
the return value is implementation-specific.
Up to 1.8.0.x, HSQLDB always returned FETCH_FORWARD.
Starting with 2.0, HSQLDB returns FETCH_FORWARD by default, or
whatever value has been explicitly assigned by invoking
setFetchDirection.
.
getFetchDirection in interface java.sql.StatementStatement objectjava.sql.SQLException - if a database access error occurs or
this method is called on a closed StatementsetFetchDirection(int)public void setFetchSize(int rows)
throws java.sql.SQLException
ResultSet objects generated by this Statement.
If the value specified is zero, then the hint is ignored.
The default value is zero.
HSQLDB uses the specified value as a hint, but may process more or fewer rows than specified.
setFetchSize in interface java.sql.Statementrows - the number of rows to fetchjava.sql.SQLException - if a database access error occurs,
this method is called on a closed Statement or the
(JDBC4 modified:)
condition <code>rows >= 0</code> is not satisfied.getFetchSize()public int getFetchSize()
throws java.sql.SQLException
ResultSet objects
generated from this Statement object.
If this Statement object has not set
a fetch size by calling the method setFetchSize,
the return value is implementation-specific.
HSQLDB returns 0 by default, or the fetch size specified by setFetchSize
getFetchSize in interface java.sql.StatementStatement objectjava.sql.SQLException - if a database access error occurs or
this method is called on a closed StatementsetFetchSize(int)public int getResultSetConcurrency()
throws java.sql.SQLException
ResultSet objects
generated by this Statement object.
HSQLDB supports CONCUR_READ_ONLY and
CONCUR_READ_UPDATEBLE concurrency.
getResultSetConcurrency in interface java.sql.StatementResultSet.CONCUR_READ_ONLY or
ResultSet.CONCUR_UPDATABLEjava.sql.SQLException - if a database access error occurs or
this method is called on a closed Statementpublic int getResultSetType()
throws java.sql.SQLException
ResultSet objects
generated by this Statement object.
HSQLDB 1.7.0 and later versions support TYPE_FORWARD_ONLY
and TYPE_SCROLL_INSENSITIVE.
getResultSetType in interface java.sql.StatementResultSet.TYPE_FORWARD_ONLY,
ResultSet.TYPE_SCROLL_INSENSITIVE, or
ResultSet.TYPE_SCROLL_SENSITIVEjava.sql.SQLException - if a database access error occurs or
this method is called on a closed Statementpublic void clearBatch()
throws java.sql.SQLException
Statement object's current list of
SQL commands.
(JDBC4 clarification:)
NOTE: Support of an ability to batch updates is optional.
Starting with HSQLDB 1.7.2, this feature is supported.
clearBatch in interface java.sql.Statementjava.sql.SQLException - if a database access error occurs,
this method is called on a closed Statement or the
driver does not support batch updatesaddBatch()public java.sql.Connection getConnection()
throws java.sql.SQLException
Connection object
that produced this Statement object.
getConnection in interface java.sql.Statementjava.sql.SQLException - if a database access error occurs or
this method is called on a closed Statementpublic void setPoolable(boolean poolable)
throws java.sql.SQLException
Statement be pooled or not pooled. The value
specified is a hint to the statement pool implementation indicating
whether the application wants the statement to be pooled. It is up to
the statement pool manager as to whether the hint is used.
The poolable value of a statement is applicable to both internal statement caches implemented by the driver and external statement caches implemented by application servers and other applications.
By default, a Statement is not poolable when created, and
a PreparedStatement and CallableStatement
are poolable when created.
setPoolable in interface java.sql.Statementpoolable - requests that the statement be pooled if true and
that the statement not be pooled if false
java.sql.SQLException - if this method is called on a closed
Statement
public boolean isPoolable()
throws java.sql.SQLException
Statement
is poolable or not.
isPoolable in interface java.sql.Statementtrue if the Statement
is poolable; false otherwisejava.sql.SQLException - if this method is called on a closed
Statement
setPoolable(boolean)public <T> T unwrap(java.lang.Class<T> iface)
throws java.sql.SQLException
unwrap recursively on the wrapped object
or a proxy for that result. If the receiver is not a
wrapper and does not implement the interface, then an SQLException is thrown.unwrap in interface java.sql.Wrapperiface - A Class defining an interface that the result must implement.java.sql.SQLException - If no object found that implements the interfacepublic boolean isWrapperFor(java.lang.Class<?> iface)
throws java.sql.SQLException
isWrapperFor on the wrapped
object. If this does not implement the interface and is not a wrapper, return false.
This method should be implemented as a low-cost operation compared to unwrap so that
callers can use this method to avoid expensive unwrap calls that may fail. If this method
returns true then calling unwrap with the same argument should succeed.isWrapperFor in interface java.sql.Wrapperiface - a Class defining an interface.java.sql.SQLException - if an error occurs while determining whether this is a wrapper
for an object with the given interface.public long executeLargeUpdate()
throws java.sql.SQLException
PreparedStatement object,
which must be an SQL Data Manipulation Language (DML) statement,
such as INSERT, UPDATE or
DELETE; or an SQL statement that returns nothing,
such as a DDL statement.
This method should be used when the returned row count may exceed
Integer.MAX_VALUE.
The default implementation will throw UnsupportedOperationException
executeLargeUpdate in interface java.sql.PreparedStatementjava.sql.SQLException - if a database access error occurs;
this method is called on a closed PreparedStatement
or the SQL statement returns a ResultSet objectjava.sql.SQLTimeoutException - when the driver has determined that the
timeout value that was specified by the setQueryTimeout
method has been exceeded and has at least attempted to cancel
the currently running Statementpublic void closeOnCompletion()
throws java.sql.SQLException
Statement will be closed when all its
dependent result sets are closed. If execution of the Statement
does not produce any result sets, this method has no effect.
Note: Multiple calls to closeOnCompletion do
not toggle the effect on this Statement. However, a call to
closeOnCompletion does effect both the subsequent execution of
statements, and statements that currently have open, dependent,
result sets.
java.sql.SQLException - if this method is called on a closed
Statementpublic boolean isCloseOnCompletion()
throws java.sql.SQLException
Statement will be
closed when all its dependent result sets are closed.true if the Statement will be closed when all
of its dependent result sets are closed; false otherwisejava.sql.SQLException - if this method is called on a closed
StatementCopyright © 2001 - 2018 HSQL Development Group.