/* Copyright (c) 2001-2019, The HSQL Development Group
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* Redistributions of source code must retain the above copyright notice, this
* list of conditions and the following disclaimer.
*
* Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
*
* Neither the name of the HSQL Development Group nor the names of its
* contributors may be used to endorse or promote products derived from this
* software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL HSQL DEVELOPMENT GROUP, HSQLDB.ORG,
* OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
* EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
* PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.hsqldb.jdbc;
import java.sql.BatchUpdateException;
import java.sql.Connection;
import java.sql.DatabaseMetaData;
import java.sql.ResultSet;
import java.sql.SQLException;
import java.sql.SQLFeatureNotSupportedException;
import java.sql.SQLWarning;
import java.sql.SQLTimeoutException;
import java.sql.Statement;
import org.hsqldb.HsqlException;
import org.hsqldb.StatementTypes;
import org.hsqldb.navigator.RowSetNavigator;
import org.hsqldb.result.Result;
import org.hsqldb.result.ResultConstants;
import org.hsqldb.result.ResultProperties;
/* $Id: JDBCStatement.java 5968 2019-04-27 12:55:27Z fredt $ */
// fredt@users 20020320 - patch 1.7.0 - JDBC 2 support and error trapping
//
// SCROLL_INSENSITIVE and FORWARD_ONLY types for ResultSet are now supported
//
// campbell-burnet@users 20020509 - added "throws SQLException" to all methods where
// it was missing here but specified in the
// java.sql.Statement interface,
// updated generic documentation to JDK 1.4, and
// added JDBC3 methods and docs
// boucherb & 20020505 - extensive review and update of docs and behaviour
// fredt@users to comply with java.sql specification
// fredt@users 20030620 - patch 1.7.2 - rewritten and simplified
// campbell-burnet@users 200404xx - javadoc updates toward 1.7.2 final
// campbell-burnet@users 20051207 - patch 1.8.0.x initial JDBC 4.0 support work
// campbell-burnet@users 20060522 - doc 1.9.0 full synch up to Mustang Build 84
// Revision 1.16 2006/07/12 12:40:59 boucherb
// patch 1.9.0
// - full synch up to Mustang b90
The object used for executing a static SQL statement
and returning the results it produces.
By default, only one ResultSet
object per Statement
object can be open at the same time. Therefore, if the reading of one
ResultSet
object is interleaved
with the reading of another, each must have been generated by
different Statement
objects. All execution methods in the
Statement
interface implicitly close a statement's current
ResultSet
object if an open one exists.
HSQLDB-Specific Information:
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.
Methods added in JAVA 8 are generally supported when the HSQLDB jar is compiled
with JDK 8.
(fredt@users)
(campbell-burnet@users)
Author: Campbell Burnet (campbell-burnet@users dot sourceforge.net), Fred Toussi (fredt@users dot sourceforge.net) See Also: Version: 2.4.0 Since: HSQLDB 1.9.0
/**
* <!-- start generic documentation -->
* <P>The object used for executing a static SQL statement
* and returning the results it produces.
* <P>
* By default, only one <code>ResultSet</code> object per <code>Statement</code>
* object can be open at the same time. Therefore, if the reading of one
* <code>ResultSet</code> object is interleaved
* with the reading of another, each must have been generated by
* different <code>Statement</code> objects. All execution methods in the
* <code>Statement</code> interface implicitly close a statement's current
* <code>ResultSet</code> object if an open one exists.
* <!-- end generic documentation-->
*
* <!-- start release-specific documentation -->
* <div class="ReleaseSpecificDocumentation">
* <h3>HSQLDB-Specific Information:</h3><p>
* 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.<p>
*
* Methods added in JAVA 8 are generally supported when the HSQLDB jar is compiled
* with JDK 8.
* <p>
*
* (fredt@users)<br>
* (campbell-burnet@users)<p>
*
* </div>
* <!-- end release-specific documentation -->
*
* @author Campbell Burnet (campbell-burnet@users dot sourceforge.net)
* @author Fred Toussi (fredt@users dot sourceforge.net)
* @version 2.4.0
* @since HSQLDB 1.9.0
* @see JDBCConnection#createStatement
* @see JDBCResultSet
*/
public class JDBCStatement extends JDBCStatementBase implements Statement,
java.sql.Wrapper {
Executes the given SQL statement, which returns a single
ResultSet
object.
HSQLDB-Specific Information:
This method should not be used for statements other than SELECT queries.
From 2.0, HSQLDB throws an exception when the statement
is a DDL statement or an UPDATE or DELETE statement.
Params: - sql – an SQL statement to be sent to the database, typically a
static SQL
SELECT
statement
Throws: - SQLException – if a database access error occurs,
this method is called on a closed
Statement
or the given
SQL statement produces anything other than a single
ResultSet
object
Returns: a ResultSet
object that contains the data produced
by the given query; never null
/**
* <!-- start generic documentation -->
* Executes the given SQL statement, which returns a single
* <code>ResultSet</code> object.
* <!-- end generic documentation -->
*
* <!-- start release-specific documentation -->
* <div class="ReleaseSpecificDocumentation">
* <h3>HSQLDB-Specific Information:</h3> <p>
*
* This method should not be used for statements other than SELECT queries.<p>
*
* From 2.0, HSQLDB throws an exception when the statement
* is a DDL statement or an UPDATE or DELETE statement.
* </div>
* <!-- end release-specific documentation -->
*
* @param sql an SQL statement to be sent to the database, typically a
* static SQL <code>SELECT</code> statement
* @return a <code>ResultSet</code> object that contains the data produced
* by the given query; never <code>null</code>
* @exception SQLException if a database access error occurs,
* this method is called on a closed <code>Statement</code> or the given
* SQL statement produces anything other than a single
* <code>ResultSet</code> object
*/
public synchronized ResultSet executeQuery(
String sql) throws SQLException {
fetchResult(sql, StatementTypes.RETURN_RESULT,
JDBCStatementBase.NO_GENERATED_KEYS, null, null);
return getResultSet();
}
Executes the given SQL statement, which may be an INSERT
,
UPDATE
, or DELETE
statement or an
SQL statement that returns nothing, such as an SQL DDL statement.
Params: - sql – (JDBC4 clarification:) 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.
Throws: - SQLException – if a database access error occurs,
this method is called on a closed
Statement
or the given
SQL statement produces a ResultSet
object
Returns: (JDBC4 clarification:) either (1) the row count for SQL Data Manipulation Language (DML) statements
or (2) 0 for SQL statements that return nothing
/**
* <!-- start generic documentation -->
* Executes the given SQL statement, which may be an <code>INSERT</code>,
* <code>UPDATE</code>, or <code>DELETE</code> statement or an
* SQL statement that returns nothing, such as an SQL DDL statement.
* <!-- end generic documentation -->
*
* @param sql (JDBC4 clarification:) an SQL Data Manipulation Language (DML) statement, such as <code>INSERT</code>, <code>UPDATE</code> or
* <code>DELETE</code>; or an SQL statement that returns nothing,
* such as a DDL statement.
*
* @return (JDBC4 clarification:) either (1) the row count for SQL Data Manipulation Language (DML) statements
* or (2) 0 for SQL statements that return nothing
*
* @exception SQLException if a database access error occurs,
* this method is called on a closed <code>Statement</code> or the given
* SQL statement produces a <code>ResultSet</code> object
*/
public synchronized int executeUpdate(String sql) throws SQLException {
fetchResult(sql, StatementTypes.RETURN_COUNT,
JDBCStatementBase.NO_GENERATED_KEYS, null, null);
return resultIn.getUpdateCount();
}
Releases this Statement
object's database
and JDBC resources immediately instead of waiting for
this to happen when it is automatically closed.
It is generally good practice to release resources as soon as
you are finished with them to avoid tying up database
resources.
Calling the method close
on a Statement
object that is already closed has no effect.
Note:When a Statement
object is
closed, its current ResultSet
object, if one exists, is
also closed.
(JDBC4 deleted:) [A Statement
object is
automatically closed when it is garbage collected.]
Throws: - SQLException – if a database access error occurs
/**
* <!-- start generic documentation -->
* Releases this <code>Statement</code> object's database
* and JDBC resources immediately instead of waiting for
* this to happen when it is automatically closed.
* It is generally good practice to release resources as soon as
* you are finished with them to avoid tying up database
* resources.
* <P>
* Calling the method <code>close</code> on a <code>Statement</code>
* object that is already closed has no effect.
* <P>
* <B>Note:</B>When a <code>Statement</code> object is
* closed, its current <code>ResultSet</code> object, if one exists, is
* also closed.
* (JDBC4 deleted:) [A <code>Statement</code> object is
* automatically closed when it is garbage collected.]
* <!-- end generic documentation -->
*
* @exception SQLException if a database access error occurs
*/
public synchronized void close() throws SQLException {
if (isClosed) {
return;
}
closeResultData();
batchResultOut = null;
connection = null;
resultIn = null;
resultOut = null;
isClosed = true;
}
//----------------------------------------------------------------------
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.
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-Specific Information:
Including 1.7.2, HSQLDB always returns zero, meaning there
is no limit.
Throws: - SQLException – if a database access error occurs or
this method is called on a closed
Statement
See Also: Returns: the current column size limit for columns storing character and
binary values; zero means there is no limit
/**
* <!-- start generic documentation -->
* Retrieves the maximum number of bytes that can be
* returned for character and binary column values in a <code>ResultSet</code>
* object produced by this <code>Statement</code> object.
* This limit applies only to <code>BINARY</code>, <code>VARBINARY</code>,
* <code>LONGVARBINARY</code>, <code>CHAR</code>, <code>VARCHAR</code>,
* (JDBC4 new:) <code>NCHAR</code>, <code>NVARCHAR</code>, <code>LONGNVARCHAR</code>
* and <code>LONGVARCHAR</code> columns. If the limit is exceeded, the
* excess data is silently discarded.
* <!-- end generic documentation -->
*
* <!-- start release-specific documentation -->
* <div class="ReleaseSpecificDocumentation">
* <h3>HSQLDB-Specific Information:</h3> <p>
*
* Including 1.7.2, HSQLDB always returns zero, meaning there
* is no limit.
* </div>
* <!-- end release-specific documentation -->
*
* @return the current column size limit for columns storing character and
* binary values; zero means there is no limit
* @exception SQLException if a database access error occurs or
* this method is called on a closed <code>Statement</code>
* @see #setMaxFieldSize
*/
public synchronized int getMaxFieldSize() throws SQLException {
checkClosed();
return 0;
}
(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.
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.
HSQLDB-Specific Information:
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.
Params: - max – the new column size limit in bytes; zero means there is no limit
Throws: - SQLException – if a database access error occurs,
this method is called on a closed
Statement
or the condition max >= 0
is not satisfied
See Also:
/**
* <!-- start generic documentation -->
* (JDBC4 clarification:) Sets the limit for the maximum number of bytes in a <code>ResultSet</code>
* Sets the limit for the maximum number of bytes that can be returned for
* character and binary column values in a <code>ResultSet</code>
* object produced by this <code>Statement</code> object.
*
* This limit applies
* only to <code>BINARY</code>, <code>VARBINARY</code>,
* <code>LONGVARBINARY</code>, <code>CHAR</code>, <code>VARCHAR</code>,
* (JDBC4 new:) <code>NCHAR</code>, <code>NVARCHAR</code>, <code>LONGNVARCHAR</code> and
* <code>LONGVARCHAR</code> fields. If the limit is exceeded, the excess data
* is silently discarded. For maximum portability, use values
* greater than 256.
* <!-- emd generic documentation -->
*
* <!-- start release-specific documentation -->
* <div class="ReleaseSpecificDocumentation">
* <h3>HSQLDB-Specific Information:</h3> <p>
*
* 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). <p>
*
* 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.
* </div>
* <!-- end release-specific documentation -->
*
* @param max the new column size limit in bytes; zero means there is no limit
* @exception SQLException if a database access error occurs,
* this method is called on a closed <code>Statement</code>
* or the condition {@code max >= 0} is not satisfied
* @see #getMaxFieldSize
*/
public void setMaxFieldSize(int max) throws SQLException {
checkClosed();
if (max < 0) {
throw JDBCUtil.outOfRangeArgument();
}
}
Retrieves the maximum number of rows that a
ResultSet
object produced by this
Statement
object can contain. If this limit is exceeded,
the excess rows are silently dropped.
Throws: - SQLException – if a database access error occurs or
this method is called on a closed
Statement
See Also: Returns: the current maximum number of rows for a ResultSet
object produced by this Statement
object;
zero means there is no limit
/**
* <!-- start generic documentation -->
* Retrieves the maximum number of rows that a
* <code>ResultSet</code> object produced by this
* <code>Statement</code> object can contain. If this limit is exceeded,
* the excess rows are silently dropped.
* <!-- start generic documentation -->
*
* @return the current maximum number of rows for a <code>ResultSet</code>
* object produced by this <code>Statement</code> object;
* zero means there is no limit
* @exception SQLException if a database access error occurs or
* this method is called on a closed <code>Statement</code>
* @see #setMaxRows
*/
public synchronized int getMaxRows() throws SQLException {
checkClosed();
return maxRows;
}
(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.
If the limit is exceeded, the excess
rows are silently dropped.
Params: - max – the new max rows limit; zero means there is no limit
Throws: - SQLException – if a database access error occurs,
this method is called on a closed
Statement
or the condition max >= 0
is not satisfied
See Also:
/**
* <!-- start generic documentation -->
* (JDBC4 clarification:)
* Sets the limit for the maximum number of rows that any
* <code>ResultSet</code> object generated by this <code>Statement</code>
* object can contain to the given number.
* If the limit is exceeded, the excess
* rows are silently dropped.
* <!-- end generic documentation -->
*
* @param max the new max rows limit; zero means there is no limit
* @exception SQLException if a database access error occurs,
* this method is called on a closed <code>Statement</code>
* or the condition {@code max >= 0} is not satisfied
* @see #getMaxRows
*/
public synchronized void setMaxRows(int max) throws SQLException {
checkClosed();
if (max < 0) {
throw JDBCUtil.outOfRangeArgument();
}
maxRows = max;
}
Sets escape processing on or off.
If escape scanning is on (the default), the driver will do
escape substitution before sending the SQL statement to the database.
Note: Since prepared statements have usually been parsed prior
to making this call, disabling escape processing for
PreparedStatements
objects will have no effect.
Params: - enable –
true
to enable escape processing;
false
to disable it
Throws: - SQLException – if a database access error occurs or
this method is called on a closed
Statement
/**
* <!-- start generic documentation -->
* Sets escape processing on or off.
* If escape scanning is on (the default), the driver will do
* escape substitution before sending the SQL statement to the database.
*
* Note: Since prepared statements have usually been parsed prior
* to making this call, disabling escape processing for
* <code>PreparedStatements</code> objects will have no effect.
* <!-- end generic documentation -->
*
* @param enable <code>true</code> to enable escape processing;
* <code>false</code> to disable it
* @exception SQLException if a database access error occurs or
* this method is called on a closed <code>Statement</code>
*/
public void setEscapeProcessing(boolean enable) throws SQLException {
checkClosed();
isEscapeProcessing = enable;
}
Retrieves the number of seconds the driver will
wait for a Statement
object to execute.
If the limit is exceeded, a
SQLException
is thrown.
HSQLDB-Specific Information:
To present, HSQLDB always returns zero, meaning there
is no limit.
Throws: - SQLException – if a database access error occurs or
this method is called on a closed
Statement
See Also: Returns: the current query timeout limit in seconds; zero means there is
no limit
/**
* <!-- start generic documentation -->
* Retrieves the number of seconds the driver will
* wait for a <code>Statement</code> object to execute.
* If the limit is exceeded, a
* <code>SQLException</code> is thrown.
* <!-- end generic documentation -->
*
* <!-- start release-specific documentation -->
* <div class="ReleaseSpecificDocumentation">
* <h3>HSQLDB-Specific Information:</h3> <p>
*
* To present, HSQLDB always returns zero, meaning there
* is no limit.
* </div>
* <!-- end release-specific documentation -->
*
* @return the current query timeout limit in seconds; zero means there is
* no limit
* @exception SQLException if a database access error occurs or
* this method is called on a closed <code>Statement</code>
* @see #setQueryTimeout
*/
public synchronized int getQueryTimeout() throws SQLException {
checkClosed();
return queryTimeout;
}
Sets the number of seconds the driver will wait for a
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).
HSQLDB-Specific Information:
The maximum number of seconds to wait is 32767.
Params: - seconds – the new query timeout limit in seconds; zero means
there is no limit
Throws: - SQLException – if a database access error occurs,
this method is called on a closed
Statement
or the condition seconds >= 0
is not satisfied
See Also:
/**
* <!-- start generic documentation -->
* Sets the number of seconds the driver will wait for a
* <code>Statement</code> object to execute to the given number of seconds.
* If the limit is exceeded, an <code>SQLException</code> is thrown. A JDBC
* (JDBC4 clarification:)
* driver must apply this limit to the <code>execute</code>,
* <code>executeQuery</code> and <code>executeUpdate</code> methods. JDBC driver
* implementations may also apply this limit to <code>ResultSet</code> methods
* (consult your driver vendor documentation for details).
* <!-- end generic documentation -->
*
* <!-- start release-specific documentation -->
* <div class="ReleaseSpecificDocumentation">
* <h3>HSQLDB-Specific Information:</h3> <p>
*
* The maximum number of seconds to wait is 32767.
* </div>
* <!-- end release-specific documentation -->
*
* @param seconds the new query timeout limit in seconds; zero means
* there is no limit
* @exception SQLException if a database access error occurs,
* this method is called on a closed <code>Statement</code>
* or the condition {@code seconds >= 0} is not satisfied
* @see #getQueryTimeout
*/
public void setQueryTimeout(int seconds) throws SQLException {
checkClosed();
if (seconds < 0) {
throw JDBCUtil.outOfRangeArgument();
}
if (seconds > Short.MAX_VALUE) {
seconds = Short.MAX_VALUE;
}
queryTimeout = seconds;
}
Cancels this Statement
object if both the DBMS and
driver support aborting an SQL statement.
This method can be used by one thread to cancel a statement that
is being executed by another thread.
HSQLDB-Specific Information:
HSQLDB version 2.3.4 and later supports aborting an SQL query
or data update statement.
Throws: - SQLException – if a database access error occurs or
this method is called on a closed
Statement
- SQLFeatureNotSupportedException – if the JDBC driver does not support
this method
/**
* <!-- start generic documentation -->
* Cancels this <code>Statement</code> 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.
* <!-- end generic documentation -->
*
* <!-- start release-specific documentation -->
* <div class="ReleaseSpecificDocumentation">
* <h3>HSQLDB-Specific Information:</h3> <p>
*
* HSQLDB version 2.3.4 and later supports aborting an SQL query
* or data update statement.
* </div>
* <!-- end release-specific documentation -->
*
* @exception SQLException if a database access error occurs or
* this method is called on a closed <code>Statement</code>
* @exception SQLFeatureNotSupportedException if the JDBC driver does not support
* this method
*/
public void cancel() throws SQLException {
checkClosed();
String sql = resultOut.getMainString();
int randomId = connection.sessionProxy.getRandomId();
Result request = Result.newCancelRequest(randomId, -1, sql);
try {
Result response = connection.sessionProxy.cancel(request);
} catch (HsqlException e) {
throw JDBCUtil.sqlException(e);
}
}
Retrieves the first warning reported by calls on this 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.
HSQLDB-Specific Information:
In 2.0, HSQLDB may produces Statement warnings;
this method always returns null.
Throws: - SQLException – if a database access error occurs or
this method is called on a closed
Statement
Returns: the first SQLWarning
object or null
if there are no warnings
/**
* <!-- start generic documentation -->
* Retrieves the first warning reported by calls on this <code>Statement</code> object.
* Subsequent <code>Statement</code> object warnings will be chained to this
* <code>SQLWarning</code> object.
*
* <p>The warning chain is automatically cleared each time
* a statement is (re)executed. This method may not be called on a closed
* <code>Statement</code> object; doing so will cause an <code>SQLException</code>
* to be thrown.
*
* <P><B>Note:</B> If you are processing a <code>ResultSet</code> object, any
* warnings associated with reads on that <code>ResultSet</code> object
* will be chained on it rather than on the <code>Statement</code>
* object that produced it.
* <!-- end generic documentation -->
*
* <!-- start release-specific documentation -->
* <div class="ReleaseSpecificDocumentation">
* <h3>HSQLDB-Specific Information:</h3> <p>
*
* In 2.0, HSQLDB may produces Statement warnings;
* this method always returns null.
* </div>
* <!-- end release-specific documentation -->
*
* @return the first <code>SQLWarning</code> object or <code>null</code>
* if there are no warnings
* @exception SQLException if a database access error occurs or
* this method is called on a closed <code>Statement</code>
*/
public synchronized SQLWarning getWarnings() throws SQLException {
checkClosed();
return rootWarning;
}
Clears all the warnings reported on this Statement
object. After a call to this method,
the method getWarnings
will return
null
until a new warning is reported for this
Statement
object.
HSQLDB-Specific Information:
In HSQLDB 2.0, SQLWarning
objects may
be produced for Statement Objects; calls to this method clear the warnings.
Throws: - SQLException – if a database access error occurs or
this method is called on a closed
Statement
/**
* <!-- start generic documentation -->
* Clears all the warnings reported on this <code>Statement</code>
* object. After a call to this method,
* the method <code>getWarnings</code> will return
* <code>null</code> until a new warning is reported for this
* <code>Statement</code> object.
* <!-- end generic documentation -->
*
* <!-- start release-specific documentation -->
* <div class="ReleaseSpecificDocumentation">
* <h3>HSQLDB-Specific Information:</h3> <p>
*
* In HSQLDB 2.0, <code>SQLWarning</code> objects may
* be produced for Statement Objects; calls to this method clear the warnings.
* </div>
* <!-- end release-specific documentation -->
*
* @exception SQLException if a database access error occurs or
* this method is called on a closed <code>Statement</code>
*/
public synchronized void clearWarnings() throws SQLException {
checkClosed();
rootWarning = null;
}
/** @todo 1.9.0 - implement */
Sets the SQL cursor name to the given 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.
HSQLDB-Specific Information:
Including 2.0, HSQLDB does not support named cursors;
calls to this method are ignored.
Params: - name – the new cursor name, which must be unique within
a connection
Throws: - SQLException – if a database access error occurs or
this method is called on a closed
Statement
- SQLFeatureNotSupportedException – if the JDBC driver does not support this method
/**
* <!-- start generic documentation -->
* Sets the SQL cursor name to the given <code>String</code>, which
* will be used by subsequent <code>Statement</code> object
* <code>execute</code> methods. This name can then be
* used in SQL positioned update or delete statements to identify the
* current row in the <code>ResultSet</code> 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 <code>SELECT</code> statement
* should have the form <code>SELECT FOR UPDATE</code>. If
* <code>FOR UPDATE</code> is not present, positioned updates may fail.
*
* <P><B>Note:</B> By definition, the execution of positioned updates and
* deletes must be done by a different <code>Statement</code> object than
* the one that generated the <code>ResultSet</code> object being used for
* positioning. Also, cursor names must be unique within a connection.
* <!-- end generic documentation -->
*
* <!-- start release-specific documentation -->
* <div class="ReleaseSpecificDocumentation">
* <h3>HSQLDB-Specific Information:</h3> <p>
*
* Including 2.0, HSQLDB does not support named cursors;
* calls to this method are ignored.
* </div>
* <!-- end release-specific documentation -->
*
* @param name the new cursor name, which must be unique within
* a connection
* @exception SQLException if a database access error occurs or
* this method is called on a closed <code>Statement</code>
* @throws SQLFeatureNotSupportedException if the JDBC driver does not support this method
*/
public void setCursorName(String name) throws SQLException {
checkClosed();
}
//----------------------- Multiple Results --------------------------
Executes the given SQL statement, which may return multiple results.
In some (uncommon) situations, a single SQL statement may return
multiple result sets and/or update counts. Normally you can ignore
this unless you are (1) executing a stored procedure that you know may
return multiple results or (2) you are dynamically executing an
unknown SQL string.
The execute
method executes an SQL statement and indicates the
form of the first result. You must then use the methods
getResultSet
or getUpdateCount
to retrieve the result, and getMoreResults
to
move to any subsequent result(s).
Params: - sql – any SQL statement
Throws: - SQLException – if a database access error occurs or
this method is called on a closed
Statement
See Also: Returns: true
if the first result is a ResultSet
object; false
if it is an update count or there are
no results
/**
* <!-- start generic documentation -->
* Executes the given SQL statement, which may return multiple results.
* In some (uncommon) situations, a single SQL statement may return
* multiple result sets and/or update counts. Normally you can ignore
* this unless you are (1) executing a stored procedure that you know may
* return multiple results or (2) you are dynamically executing an
* unknown SQL string.
* <P>
* The <code>execute</code> method executes an SQL statement and indicates the
* form of the first result. You must then use the methods
* <code>getResultSet</code> or <code>getUpdateCount</code>
* to retrieve the result, and <code>getMoreResults</code> to
* move to any subsequent result(s).
* <!-- end generic documentation -->
*
* @param sql any SQL statement
* @return <code>true</code> if the first result is a <code>ResultSet</code>
* object; <code>false</code> if it is an update count or there are
* no results
* @exception SQLException if a database access error occurs or
* this method is called on a closed <code>Statement</code>
* @see #getResultSet
* @see #getUpdateCount
* @see #getMoreResults
*/
public synchronized boolean execute(String sql) throws SQLException {
fetchResult(sql, StatementTypes.RETURN_ANY,
JDBCStatementBase.NO_GENERATED_KEYS, null, null);
return currentResultSet != null;
}
Retrieves the current result as a ResultSet
object.
This method should be called only once per result.
HSQLDB-Specific Information:
Throws: - SQLException – if a database access error occurs or
this method is called on a closed
Statement
See Also: Returns: the current result as a ResultSet
object or
null
if the result is an update count or there are no more results
/**
* <!-- start generic documentation -->
* Retrieves the current result as a <code>ResultSet</code> object.
* This method should be called only once per result.
* <!-- end generic documentation -->
*
* <!-- start release-specific documentation -->
* <div class="ReleaseSpecificDocumentation">
* <h3>HSQLDB-Specific Information:</h3> <p>
*
* </div>
* <!-- end release-specific documentation -->
*
* @return the current result as a <code>ResultSet</code> object or
* <code>null</code> if the result is an update count or there are no more results
* @exception SQLException if a database access error occurs or
* this method is called on a closed <code>Statement</code>
* @see #execute
*/
public synchronized ResultSet getResultSet() throws SQLException {
return super.getResultSet();
}
Retrieves the current result as an update count;
if the result is a ResultSet
object or there are no more results, -1
is returned. This method should be called only once per result.
Throws: - SQLException – if a database access error occurs or
this method is called on a closed
Statement
See Also: Returns: the current result as an update count; -1 if the current result is a
ResultSet
object or there are no more results
/**
* <!-- start generic documentation -->
* Retrieves the current result as an update count;
* if the result is a <code>ResultSet</code> object or there are no more results, -1
* is returned. This method should be called only once per result.
* <!-- end generic documentation -->
*
* @return the current result as an update count; -1 if the current result is a
* <code>ResultSet</code> object or there are no more results
* @exception SQLException if a database access error occurs or
* this method is called on a closed <code>Statement</code>
* @see #execute
*/
public synchronized int getUpdateCount() throws SQLException {
return super.getUpdateCount();
}
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
.
There are no more results when the following is true:
// stmt is a Statement object
((stmt.getMoreResults() == false) && (stmt.getUpdateCount() == -1))
Throws: - SQLException – if a database access error occurs or
this method is called on a closed
Statement
See Also: Returns: true
if the next result is a ResultSet
object; false
if it is an update count or there are
no more results
/**
* <!-- start generic documentation -->
* Moves to this <code>Statement</code> object's next result, returns
* <code>true</code> if it is a <code>ResultSet</code> object, and
* implicitly closes any current <code>ResultSet</code>
* object(s) obtained with the method <code>getResultSet</code>.
*
* <P>There are no more results when the following is true:
* <PRE>
* // stmt is a Statement object {@code
* ((stmt.getMoreResults() == false) && (stmt.getUpdateCount() == -1))
* }</PRE>
* <!-- end generic documentation -->
*
* @return <code>true</code> if the next result is a <code>ResultSet</code>
* object; <code>false</code> if it is an update count or there are
* no more results
* @exception SQLException if a database access error occurs or
* this method is called on a closed <code>Statement</code>
* @see #execute
*/
public synchronized boolean getMoreResults() throws SQLException {
return getMoreResults(JDBCStatementBase.CLOSE_CURRENT_RESULT);
}
//--------------------------JDBC 2.0-----------------------------
Gives the driver a hint as to the direction in which
rows will be processed in 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.
HSQLDB-Specific Information:
HSQLDB accepts all valid parameters.
Params: - direction – the initial direction for processing rows
Throws: - 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_UNKNOWN
See Also: Since: JDK 1.2
/**
* <!-- start generic documentation -->
* Gives the driver a hint as to the direction in which
* rows will be processed in <code>ResultSet</code>
* objects created using this <code>Statement</code> object. The
* default value is <code>ResultSet.FETCH_FORWARD</code>.
* <P>
* Note that this method sets the default fetch direction for
* result sets generated by this <code>Statement</code> object.
* Each result set has its own methods for getting and setting
* its own fetch direction.
* <!-- end generic documentation -->
*
* <!-- start release-specific documentation -->
* <div class="ReleaseSpecificDocumentation">
* <h3>HSQLDB-Specific Information:</h3> <p>
*
* HSQLDB accepts all valid parameters. <p>
* </div>
* <!-- end release-specific documentation -->
*
* @param direction the initial direction for processing rows
* @exception SQLException if a database access error occurs,
* this method is called on a closed <code>Statement</code>
* or the given direction
* is not one of <code>ResultSet.FETCH_FORWARD</code>,
* <code>ResultSet.FETCH_REVERSE</code>, or <code>ResultSet.FETCH_UNKNOWN</code>
* @since JDK 1.2
* @see #getFetchDirection
*/
public synchronized void setFetchDirection(
int direction) throws SQLException {
checkClosed();
checkClosed();
switch (direction) {
case ResultSet.FETCH_FORWARD :
case ResultSet.FETCH_REVERSE :
case ResultSet.FETCH_UNKNOWN :
fetchDirection = direction;
break;
default :
throw JDBCUtil.invalidArgument();
}
}
Retrieves the direction for fetching rows from
database tables that is the default for result sets
generated from this Statement
object.
If this Statement
object has not set
a fetch direction by calling the method setFetchDirection
,
the return value is implementation-specific.
HSQLDB-Specific Information:
HSQLDB returns the fetch direction.
Throws: - SQLException – if a database access error occurs or
this method is called on a closed
Statement
See Also: Returns: the default fetch direction for result sets generated
from this Statement
object Since: JDK 1.2
/**
* <!-- start generic documentation -->
* Retrieves the direction for fetching rows from
* database tables that is the default for result sets
* generated from this <code>Statement</code> object.
* If this <code>Statement</code> object has not set
* a fetch direction by calling the method <code>setFetchDirection</code>,
* the return value is implementation-specific.
* <!-- end generic documentation -->
*
* <!-- start release-specific documentation -->
* <div class="ReleaseSpecificDocumentation">
* <h3>HSQLDB-Specific Information:</h3> <p>
*
* HSQLDB returns the fetch direction. <p>
* </div>
* <!-- end release-specific documentation -->
*
* @return the default fetch direction for result sets generated
* from this <code>Statement</code> object
* @exception SQLException if a database access error occurs or
* this method is called on a closed <code>Statement</code>
* @since JDK 1.2
* @see #setFetchDirection
*/
public int getFetchDirection() throws SQLException {
checkClosed();
return this.fetchDirection;
}
(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
.
If the value specified is zero, then the hint is ignored.
The default value is zero.
HSQLDB-Specific Information:
HSQLDB uses the specified value as a hint, but may process more or fewer
rows than specified.
Params: - rows – the number of rows to fetch
Throws: - SQLException – if a database access error occurs,
this method is called on a closed
Statement
or the (JDBC4 modified:) condition rows >= 0
is not satisfied.
See Also: Since: JDK 1.2
/**
* <!-- start generic documentation -->
* (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
* <code>ResultSet</code> objects generated by this <code>Statement</code>.
* If the value specified is zero, then the hint is ignored.
* The default value is zero.
* <!-- start generic documentation -->
*
* <!-- start release-specific documentation -->
* <div class="ReleaseSpecificDocumentation">
* <h3>HSQLDB-Specific Information:</h3> <p>
*
* HSQLDB uses the specified value as a hint, but may process more or fewer
* rows than specified.
* </div>
* <!-- end release-specific documentation -->
*
* @param rows the number of rows to fetch
* @exception SQLException if a database access error occurs,
* this method is called on a closed <code>Statement</code> or the
* (JDBC4 modified:)
* condition {@code rows >= 0} is not satisfied.
* @since JDK 1.2
* @see #getFetchSize
*/
public synchronized void setFetchSize(int rows) throws SQLException {
checkClosed();
if (rows < 0) {
throw JDBCUtil.outOfRangeArgument();
}
fetchSize = rows;
}
Retrieves the number of result set rows that is the default
fetch size for 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-Specific Information
HSQLDB returns 0 by default, or the fetch size specified by setFetchSize
Throws: - SQLException – if a database access error occurs or
this method is called on a closed
Statement
See Also: Returns: the default fetch size for result sets generated
from this Statement
object Since: JDK 1.2
/**
* <!-- start generic documentation -->
* Retrieves the number of result set rows that is the default
* fetch size for <code>ResultSet</code> objects
* generated from this <code>Statement</code> object.
* If this <code>Statement</code> object has not set
* a fetch size by calling the method <code>setFetchSize</code>,
* the return value is implementation-specific.
* <!-- end generic documentation -->
*
* <!-- start release-specific documentation -->
* <div class="ReleaseSpecificDocumentation">
* <b>HSQLDB-Specific Information</b> <p>
*
* HSQLDB returns 0 by default, or the fetch size specified by setFetchSize
* </div>
* <!-- end release-specific documentation -->
*
* @return the default fetch size for result sets generated
* from this <code>Statement</code> object
* @exception SQLException if a database access error occurs or
* this method is called on a closed <code>Statement</code>
* @since JDK 1.2
* @see #setFetchSize
*/
public synchronized int getFetchSize() throws SQLException {
checkClosed();
return fetchSize;
}
Retrieves the result set concurrency for ResultSet
objects
generated by this Statement
object.
HSQLDB-Specific Information:
HSQLDB supports CONCUR_READ_ONLY
and
CONCUR_UPDATABLE
concurrency.
Throws: - SQLException – if a database access error occurs or
this method is called on a closed
Statement
Returns: either ResultSet.CONCUR_READ_ONLY
or
ResultSet.CONCUR_UPDATABLE
Since: JDK 1.2
/**
* <!-- start generic documentation -->
* Retrieves the result set concurrency for <code>ResultSet</code> objects
* generated by this <code>Statement</code> object.
* <!-- end generic documentation -->
*
* <!-- start release-specific documentation -->
* <div class="ReleaseSpecificDocumentation">
* <h3>HSQLDB-Specific Information:</h3> <p>
*
* HSQLDB supports <code>CONCUR_READ_ONLY</code> and
* <code>CONCUR_UPDATABLE</code> concurrency.
* </div>
* <!-- end release-specific documentation -->
*
* @return either <code>ResultSet.CONCUR_READ_ONLY</code> or
* <code>ResultSet.CONCUR_UPDATABLE</code>
* @exception SQLException if a database access error occurs or
* this method is called on a closed <code>Statement</code>
* @since JDK 1.2
*/
public synchronized int getResultSetConcurrency() throws SQLException {
checkClosed();
return ResultProperties.getJDBCConcurrency(rsProperties);
}
Retrieves the result set type for ResultSet
objects
generated by this Statement
object.
HSQLDB-Specific Information:
HSQLDB 1.7.0 and later versions support TYPE_FORWARD_ONLY
and TYPE_SCROLL_INSENSITIVE
.
Throws: - SQLException – if a database access error occurs or
this method is called on a closed
Statement
Returns: one of ResultSet.TYPE_FORWARD_ONLY
,
ResultSet.TYPE_SCROLL_INSENSITIVE
, or
ResultSet.TYPE_SCROLL_SENSITIVE
Since: JDK 1.2
/**
* <!-- start generic documentation -->
* Retrieves the result set type for <code>ResultSet</code> objects
* generated by this <code>Statement</code> object.
* <!-- end generic documentation -->
*
* <!-- start release-specific documentation -->
* <div class="ReleaseSpecificDocumentation">
* <h3>HSQLDB-Specific Information:</h3> <p>
*
* HSQLDB 1.7.0 and later versions support <code>TYPE_FORWARD_ONLY</code>
* and <code>TYPE_SCROLL_INSENSITIVE</code>.
* </div>
* <!-- end release-specific documentation -->
*
* @return one of <code>ResultSet.TYPE_FORWARD_ONLY</code>,
* <code>ResultSet.TYPE_SCROLL_INSENSITIVE</code>, or
* <code>ResultSet.TYPE_SCROLL_SENSITIVE</code>
* @exception SQLException if a database access error occurs or
* this method is called on a closed <code>Statement</code>
* @since JDK 1.2
*/
public synchronized int getResultSetType() throws SQLException {
checkClosed();
return ResultProperties.getJDBCScrollability(rsProperties);
}
Adds the given SQL command to the current list of commands for this
Statement
object. The commands in this list can be
executed as a batch by calling the method executeBatch
.
(JDBC4 clarification:)
NOTE: Support of an ability to batch updates is optional.
HSQLDB-Specific Information:
Starting with 1.7.2, this feature is supported.
Params: - sql – typically this is a SQL
INSERT
or
UPDATE
statement
(:JDBC4 modified)
Throws: - SQLException – if a database access error occurs,
this method is called on a closed
Statement
or the
driver does not support batch updates
See Also: Since: JDK 1.2
/**
* <!-- start generic documentation -->
* Adds the given SQL command to the current list of commands for this
* <code>Statement</code> object. The commands in this list can be
* executed as a batch by calling the method <code>executeBatch</code>.
* <P>
* (JDBC4 clarification:)<p>
* <B>NOTE:</B> Support of an ability to batch updates is optional.
*
* <!-- end generic documentation -->
*
* <!-- start release-specific documentation -->
* <div class="ReleaseSpecificDocumentation">
* <h3>HSQLDB-Specific Information:</h3> <p>
*
* Starting with 1.7.2, this feature is supported.
* </div>
* <!-- end release-specific documentation -->
*
* @param sql typically this is a SQL <code>INSERT</code> or
* <code>UPDATE</code> statement
* (:JDBC4 modified)
* @exception SQLException if a database access error occurs,
* this method is called on a closed <code>Statement</code> or the
* driver does not support batch updates
* @see #executeBatch
* @since JDK 1.2
*/
public synchronized void addBatch(String sql) throws SQLException {
checkClosed();
if (isEscapeProcessing) {
sql = connection.nativeSQL(sql);
}
if (batchResultOut == null) {
batchResultOut = Result.newBatchedExecuteRequest();
}
batchResultOut.getNavigator().add(new Object[] { sql });
}
Empties this Statement
object's current list of
SQL commands.
(JDBC4 clarification:)
NOTE: Support of an ability to batch updates is optional.
HSQLDB-Specific Information:
Starting with HSQLDB 1.7.2, this feature is supported.
Throws: - SQLException – if a database access error occurs,
this method is called on a closed
Statement
or the
driver does not support batch updates
See Also: Since: JDK 1.2
/**
* <!-- start generic documentation -->
* Empties this <code>Statement</code> object's current list of
* SQL commands.
* <P>
* (JDBC4 clarification:) <p>
* <B>NOTE:</B> Support of an ability to batch updates is optional.
* <!-- start generic documentation -->
*
* <!-- start release-specific documentation -->
* <div class="ReleaseSpecificDocumentation">
* <h3>HSQLDB-Specific Information:</h3> <p>
*
* Starting with HSQLDB 1.7.2, this feature is supported.
* </div>
* <!-- end release-specific documentation -->
*
* @exception SQLException if a database access error occurs,
* this method is called on a closed <code>Statement</code> or the
* driver does not support batch updates
* @see #addBatch
* @since JDK 1.2
*/
public synchronized void clearBatch() throws SQLException {
checkClosed();
if (batchResultOut != null) {
batchResultOut.getNavigator().clear();
}
}
Submits a batch of commands to the database for execution and
if all commands execute successfully, returns an array of update counts.
The 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:
- A number greater than or equal to zero -- indicates that the
command was processed successfully and is an update count giving the
number of rows in the database that were affected by the command's
execution
- A value of
SUCCESS_NO_INFO
-- indicates that the command was
processed successfully but that the number of rows affected is
unknown
If one of the commands in a batch update fails to execute properly,
this method throws 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:
- A value of
EXECUTE_FAILED
-- indicates that the command failed
to execute successfully and occurs only if a driver continues to
process commands after a command fails
(JDBC4 clarification:)
NOTE: Support of an ability to batch updates is optional.
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 process commands in a batch
update after a BatchUpdateException
object has been thrown.
HSQLDB-Specific Information:
Starting with HSQLDB 1.7.2, this feature is supported.
HSQLDB stops execution of commands in a batch when one of the commands
results in an exception. The size of the returned array equals the
number of commands that were executed successfully.
Throws: - 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.
See Also: Returns: an array of update counts containing one element for each
command in the batch. The elements of the array are ordered according
to the order in which commands were added to the batch. Since: JDK 1.3
/**
* <!-- start generic documentation -->
* Submits a batch of commands to the database for execution and
* if all commands execute successfully, returns an array of update counts.
* The <code>int</code> 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 <code>executeBatch</code>
* may be one of the following:
* <OL>
* <LI>A number greater than or equal to zero -- indicates that the
* command was processed successfully and is an update count giving the
* number of rows in the database that were affected by the command's
* execution
* <LI>A value of <code>SUCCESS_NO_INFO</code> -- indicates that the command was
* processed successfully but that the number of rows affected is
* unknown
* <P>
* If one of the commands in a batch update fails to execute properly,
* this method throws a <code>BatchUpdateException</code>, 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
* <code>BatchUpdateException.getUpdateCounts</code>
* will contain as many elements as there are commands in the batch, and
* at least one of the elements will be the following:
*
* <LI>A value of <code>EXECUTE_FAILED</code> -- indicates that the command failed
* to execute successfully and occurs only if a driver continues to
* process commands after a command fails
* </OL>
* <P>
* (JDBC4 clarification:) <p>
* <B>NOTE:</B> Support of an ability to batch updates is optional.
* <p>
* 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 process commands in a batch
* update after a <code>BatchUpdateException</code> object has been thrown.
* <!-- end generic documentation -->
*
* <!-- start release-specific documentation -->
* <div class="ReleaseSpecificDocumentation">
* <h3>HSQLDB-Specific Information:</h3> <p>
*
* Starting with HSQLDB 1.7.2, this feature is supported. <p>
*
* 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.<p>
*
* </div>
* <!-- end release-specific documentation -->
*
* @return an array of update counts containing one element for each
* command in the batch. The elements of the array are ordered according
* to the order in which commands were added to the batch.
* @exception SQLException if a database access error occurs,
* this method is called on a closed <code>Statement</code> or the
* driver does not support batch statements. Throws {@link BatchUpdateException}
* (a subclass of <code>SQLException</code>) if one of the commands sent to the
* database fails to execute properly or attempts to return a result set.
*
*
* @see #addBatch
* @see java.sql.DatabaseMetaData#supportsBatchUpdates
* @since JDK 1.3
*/
public synchronized int[] executeBatch() throws SQLException {
checkClosed();
generatedResult = null;
if (batchResultOut == null) {
batchResultOut = Result.newBatchedExecuteRequest();
}
int batchCount = batchResultOut.getNavigator().getSize();
try {
resultIn = connection.sessionProxy.execute(batchResultOut);
performPostExecute();
} catch (HsqlException e) {
batchResultOut.getNavigator().clear();
throw JDBCUtil.sqlException(e);
}
batchResultOut.getNavigator().clear();
if (resultIn.isError()) {
throw JDBCUtil.sqlException(resultIn);
}
RowSetNavigator navigator = resultIn.getNavigator();
int[] updateCounts = new int[navigator.getSize()];
for (int i = 0; navigator.next(); i++) {
Object[] data = navigator.getCurrent();
updateCounts[i] = ((Integer) data[0]).intValue();
}
if (updateCounts.length != batchCount) {
if (errorResult == null) {
throw new BatchUpdateException(updateCounts);
} else {
throw new BatchUpdateException(errorResult.getMainString(),
errorResult.getSubString(),
errorResult.getErrorCode(), updateCounts);
}
}
return updateCounts;
}
Retrieves the Connection
object
that produced this Statement
object.
Throws: - SQLException – if a database access error occurs or
this method is called on a closed
Statement
Returns: the connection that produced this statement Since: JDK 1.2
/**
* <!-- start generic documentation -->
* Retrieves the <code>Connection</code> object
* that produced this <code>Statement</code> object.
* <!-- end generic documentation -->
*
* @return the connection that produced this statement
* @exception SQLException if a database access error occurs or
* this method is called on a closed <code>Statement</code>
* @since JDK 1.2
*/
public synchronized Connection getConnection() throws SQLException {
checkClosed();
return connection;
}
//--------------------------JDBC 3.0-----------------------------
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.
There are no more results when the following is true:
// stmt is a Statement object
((stmt.getMoreResults(current) == false) && (stmt.getUpdateCount() == -1))
HSQLDB-Specific Information:
HSQLDB moves to the next ResultSet and returns the correct result.
Params: - current – 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_RESULTS
Throws: - 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_RESULTS
See Also: Returns: true
if the next result is a ResultSet
object; false
if it is an update count or there are no
more resultsSince: JDK 1.4, HSQLDB 1.7
/**
* <!-- start generic documentation -->
* Moves to this <code>Statement</code> object's next result, deals with
* any current <code>ResultSet</code> object(s) according to the instructions
* specified by the given flag, and returns
* <code>true</code> if the next result is a <code>ResultSet</code> object.
*
* <P>There are no more results when the following is true:
* <PRE>
* // stmt is a Statement object{@code
* ((stmt.getMoreResults(current) == false) && (stmt.getUpdateCount() == -1))
* }</PRE>
* <!-- end generic documentation -->
*
* <!-- start release-specific documentation -->
* <div class="ReleaseSpecificDocumentation">
* <h3>HSQLDB-Specific Information:</h3> <p>
*
* HSQLDB moves to the next ResultSet and returns the correct result. <p>
* </div>
* <!-- end release-specific documentation -->
*
* @param current one of the following <code>Statement</code>
* constants indicating what should happen to current
* <code>ResultSet</code> objects obtained using the method
* <code>getResultSet</code>:
* <code>Statement.CLOSE_CURRENT_RESULT</code>,
* <code>Statement.KEEP_CURRENT_RESULT</code>, or
* <code>Statement.CLOSE_ALL_RESULTS</code>
* @return <code>true</code> if the next result is a <code>ResultSet</code>
* object; <code>false</code> if it is an update count or there are no
* more results
* @exception SQLException if a database access error occurs,
* this method is called on a closed <code>Statement</code> or the argument
* supplied is not one of the following:
* <code>Statement.CLOSE_CURRENT_RESULT</code>,
* <code>Statement.KEEP_CURRENT_RESULT</code>, or
* <code>Statement.CLOSE_ALL_RESULTS</code>
* @since JDK 1.4, HSQLDB 1.7
* @see #execute
*/
public synchronized boolean getMoreResults(
int current) throws SQLException {
return super.getMoreResults(current);
}
Retrieves any auto-generated keys created as a result of executing this
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.
HSQLDB-Specific Information:
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 executeUdate 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.
Throws: - SQLException – if a database access error occurs or
this method is called on a closed
Statement
- SQLFeatureNotSupportedException – if the JDBC driver does not support this method
Returns: a ResultSet
object containing the auto-generated key(s)
generated by the execution of this Statement
object Since: JDK 1.4, HSQLDB 1.7
/**
* <!-- start generic documentation -->
* Retrieves any auto-generated keys created as a result of executing this
* <code>Statement</code> object. If this <code>Statement</code> object did
* not generate any keys, an empty <code>ResultSet</code>
* object is returned.
* <p>(JDBC4 clarification:)
* <p><B>Note:</B>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.
* <!-- end generic documentation -->
*
* <!-- start release-specific documentation -->
* <div class="ReleaseSpecificDocumentation">
* <h3>HSQLDB-Specific Information:</h3> <p>
*
* Starting with version 2.0, HSQLDB supports this feature with single-row
* and multi-row insert, update and merge statements. <p>
*
* 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<p>
*
* If the executeUdate method did not specify the columns which represent
* the auto-generated keys the IDENTITY column or GENERATED column(s) of the
* table are returned.<p>
*
* 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.<p>
*
* 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.
*
* </div>
* <!-- end release-specific documentation -->
*
* @return a <code>ResultSet</code> object containing the auto-generated key(s)
* generated by the execution of this <code>Statement</code> object
* @exception SQLException if a database access error occurs or
* this method is called on a closed <code>Statement</code>
* @throws SQLFeatureNotSupportedException if the JDBC driver does not support this method
* @since JDK 1.4, HSQLDB 1.7
*/
public synchronized ResultSet getGeneratedKeys() throws SQLException {
return getGeneratedResultSet();
}
Executes the given SQL statement and signals the driver with the
given flag about whether the
auto-generated keys produced by this Statement
object
should be made available for retrieval. The driver will ignore the
flag if the SQL statement
is not an INSERT
statement, or an SQL statement able to return
auto-generated keys (the list of such statements is vendor-specific).
HSQLDB-Specific Information:
Starting with version 2.0, HSQLDB supports returning generated columns
with single-row and multi-row INSERT, UPDATE and MERGE statements.
If the table has an IDENTITY or GENERATED column(s) the values for these
columns are returned in the next call to getGeneratedKeys().
Params: - sql – 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.
(:JDBC4 clarification) - autoGeneratedKeys – a flag indicating whether auto-generated keys
should be made available for retrieval;
one of the following constants:
Statement.RETURN_GENERATED_KEYS
Statement.NO_GENERATED_KEYS
Throws: - SQLException – if a database access error occurs,
this method is called on a closed
Statement
, the given
SQL statement returns a ResultSet
object, or
the given constant is not one of those allowed - SQLFeatureNotSupportedException – if the JDBC driver does not support
this method with a constant of Statement.RETURN_GENERATED_KEYS
Returns: either (1) the row count for SQL Data Manipulation Language (DML) statements
or (2) 0 for SQL statements that return nothing
(:JDBC4 clarification) Since: JDK 1.4, HSQLDB 1.7
/**
* <!-- start generic documentation -->
* Executes the given SQL statement and signals the driver with the
* given flag about whether the
* auto-generated keys produced by this <code>Statement</code> object
* should be made available for retrieval. The driver will ignore the
* flag if the SQL statement
* is not an <code>INSERT</code> statement, or an SQL statement able to return
* auto-generated keys (the list of such statements is vendor-specific).
* <!-- end generic documentation -->
*
* <!-- start release-specific documentation -->
* <div class="ReleaseSpecificDocumentation">
* <h3>HSQLDB-Specific Information:</h3> <p>
*
* Starting with version 2.0, HSQLDB supports returning generated columns
* with single-row and multi-row INSERT, UPDATE and MERGE statements. <p>
* If the table has an IDENTITY or GENERATED column(s) the values for these
* columns are returned in the next call to getGeneratedKeys().
*
* </div>
* <!-- end release-specific documentation -->
* @param sql an SQL Data Manipulation Language (DML) statement, such as <code>INSERT</code>, <code>UPDATE</code> or
* <code>DELETE</code>; or an SQL statement that returns nothing,
* such as a DDL statement.
* (:JDBC4 clarification)
*
* @param autoGeneratedKeys a flag indicating whether auto-generated keys
* should be made available for retrieval;
* one of the following constants:
* <code>Statement.RETURN_GENERATED_KEYS</code>
* <code>Statement.NO_GENERATED_KEYS</code>
* @return either (1) the row count for SQL Data Manipulation Language (DML) statements
* or (2) 0 for SQL statements that return nothing
* (:JDBC4 clarification)
*
* @exception SQLException if a database access error occurs,
* this method is called on a closed <code>Statement</code>, the given
* SQL statement returns a <code>ResultSet</code> object, or
* the given constant is not one of those allowed
* @exception SQLFeatureNotSupportedException if the JDBC driver does not support
* this method with a constant of Statement.RETURN_GENERATED_KEYS
* @since JDK 1.4, HSQLDB 1.7
*/
public synchronized int executeUpdate(String sql,
int autoGeneratedKeys) throws SQLException {
if (autoGeneratedKeys != Statement.RETURN_GENERATED_KEYS
&& autoGeneratedKeys != Statement.NO_GENERATED_KEYS) {
throw JDBCUtil.invalidArgument("autoGeneratedKeys");
}
fetchResult(sql, StatementTypes.RETURN_COUNT, autoGeneratedKeys, null,
null);
if (resultIn.isError()) {
throw JDBCUtil.sqlException(resultIn);
}
return resultIn.getUpdateCount();
}
Executes the given SQL statement and signals the driver that the
auto-generated keys indicated in the given array should be made available
for retrieval. The driver will ignore the array if the SQL statement
is not an INSERT
statement, or an SQL statement able to return
(JDBC 4 clarification)
auto-generated keys (the list of such statements is vendor-specific).
HSQLDB-Specific Information:
Starting with version 2.0, HSQLDB supports returning generated columns
with single-row and multi-row INSERT, UPDATE and MERGE statements.
The columnIndexes may specify any set of columns of the table.
Params: - sql – 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.
(:JDBC4 clarification) - columnIndexes – an array of column indexes indicating the columns
that should be returned from the inserted row
Throws: - SQLException – if a database access error occurs,
this method is called on a closed
Statement
, the SQL
statement returns a ResultSet
object, or the
second argument supplied to this method is not an int
array
whose elements are valid column indexes - SQLFeatureNotSupportedException – if the JDBC driver does not support this method
Returns: either (1) the row count for SQL Data Manipulation Language (DML) statements
or (2) 0 for SQL statements that return nothing
(:JDBC 4 clarification) Since: JDK 1.4, HSQLDB 1.7
/**
* <!-- start generic documentation -->
* Executes the given SQL statement and signals the driver that the
* auto-generated keys indicated in the given array should be made available
* for retrieval. The driver will ignore the array if the SQL statement
* is not an <code>INSERT</code> statement, or an SQL statement able to return
* (JDBC 4 clarification)
* auto-generated keys (the list of such statements is vendor-specific).
* <!-- end generic documentation -->
*
* <!-- start release-specific documentation -->
* <div class="ReleaseSpecificDocumentation">
* <h3>HSQLDB-Specific Information:</h3> <p>
*
* Starting with version 2.0, HSQLDB supports returning generated columns
* with single-row and multi-row INSERT, UPDATE and MERGE statements. <p>
* The columnIndexes may specify any set of columns of the table.
*
* </div>
* <!-- end release-specific documentation -->
*
* @param sql an SQL Data Manipulation Language (DML) statement, such as <code>INSERT</code>, <code>UPDATE</code> or
* <code>DELETE</code>; or an SQL statement that returns nothing,
* such as a DDL statement.
* (:JDBC4 clarification)
*
* @param columnIndexes an array of column indexes indicating the columns
* that should be returned from the inserted row
* @return either (1) the row count for SQL Data Manipulation Language (DML) statements
* or (2) 0 for SQL statements that return nothing
* (:JDBC 4 clarification)
*
* @exception SQLException if a database access error occurs,
* this method is called on a closed <code>Statement</code>, the SQL
* statement returns a <code>ResultSet</code> object, or the
* second argument supplied to this method is not an <code>int</code> array
* whose elements are valid column indexes
* @throws SQLFeatureNotSupportedException if the JDBC driver does not support this method
* @since JDK 1.4, HSQLDB 1.7
*/
public synchronized int executeUpdate(String sql,
int[] columnIndexes) throws SQLException {
if (columnIndexes == null || columnIndexes.length == 0) {
throw JDBCUtil.invalidArgument("columnIndexes");
}
fetchResult(sql, StatementTypes.RETURN_COUNT,
ResultConstants.RETURN_GENERATED_KEYS_COL_INDEXES,
columnIndexes, null);
return resultIn.getUpdateCount();
}
Executes the given SQL statement and signals the driver that the
auto-generated keys indicated in the given array should be made available
for retrieval. The driver will ignore the array if the SQL statement
(JDBC4 clarification:)
is not an INSERT
statement, or an SQL statement able to return
auto-generated keys (the list of such statements is vendor-specific).
HSQLDB-Specific Information:
Starting with version 2.0, HSQLDB supports returning generated columns
with single-row and multi-row INSERT, UPDATE and MERGE statements.
The columnNames may specify any set of columns of the table.
Params: - sql – 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.
(:JDBC4 clarification) - columnNames – an array of the names of the columns that should be
returned from the inserted row
Throws: - SQLException – if a database access error occurs,
this method is called on a closed
Statement
, the SQL
statement returns a ResultSet
object, or the
second argument supplied to this method is not a String
array
whose elements are valid column names - SQLFeatureNotSupportedException – if the JDBC driver does not support this method
Returns: either the row count for INSERT
, UPDATE
,
or DELETE
statements, or 0 for SQL statements
that return nothing Since: JDK 1.4, HSQLDB 1.7
/**
* <!-- start generic documentation -->
* Executes the given SQL statement and signals the driver that the
* auto-generated keys indicated in the given array should be made available
* for retrieval. The driver will ignore the array if the SQL statement
* (JDBC4 clarification:)
* is not an <code>INSERT</code> statement, or an SQL statement able to return
* auto-generated keys (the list of such statements is vendor-specific).
* <!-- end generic documentation -->
*
* <!-- start release-specific documentation -->
* <div class="ReleaseSpecificDocumentation">
* <h3>HSQLDB-Specific Information:</h3> <p>
*
* Starting with version 2.0, HSQLDB supports returning generated columns
* with single-row and multi-row INSERT, UPDATE and MERGE statements. <p>
* The columnNames may specify any set of columns of the table.
*
* </div>
* <!-- end release-specific documentation -->
*
* @param sql an SQL Data Manipulation Language (DML) statement, such as <code>INSERT</code>, <code>UPDATE</code> or
* <code>DELETE</code>; or an SQL statement that returns nothing,
* such as a DDL statement.
* (:JDBC4 clarification)
* @param columnNames an array of the names of the columns that should be
* returned from the inserted row
* @return either the row count for <code>INSERT</code>, <code>UPDATE</code>,
* or <code>DELETE</code> statements, or 0 for SQL statements
* that return nothing
* @exception SQLException if a database access error occurs,
* this method is called on a closed <code>Statement</code>, the SQL
* statement returns a <code>ResultSet</code> object, or the
* second argument supplied to this method is not a <code>String</code> array
* whose elements are valid column names
*
* @throws SQLFeatureNotSupportedException if the JDBC driver does not support this method
* @since JDK 1.4, HSQLDB 1.7
*/
public synchronized int executeUpdate(String sql,
String[] columnNames) throws SQLException {
if (columnNames == null || columnNames.length == 0) {
throw JDBCUtil.invalidArgument("columnIndexes");
}
fetchResult(sql, StatementTypes.RETURN_COUNT,
ResultConstants.RETURN_GENERATED_KEYS_COL_NAMES, null,
columnNames);
return resultIn.getUpdateCount();
}
Executes the given SQL statement, which may return multiple results,
and signals the driver that any
auto-generated keys should be made available
for retrieval. The driver will ignore this signal if the SQL statement
is not an INSERT
statement, or an SQL statement able to return
(JDBC4 clarification)
auto-generated keys (the list of such statements is vendor-specific).
In some (uncommon) situations, a single SQL statement may return
multiple result sets and/or update counts. Normally you can ignore
this unless you are (1) executing a stored procedure that you know may
return multiple results or (2) you are dynamically executing an
unknown SQL string.
The execute
method executes an SQL statement and indicates the
form of the first result. You must then use the methods
getResultSet
or getUpdateCount
to retrieve the result, and getMoreResults
to
move to any subsequent result(s).
HSQLDB-Specific Information:
Starting with 2.0, HSQLDB supports this feature.
Params: - sql – any SQL statement
- autoGeneratedKeys – a constant indicating whether auto-generated
keys should be made available for retrieval using the method
getGeneratedKeys
; one of the following constants:
Statement.RETURN_GENERATED_KEYS
or
Statement.NO_GENERATED_KEYS
Throws: - SQLException – if a database access error occurs,
this method is called on a closed
Statement
or the second
parameter supplied to this method is not
Statement.RETURN_GENERATED_KEYS
or
Statement.NO_GENERATED_KEYS
. - SQLFeatureNotSupportedException – if the JDBC driver does not support
this method with a constant of Statement.RETURN_GENERATED_KEYS
See Also: Returns: true
if the first result is a ResultSet
object; false
if it is an update count or there are
no resultsSince: JDK 1.4, HSQLDB 1.7
/**
* <!-- start generic documentation -->
* Executes the given SQL statement, which may return multiple results,
* and signals the driver that any
* auto-generated keys should be made available
* for retrieval. The driver will ignore this signal if the SQL statement
* is not an <code>INSERT</code> statement, or an SQL statement able to return
* (JDBC4 clarification)
* auto-generated keys (the list of such statements is vendor-specific).
* <P>
* In some (uncommon) situations, a single SQL statement may return
* multiple result sets and/or update counts. Normally you can ignore
* this unless you are (1) executing a stored procedure that you know may
* return multiple results or (2) you are dynamically executing an
* unknown SQL string.
* <P>
* The <code>execute</code> method executes an SQL statement and indicates the
* form of the first result. You must then use the methods
* <code>getResultSet</code> or <code>getUpdateCount</code>
* to retrieve the result, and <code>getMoreResults</code> to
* move to any subsequent result(s).
* <!-- end generic documentation -->
*
* <!-- start release-specific documentation -->
* <div class="ReleaseSpecificDocumentation">
* <h3>HSQLDB-Specific Information:</h3> <p>
*
* Starting with 2.0, HSQLDB supports this feature.
*
* </div>
* <!-- end release-specific documentation -->
*
* @param sql any SQL statement
* @param autoGeneratedKeys a constant indicating whether auto-generated
* keys should be made available for retrieval using the method
* <code>getGeneratedKeys</code>; one of the following constants:
* <code>Statement.RETURN_GENERATED_KEYS</code> or
* <code>Statement.NO_GENERATED_KEYS</code>
* @return <code>true</code> if the first result is a <code>ResultSet</code>
* object; <code>false</code> if it is an update count or there are
* no results
* @exception SQLException if a database access error occurs,
* this method is called on a closed <code>Statement</code> or the second
* parameter supplied to this method is not
* <code>Statement.RETURN_GENERATED_KEYS</code> or
* <code>Statement.NO_GENERATED_KEYS</code>.
* @exception SQLFeatureNotSupportedException if the JDBC driver does not support
* this method with a constant of Statement.RETURN_GENERATED_KEYS
* @see #getResultSet
* @see #getUpdateCount
* @see #getMoreResults
* @see #getGeneratedKeys
* @since JDK 1.4, HSQLDB 1.7
*/
public synchronized boolean execute(
String sql, int autoGeneratedKeys) throws SQLException {
if (autoGeneratedKeys != Statement.RETURN_GENERATED_KEYS
&& autoGeneratedKeys != Statement.NO_GENERATED_KEYS) {
throw JDBCUtil.invalidArgument("autoGeneratedKeys");
}
fetchResult(sql, StatementTypes.RETURN_ANY, autoGeneratedKeys, null,
null);
return resultIn.isData();
}
Executes the given SQL statement, which may return multiple results,
and signals the driver that the
auto-generated keys indicated in the given array should be made available
for retrieval. This array contains the indexes of the columns in the
target table that contain the auto-generated keys that should be made
available. The driver will ignore the array if the SQL statement
(JDBC4 clarification)
is not an INSERT
statement, or an SQL statement able to return
auto-generated keys (the list of such statements is vendor-specific).
Under some (uncommon) situations, a single SQL statement may return
multiple result sets and/or update counts. Normally you can ignore
this unless you are (1) executing a stored procedure that you know may
return multiple results or (2) you are dynamically executing an
unknown SQL string.
The execute
method executes an SQL statement and indicates the
form of the first result. You must then use the methods
getResultSet
or getUpdateCount
to retrieve the result, and getMoreResults
to
move to any subsequent result(s).
HSQLDB-Specific Information:
Starting with 2.0, HSQLDB supports this feature.
Params: - sql – any SQL statement
- columnIndexes – an array of the indexes of the columns in the
inserted row that should be made available for retrieval by a
call to the method
getGeneratedKeys
Throws: - SQLException – if a database access error occurs,
this method is called on a closed
Statement
or the
elements in the int
array passed to this method
are not valid column indexes - SQLFeatureNotSupportedException – if the JDBC driver does not support this method
See Also: Returns: true
if the first result is a ResultSet
object; false
if it is an update count or there
are no resultsSince: JDK 1.4, HSQLDB 1.7
/**
* <!-- start generic documentation -->
* Executes the given SQL statement, which may return multiple results,
* and signals the driver that the
* auto-generated keys indicated in the given array should be made available
* for retrieval. This array contains the indexes of the columns in the
* target table that contain the auto-generated keys that should be made
* available. The driver will ignore the array if the SQL statement
* (JDBC4 clarification)
* is not an <code>INSERT</code> statement, or an SQL statement able to return
* auto-generated keys (the list of such statements is vendor-specific).
* <P>
* Under some (uncommon) situations, a single SQL statement may return
* multiple result sets and/or update counts. Normally you can ignore
* this unless you are (1) executing a stored procedure that you know may
* return multiple results or (2) you are dynamically executing an
* unknown SQL string.
* <P>
* The <code>execute</code> method executes an SQL statement and indicates the
* form of the first result. You must then use the methods
* <code>getResultSet</code> or <code>getUpdateCount</code>
* to retrieve the result, and <code>getMoreResults</code> to
* move to any subsequent result(s).
* <!-- end generic documentation -->
*
* <!-- start release-specific documentation -->
* <div class="ReleaseSpecificDocumentation">
* <h3>HSQLDB-Specific Information:</h3> <p>
*
* Starting with 2.0, HSQLDB supports this feature.
*
* </div>
* <!-- end release-specific documentation -->
*
* @param sql any SQL statement
* @param columnIndexes an array of the indexes of the columns in the
* inserted row that should be made available for retrieval by a
* call to the method <code>getGeneratedKeys</code>
* @return <code>true</code> if the first result is a <code>ResultSet</code>
* object; <code>false</code> if it is an update count or there
* are no results
* @exception SQLException if a database access error occurs,
* this method is called on a closed <code>Statement</code> or the
* elements in the <code>int</code> array passed to this method
* are not valid column indexes
* @throws SQLFeatureNotSupportedException if the JDBC driver does not support this method
* @see #getResultSet
* @see #getUpdateCount
* @see #getMoreResults
* @since JDK 1.4, HSQLDB 1.7
*/
public synchronized boolean execute(
String sql, int[] columnIndexes) throws SQLException {
if (columnIndexes == null || columnIndexes.length == 0) {
throw JDBCUtil.invalidArgument("columnIndexes");
}
fetchResult(sql, StatementTypes.RETURN_ANY,
ResultConstants.RETURN_GENERATED_KEYS_COL_INDEXES,
columnIndexes, null);
return resultIn.isData();
}
Executes the given SQL statement, which may return multiple results,
and signals the driver that the
auto-generated keys indicated in the given array should be made available
for retrieval. This array contains the names of the columns in the
target table that contain the auto-generated keys that should be made
available. The driver will ignore the array if the SQL statement
is not an INSERT
statement, or an SQL statement able to return
auto-generated keys (the list of such statements is vendor-specific).
In some (uncommon) situations, a single SQL statement may return
multiple result sets and/or update counts. Normally you can ignore
this unless you are (1) executing a stored procedure that you know may
return multiple results or (2) you are dynamically executing an
unknown SQL string.
The execute
method executes an SQL statement and indicates the
form of the first result. You must then use the methods
getResultSet
or getUpdateCount
to retrieve the result, and getMoreResults
to
move to any subsequent result(s).
HSQLDB-Specific Information:
Starting with 2.0, HSQLDB supports this feature.
Params: - sql – any SQL statement
- columnNames – an array of the names of the columns in the inserted
row that should be made available for retrieval by a call to the
method
getGeneratedKeys
Throws: - SQLException – if a database access error occurs,
this method is called on a closed
Statement
or the
elements of the String
array passed to this
method are not valid column names - SQLFeatureNotSupportedException – if the JDBC driver does not support this method
See Also: Returns: true
if the next result is a ResultSet
object; false
if it is an update count or there
are no more resultsSince: JDK 1.4, HSQLDB 1.7
/**
* <!-- start generic documentation -->
* Executes the given SQL statement, which may return multiple results,
* and signals the driver that the
* auto-generated keys indicated in the given array should be made available
* for retrieval. This array contains the names of the columns in the
* target table that contain the auto-generated keys that should be made
* available. The driver will ignore the array if the SQL statement
* is not an <code>INSERT</code> statement, or an SQL statement able to return
* auto-generated keys (the list of such statements is vendor-specific).
* <P>
* In some (uncommon) situations, a single SQL statement may return
* multiple result sets and/or update counts. Normally you can ignore
* this unless you are (1) executing a stored procedure that you know may
* return multiple results or (2) you are dynamically executing an
* unknown SQL string.
* <P>
* The <code>execute</code> method executes an SQL statement and indicates the
* form of the first result. You must then use the methods
* <code>getResultSet</code> or <code>getUpdateCount</code>
* to retrieve the result, and <code>getMoreResults</code> to
* move to any subsequent result(s).
* <!-- end generic documentation -->
*
* <!-- start release-specific documentation -->
* <div class="ReleaseSpecificDocumentation">
* <h3>HSQLDB-Specific Information:</h3> <p>
*
* Starting with 2.0, HSQLDB supports this feature.
*
* </div>
* <!-- end release-specific documentation -->
*
* @param sql any SQL statement
* @param columnNames an array of the names of the columns in the inserted
* row that should be made available for retrieval by a call to the
* method <code>getGeneratedKeys</code>
* @return <code>true</code> if the next result is a <code>ResultSet</code>
* object; <code>false</code> if it is an update count or there
* are no more results
* @exception SQLException if a database access error occurs,
* this method is called on a closed <code>Statement</code> or the
* elements of the <code>String</code> array passed to this
* method are not valid column names
* @throws SQLFeatureNotSupportedException if the JDBC driver does not support this method
* @see #getResultSet
* @see #getUpdateCount
* @see #getMoreResults
* @see #getGeneratedKeys
* @since JDK 1.4, HSQLDB 1.7
*/
public synchronized boolean execute(
String sql, String[] columnNames) throws SQLException {
if (columnNames == null || columnNames.length == 0) {
throw JDBCUtil.invalidArgument("columnIndexes");
}
fetchResult(sql, StatementTypes.RETURN_ANY,
ResultConstants.RETURN_GENERATED_KEYS_COL_NAMES, null,
columnNames);
return resultIn.isData();
}
Retrieves the result set holdability for ResultSet
objects
generated by this Statement
object.
Throws: - SQLException – if a database access error occurs or
this method is called on a closed
Statement
Returns: either ResultSet.HOLD_CURSORS_OVER_COMMIT
or
ResultSet.CLOSE_CURSORS_AT_COMMIT
Since: JDK 1.4, HSQLDB 1.7
/**
* <!-- start generic documentation -->
* Retrieves the result set holdability for <code>ResultSet</code> objects
* generated by this <code>Statement</code> object.
* <!-- end generic documentation -->
*
* @return either <code>ResultSet.HOLD_CURSORS_OVER_COMMIT</code> or
* <code>ResultSet.CLOSE_CURSORS_AT_COMMIT</code>
* @exception SQLException if a database access error occurs or
* this method is called on a closed <code>Statement</code>
* @since JDK 1.4, HSQLDB 1.7
*/
public synchronized int getResultSetHoldability() throws SQLException {
return ResultProperties.getJDBCHoldability(rsProperties);
}
//----------------------------- JDBC 4.0 -----------------------------------
Retrieves whether this Statement
object has been closed. A Statement
is closed if the
method close has been called on it, or if it is automatically closed.
Throws: - SQLException – if a database access error occurs
Returns: true if this Statement
object is closed; false if it is still open Since: JDK 1.6, HSQLDB 2.0
/**
* Retrieves whether this <code>Statement</code> object has been closed. A <code>Statement</code> is closed if the
* method close has been called on it, or if it is automatically closed.
* @return true if this <code>Statement</code> object is closed; false if it is still open
* @throws SQLException if a database access error occurs
* @since JDK 1.6, HSQLDB 2.0
*/
public synchronized boolean isClosed() throws SQLException {
return isClosed;
}
// --------------------------- Added: Mustang Build 81 -------------------------
boolean poolable = false;
Requests that a 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.
Params: - poolable – requests that the statement be pooled if true and
that the statement not be pooled if false
Throws: - SQLException – if this method is called on a closed
Statement
Since: JDK 1.6 Build 81, HSQLDB 2.0
/**
* Requests that a <code>Statement</code> 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.
* <p>
* 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.
* <p>
* By default, a <code>Statement</code> is not poolable when created, and
* a <code>PreparedStatement</code> and <code>CallableStatement</code>
* are poolable when created.
* <p>
* @param poolable requests that the statement be pooled if true and
* that the statement not be pooled if false
* <p>
* @throws SQLException if this method is called on a closed
* <code>Statement</code>
* <p>
* @since JDK 1.6 Build 81, HSQLDB 2.0
*/
public synchronized void setPoolable(
boolean poolable) throws SQLException {
checkClosed();
this.poolable = poolable;
}
Returns a value indicating whether the Statement
is poolable or not.
Throws: - SQLException – if this method is called on a closed
Statement
See Also: Returns: true
if the Statement
is poolable; false
otherwise Since: JDK 1.6 Build 81, HSQLDB 2.0
/**
* Returns a value indicating whether the <code>Statement</code>
* is poolable or not.
* <p>
* @return <code>true</code> if the <code>Statement</code>
* is poolable; <code>false</code> otherwise
* @throws SQLException if this method is called on a closed
* <code>Statement</code>
* <p>
* @since JDK 1.6 Build 81, HSQLDB 2.0
* <p>
* @see #setPoolable(boolean) setPoolable(boolean)
*/
public synchronized boolean isPoolable() throws SQLException {
checkClosed();
return this.poolable;
}
// ------------------- java.sql.Wrapper implementation ---------------------
Returns an object that implements the given interface to allow access to
non-standard methods, or standard methods not exposed by the proxy.
If the receiver implements the interface then the result is the receiver
or a proxy for the receiver. If the receiver is a wrapper
and the wrapped object implements the interface then the result is the
wrapped object or a proxy for the wrapped object. Otherwise return the
the result of calling 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.
Params: - iface – A Class defining an interface that the result must implement.
Throws: - SQLException – If no object found that implements the interface
Returns: an object that implements the interface. May be a proxy for the actual implementing object. Since: JDK 1.6, HSQLDB 2.0
/**
* Returns an object that implements the given interface to allow access to
* non-standard methods, or standard methods not exposed by the proxy.
*
* If the receiver implements the interface then the result is the receiver
* or a proxy for the receiver. If the receiver is a wrapper
* and the wrapped object implements the interface then the result is the
* wrapped object or a proxy for the wrapped object. Otherwise return the
* the result of calling <code>unwrap</code> 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 <code>SQLException</code> is thrown.
*
* @param iface A Class defining an interface that the result must implement.
* @return an object that implements the interface. May be a proxy for the actual implementing object.
* @throws java.sql.SQLException If no object found that implements the interface
* @since JDK 1.6, HSQLDB 2.0
*/
@SuppressWarnings("unchecked")
public <T>T unwrap(Class<T> iface) throws java.sql.SQLException {
if (isWrapperFor(iface)) {
return (T) this;
}
throw JDBCUtil.invalidArgument("iface: " + iface);
}
Returns true if this either implements the interface argument or is directly or indirectly a wrapper
for an object that does. Returns false otherwise. If this implements the interface then return true,
else if this is a wrapper then return the result of recursively calling 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.
Params: - iface – a Class defining an interface.
Throws: - SQLException – if an error occurs while determining whether this is a wrapper
for an object with the given interface.
Returns: true if this implements the interface or directly or indirectly wraps an object that does. Since: JDK 1.6, HSQLDB 2.0
/**
* Returns true if this either implements the interface argument or is directly or indirectly a wrapper
* for an object that does. Returns false otherwise. If this implements the interface then return true,
* else if this is a wrapper then return the result of recursively calling <code>isWrapperFor</code> 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 <code>unwrap</code> so that
* callers can use this method to avoid expensive <code>unwrap</code> calls that may fail. If this method
* returns true then calling <code>unwrap</code> with the same argument should succeed.
*
* @param iface a Class defining an interface.
* @return true if this implements the interface or directly or indirectly wraps an object that does.
* @throws java.sql.SQLException if an error occurs while determining whether this is a wrapper
* for an object with the given interface.
* @since JDK 1.6, HSQLDB 2.0
*/
public boolean isWrapperFor(
java.lang.Class<?> iface) throws java.sql.SQLException {
return (iface != null && iface.isAssignableFrom(this.getClass()));
}
//--------------------------JDBC 4.2 -----------------------------
Retrieves the current result as an update count; if the result
is a ResultSet
object or there are no more results, -1
is returned. This method should be called only once per result.
This method should be used when the returned row count may exceed Integer.MAX_VALUE
.
The public implementation will throw UnsupportedOperationException
Throws: - SQLException – if a database access error occurs or
this method is called on a closed
Statement
See Also: Returns: the current result as an update count; -1 if the current result
is a ResultSet
object or there are no more results Since: 1.8
/**
* Retrieves the current result as an update count; if the result
* is a <code>ResultSet</code> object or there are no more results, -1
* is returned. This method should be called only once per result.
* <p>
* This method should be used when the returned row count may exceed
* {@link Integer#MAX_VALUE}.
*<p>
* The public implementation will throw {@code UnsupportedOperationException}
*
* @return the current result as an update count; -1 if the current result
* is a <code>ResultSet</code> object or there are no more results
* @exception SQLException if a database access error occurs or
* this method is called on a closed <code>Statement</code>
* @see #execute
* @since 1.8
*/
//#ifdef JAVA8
public long getLargeUpdateCount() throws SQLException {
return super.getUpdateCount();
}
//#endif JAVA8
Sets the limit for the maximum number of rows that any
ResultSet
object generated by this Statement
object can contain to the given number.
If the limit is exceeded, the excess
rows are silently dropped.
This method should be used when the row limit may exceed Integer.MAX_VALUE
.
The default implementation will throw UnsupportedOperationException
Params: - max – the new max rows limit; zero means there is no limit
Throws: - SQLException – if a database access error occurs,
this method is called on a closed
Statement
or the condition max >= 0
is not satisfied
See Also: Since: 1.8
/**
* Sets the limit for the maximum number of rows that any
* <code>ResultSet</code> object generated by this <code>Statement</code>
* object can contain to the given number.
* If the limit is exceeded, the excess
* rows are silently dropped.
* <p>
* This method should be used when the row limit may exceed
* {@link Integer#MAX_VALUE}.
*<p>
* The default implementation will throw {@code UnsupportedOperationException}
*
* @param max the new max rows limit; zero means there is no limit
* @exception SQLException if a database access error occurs,
* this method is called on a closed <code>Statement</code>
* or the condition {@code max >= 0} is not satisfied
* @see #getMaxRows
* @since 1.8
*/
//#ifdef JAVA8
public void setLargeMaxRows(long max) throws SQLException {
int maxRows = max > Integer.MAX_VALUE ? Integer.MAX_VALUE :
(int) max;
setMaxRows(maxRows);
}
//#endif JAVA8
Retrieves the maximum number of rows that a
ResultSet
object produced by this
Statement
object can contain. If this limit is exceeded,
the excess rows are silently dropped.
This method should be used when the returned row limit may exceed Integer.MAX_VALUE
.
The default implementation will return 0
Throws: - SQLException – if a database access error occurs or
this method is called on a closed
Statement
See Also: Returns: the current maximum number of rows for a ResultSet
object produced by this Statement
object;
zero means there is no limit Since: 1.8
/**
* Retrieves the maximum number of rows that a
* <code>ResultSet</code> object produced by this
* <code>Statement</code> object can contain. If this limit is exceeded,
* the excess rows are silently dropped.
* <p>
* This method should be used when the returned row limit may exceed
* {@link Integer#MAX_VALUE}.
*<p>
* The default implementation will return {@code 0}
*
* @return the current maximum number of rows for a <code>ResultSet</code>
* object produced by this <code>Statement</code> object;
* zero means there is no limit
* @exception SQLException if a database access error occurs or
* this method is called on a closed <code>Statement</code>
* @see #setMaxRows
* @since 1.8
*/
//#ifdef JAVA8
public long getLargeMaxRows() throws SQLException {
return maxRows;
}
//#endif JAVA8
Submits a batch of commands to the database for execution and
if all commands execute successfully, returns an array of update counts.
The long
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 executeLargeBatch
may be one of the following:
- A number greater than or equal to zero -- indicates that the
command was processed successfully and is an update count giving the
number of rows in the database that were affected by the command's
execution
- A value of
SUCCESS_NO_INFO
-- indicates that the command was
processed successfully but that the number of rows affected is
unknown
If one of the commands in a batch update fails to execute properly,
this method throws 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.getLargeUpdateCounts
will contain as many elements as there are commands in the batch, and
at least one of the elements will be the following:
- A value of
EXECUTE_FAILED
-- indicates that the command failed
to execute successfully and occurs only if a driver continues to
process commands after a command fails
This method should be used when the returned row count may exceed Integer.MAX_VALUE
.
The default implementation will throw UnsupportedOperationException
Throws: - 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. - 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 Statement
See Also: Returns: an array of update counts containing one element for each
command in the batch. The elements of the array are ordered according
to the order in which commands were added to the batch. Since: 1.8
/**
* Submits a batch of commands to the database for execution and
* if all commands execute successfully, returns an array of update counts.
* The <code>long</code> 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 {@code executeLargeBatch}
* may be one of the following:
* <OL>
* <LI>A number greater than or equal to zero -- indicates that the
* command was processed successfully and is an update count giving the
* number of rows in the database that were affected by the command's
* execution
* <LI>A value of <code>SUCCESS_NO_INFO</code> -- indicates that the command was
* processed successfully but that the number of rows affected is
* unknown
* <P>
* If one of the commands in a batch update fails to execute properly,
* this method throws a <code>BatchUpdateException</code>, 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
* <code>BatchUpdateException.getLargeUpdateCounts</code>
* will contain as many elements as there are commands in the batch, and
* at least one of the elements will be the following:
*
* <LI>A value of <code>EXECUTE_FAILED</code> -- indicates that the command failed
* to execute successfully and occurs only if a driver continues to
* process commands after a command fails
* </OL>
* <p>
* This method should be used when the returned row count may exceed
* {@link Integer#MAX_VALUE}.
*<p>
* The default implementation will throw {@code UnsupportedOperationException}
*
* @return an array of update counts containing one element for each
* command in the batch. The elements of the array are ordered according
* to the order in which commands were added to the batch.
* @exception SQLException if a database access error occurs,
* this method is called on a closed <code>Statement</code> or the
* driver does not support batch statements. Throws {@link BatchUpdateException}
* (a subclass of <code>SQLException</code>) if one of the commands sent to the
* database fails to execute properly or attempts to return a result set.
* @throws SQLTimeoutException when the driver has determined that the
* timeout value that was specified by the {@code setQueryTimeout}
* method has been exceeded and has at least attempted to cancel
* the currently running {@code Statement}
*
* @see #addBatch
* @see DatabaseMetaData#supportsBatchUpdates
* @since 1.8
*/
//#ifdef JAVA8
public long[] executeLargeBatch() throws SQLException {
int[] updateCounts = executeBatch();
long[] longCounts = new long[updateCounts.length];
for(int i = 0; i < updateCounts.length; i++) {
longCounts[i] = updateCounts[i];
}
return longCounts;
}
//#endif JAVA8
Executes the given SQL statement, which may be an INSERT
,
UPDATE
, or DELETE
statement or an
SQL statement that returns nothing, such as an SQL DDL statement.
This method should be used when the returned row count may exceed Integer.MAX_VALUE
.
Note:This method cannot be called on a
PreparedStatement
or CallableStatement
.
The default implementation will throw UnsupportedOperationException
Params: - sql – 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.
Throws: - SQLException – if a database access error occurs,
this method is called on a closed
Statement
, the given
SQL statement produces a ResultSet
object, the method is called on a
PreparedStatement
or CallableStatement
- 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 Statement
Returns: either (1) the row count for SQL Data Manipulation Language
(DML) statements or (2) 0 for SQL statements that return nothing Since: 1.8
/**
* Executes the given SQL statement, which may be an <code>INSERT</code>,
* <code>UPDATE</code>, or <code>DELETE</code> statement or an
* SQL statement that returns nothing, such as an SQL DDL statement.
* <p>
* This method should be used when the returned row count may exceed
* {@link Integer#MAX_VALUE}.
* <p>
* <strong>Note:</strong>This method cannot be called on a
* <code>PreparedStatement</code> or <code>CallableStatement</code>.
*<p>
* The default implementation will throw {@code UnsupportedOperationException}
*
* @param sql an SQL Data Manipulation Language (DML) statement,
* such as <code>INSERT</code>, <code>UPDATE</code> or
* <code>DELETE</code>; or an SQL statement that returns nothing,
* such as a DDL statement.
*
* @return either (1) the row count for SQL Data Manipulation Language
* (DML) statements or (2) 0 for SQL statements that return nothing
*
* @exception SQLException if a database access error occurs,
* this method is called on a closed <code>Statement</code>, the given
* SQL statement produces a <code>ResultSet</code> object, the method is called on a
* <code>PreparedStatement</code> or <code>CallableStatement</code>
* @throws SQLTimeoutException when the driver has determined that the
* timeout value that was specified by the {@code setQueryTimeout}
* method has been exceeded and has at least attempted to cancel
* the currently running {@code Statement}
* @since 1.8
*/
//#ifdef JAVA8
public long executeLargeUpdate(String sql) throws SQLException {
return executeUpdate(sql);
}
//#endif JAVA8
Executes the given SQL statement and signals the driver with the
given flag about whether the
auto-generated keys produced by this Statement
object
should be made available for retrieval. The driver will ignore the
flag if the SQL statement
is not an INSERT
statement, or an SQL statement able to return
auto-generated keys (the list of such statements is vendor-specific).
This method should be used when the returned row count may exceed Integer.MAX_VALUE
.
Note:This method cannot be called on a
PreparedStatement
or CallableStatement
.
The default implementation will throw SQLFeatureNotSupportedException
Params: - sql – 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. - autoGeneratedKeys – a flag indicating whether auto-generated keys
should be made available for retrieval;
one of the following constants:
Statement.RETURN_GENERATED_KEYS
Statement.NO_GENERATED_KEYS
Throws: - SQLException – if a database access error occurs,
this method is called on a closed
Statement
, the given
SQL statement returns a ResultSet
object,
the given constant is not one of those allowed, the method is called on a
PreparedStatement
or CallableStatement
- SQLFeatureNotSupportedException – if the JDBC driver does not support
this method with a constant of Statement.RETURN_GENERATED_KEYS
- 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 Statement
Returns: either (1) the row count for SQL Data Manipulation Language (DML) statements
or (2) 0 for SQL statements that return nothing Since: 1.8
/**
* Executes the given SQL statement and signals the driver with the
* given flag about whether the
* auto-generated keys produced by this <code>Statement</code> object
* should be made available for retrieval. The driver will ignore the
* flag if the SQL statement
* is not an <code>INSERT</code> statement, or an SQL statement able to return
* auto-generated keys (the list of such statements is vendor-specific).
* <p>
* This method should be used when the returned row count may exceed
* {@link Integer#MAX_VALUE}.
* <p>
* <strong>Note:</strong>This method cannot be called on a
* <code>PreparedStatement</code> or <code>CallableStatement</code>.
*<p>
* The default implementation will throw {@code SQLFeatureNotSupportedException}
*
* @param sql an SQL Data Manipulation Language (DML) statement,
* such as <code>INSERT</code>, <code>UPDATE</code> or
* <code>DELETE</code>; or an SQL statement that returns nothing,
* such as a DDL statement.
*
* @param autoGeneratedKeys a flag indicating whether auto-generated keys
* should be made available for retrieval;
* one of the following constants:
* <code>Statement.RETURN_GENERATED_KEYS</code>
* <code>Statement.NO_GENERATED_KEYS</code>
* @return either (1) the row count for SQL Data Manipulation Language (DML) statements
* or (2) 0 for SQL statements that return nothing
*
* @exception SQLException if a database access error occurs,
* this method is called on a closed <code>Statement</code>, the given
* SQL statement returns a <code>ResultSet</code> object,
* the given constant is not one of those allowed, the method is called on a
* <code>PreparedStatement</code> or <code>CallableStatement</code>
* @exception SQLFeatureNotSupportedException if the JDBC driver does not support
* this method with a constant of Statement.RETURN_GENERATED_KEYS
* @throws SQLTimeoutException when the driver has determined that the
* timeout value that was specified by the {@code setQueryTimeout}
* method has been exceeded and has at least attempted to cancel
* the currently running {@code Statement}
* @since 1.8
*/
//#ifdef JAVA8
public long executeLargeUpdate(String sql, int autoGeneratedKeys)
throws SQLException {
return executeUpdate(sql, autoGeneratedKeys);
}
//#endif JAVA8
Executes the given SQL statement and signals the driver that the
auto-generated keys indicated in the given array should be made available
for retrieval. This array contains the indexes of the columns in the
target table that contain the auto-generated keys that should be made
available. The driver will ignore the array if the SQL statement
is not an INSERT
statement, or an SQL statement able to return
auto-generated keys (the list of such statements is vendor-specific).
This method should be used when the returned row count may exceed Integer.MAX_VALUE
.
Note:This method cannot be called on a
PreparedStatement
or CallableStatement
.
The default implementation will throw SQLFeatureNotSupportedException
Params: - sql – 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. - columnIndexes – an array of column indexes indicating the columns
that should be returned from the inserted row
Throws: - SQLException – if a database access error occurs,
this method is called on a closed
Statement
, the SQL
statement returns a ResultSet
object,the second argument
supplied to this method is not an
int
array whose elements are valid column indexes, the method is called on a
PreparedStatement
or CallableStatement
- SQLFeatureNotSupportedException – if the JDBC driver does not support this method
- 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 Statement
Returns: either (1) the row count for SQL Data Manipulation Language (DML) statements
or (2) 0 for SQL statements that return nothing Since: 1.8
/**
* Executes the given SQL statement and signals the driver that the
* auto-generated keys indicated in the given array should be made available
* for retrieval. This array contains the indexes of the columns in the
* target table that contain the auto-generated keys that should be made
* available. The driver will ignore the array if the SQL statement
* is not an <code>INSERT</code> statement, or an SQL statement able to return
* auto-generated keys (the list of such statements is vendor-specific).
* <p>
* This method should be used when the returned row count may exceed
* {@link Integer#MAX_VALUE}.
* <p>
* <strong>Note:</strong>This method cannot be called on a
* <code>PreparedStatement</code> or <code>CallableStatement</code>.
*<p>
* The default implementation will throw {@code SQLFeatureNotSupportedException}
*
* @param sql an SQL Data Manipulation Language (DML) statement,
* such as <code>INSERT</code>, <code>UPDATE</code> or
* <code>DELETE</code>; or an SQL statement that returns nothing,
* such as a DDL statement.
*
* @param columnIndexes an array of column indexes indicating the columns
* that should be returned from the inserted row
* @return either (1) the row count for SQL Data Manipulation Language (DML) statements
* or (2) 0 for SQL statements that return nothing
*
* @exception SQLException if a database access error occurs,
* this method is called on a closed <code>Statement</code>, the SQL
* statement returns a <code>ResultSet</code> object,the second argument
* supplied to this method is not an
* <code>int</code> array whose elements are valid column indexes, the method is called on a
* <code>PreparedStatement</code> or <code>CallableStatement</code>
* @throws SQLFeatureNotSupportedException if the JDBC driver does not support this method
* @throws SQLTimeoutException when the driver has determined that the
* timeout value that was specified by the {@code setQueryTimeout}
* method has been exceeded and has at least attempted to cancel
* the currently running {@code Statement}
* @since 1.8
*/
//#ifdef JAVA8
public long executeLargeUpdate(String sql, int[] columnIndexes) throws SQLException {
return executeUpdate(sql, columnIndexes);
}
//#endif JAVA8
Executes the given SQL statement and signals the driver that the
auto-generated keys indicated in the given array should be made available
for retrieval. This array contains the names of the columns in the
target table that contain the auto-generated keys that should be made
available. The driver will ignore the array if the SQL statement
is not an INSERT
statement, or an SQL statement able to return
auto-generated keys (the list of such statements is vendor-specific).
This method should be used when the returned row count may exceed Integer.MAX_VALUE
.
Note:This method cannot be called on a
PreparedStatement
or CallableStatement
.
The default implementation will throw SQLFeatureNotSupportedException
Params: - sql – 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. - columnNames – an array of the names of the columns that should be
returned from the inserted row
Throws: - SQLException – if a database access error occurs,
this method is called on a closed
Statement
, the SQL
statement returns a ResultSet
object, the
second argument supplied to this method is not a String
array
whose elements are valid column names, the method is called on a
PreparedStatement
or CallableStatement
- SQLFeatureNotSupportedException – if the JDBC driver does not support this method
- 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 Statement
Returns: either the row count for INSERT
, UPDATE
,
or DELETE
statements, or 0 for SQL statements
that return nothing Since: 1.8
/**
* Executes the given SQL statement and signals the driver that the
* auto-generated keys indicated in the given array should be made available
* for retrieval. This array contains the names of the columns in the
* target table that contain the auto-generated keys that should be made
* available. The driver will ignore the array if the SQL statement
* is not an <code>INSERT</code> statement, or an SQL statement able to return
* auto-generated keys (the list of such statements is vendor-specific).
* <p>
* This method should be used when the returned row count may exceed
* {@link Integer#MAX_VALUE}.
* <p>
* <strong>Note:</strong>This method cannot be called on a
* <code>PreparedStatement</code> or <code>CallableStatement</code>.
*<p>
* The default implementation will throw {@code SQLFeatureNotSupportedException}
*
* @param sql an SQL Data Manipulation Language (DML) statement,
* such as <code>INSERT</code>, <code>UPDATE</code> or
* <code>DELETE</code>; or an SQL statement that returns nothing,
* such as a DDL statement.
* @param columnNames an array of the names of the columns that should be
* returned from the inserted row
* @return either the row count for <code>INSERT</code>, <code>UPDATE</code>,
* or <code>DELETE</code> statements, or 0 for SQL statements
* that return nothing
* @exception SQLException if a database access error occurs,
* this method is called on a closed <code>Statement</code>, the SQL
* statement returns a <code>ResultSet</code> object, the
* second argument supplied to this method is not a <code>String</code> array
* whose elements are valid column names, the method is called on a
* <code>PreparedStatement</code> or <code>CallableStatement</code>
* @throws SQLFeatureNotSupportedException if the JDBC driver does not support this method
* @throws SQLTimeoutException when the driver has determined that the
* timeout value that was specified by the {@code setQueryTimeout}
* method has been exceeded and has at least attempted to cancel
* the currently running {@code Statement}
* @since 1.8
*/
//#ifdef JAVA8
public long executeLargeUpdate(String sql, String[] columnNames)
throws SQLException {
return executeUpdate(sql, columnNames);
}
//#endif JAVA8
// -------------------- Internal Implementation ----------------------------
Constructs a new JDBCStatement with the specified connection and result
type.
Params: - c – the connection on which this statement will execute
/**
* Constructs a new JDBCStatement with the specified connection and result
* type.
*
* @param c the connection on which this statement will execute
*/
JDBCStatement(JDBCConnection c, int props) {
resultOut = Result.newExecuteDirectRequest();
connection = c;
connectionIncarnation = connection.incarnation;
rsProperties = props;
}
Internal result producer for JDBCStatement (sqlExecDirect mode).
Params: - sql – a character sequence representing the SQL to be executed
- statementRetType – int
- generatedKeys – int
- generatedIndexes – int[]
- generatedNames – String[]
Throws: - SQLException – when a database access error occurs
/**
* Internal result producer for JDBCStatement (sqlExecDirect mode).
*
* <p>
*
* @param sql a character sequence representing the SQL to be executed
* @param statementRetType int
* @param generatedKeys int
* @param generatedIndexes int[]
* @param generatedNames String[]
* @throws SQLException when a database access error occurs
*/
private void fetchResult(String sql, int statementRetType,
int generatedKeys, int[] generatedIndexes,
String[] generatedNames) throws SQLException {
checkClosed();
closeResultData();
if (isEscapeProcessing) {
sql = connection.nativeSQL(sql);
}
resultOut.setPrepareOrExecuteProperties(sql, maxRows, fetchSize,
statementRetType, queryTimeout, rsProperties, generatedKeys,
generatedIndexes, generatedNames);
try {
resultIn = connection.sessionProxy.execute(resultOut);
performPostExecute();
} catch (HsqlException e) {
throw JDBCUtil.sqlException(e);
}
if (resultIn.isError()) {
throw JDBCUtil.sqlException(resultIn);
}
if (resultIn.isData()) {
currentResultSet = new JDBCResultSet(connection, this, resultIn,
resultIn.metaData);
} else if (resultIn.getStatementType()
== StatementTypes.RETURN_RESULT) {
getMoreResults();
}
}
}