JDBCStatement.java
/* Copyright (c) 2001-2024, 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;
// 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 JAVA 1.6 (Mustang) Build 84
// Revision 1.16 2006/07/12 12:40:59 boucherb
/**
* The object used for executing a static SQL statement
* and returning the results it produces.
* <P>
* By default, only one {@code ResultSet} object per {@code Statement}
* object can be open at the same time. Therefore, if the reading of one
* {@code ResultSet} object is interleaved
* with the reading of another, each must have been generated by
* different {@code Statement} objects. All execution methods in the
* {@code Statement} interface implicitly close a current
* {@code ResultSet} object of the statement if an open one exists.
*
* <!-- start release-specific documentation -->
* <div class="ReleaseSpecificDocumentation">
* <p class="rshead">HSQLDB-Specific Information:</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.
* <p>
*
* (fredt@users)<br>
* (campbell-burnet@users)
*
* </div>
* <!-- end release-specific documentation -->
*
* @author Campbell Burnet (campbell-burnet@users dot sourceforge.net)
* @author Fred Toussi (fredt@users dot sourceforge.net)
* @version 2.7.3
* @since HSQLDB 1.9.0
* @see JDBCConnection#createStatement
* @see JDBCResultSet
*/
public class JDBCStatement extends JDBCStatementBase
implements Statement, java.sql.Wrapper {
public final static int RETURN_PRIMARY_KEYS =
ResultConstants.RETURN_PRIMARY_KEYS;
/**
* Executes the given SQL statement, which returns a single
* {@code ResultSet} object.
* <p>
* <strong>Note:</strong>This method cannot be called on a
* {@code PreparedStatement} or {@code CallableStatement}.
*
* <!-- start release-specific documentation -->
* <div class="ReleaseSpecificDocumentation">
* <p class="rshead">HSQLDB-Specific Information:</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} statement
* @return a {@code ResultSet} object that contains the data produced
* by the given query; never {@code null}
* @throws SQLException if a database access error occurs,
* this method is called on a closed {@code Statement}, the given
* SQL statement produces anything other than a single
* {@code ResultSet} object, the method is called on a
* {@code PreparedStatement} or {@code CallableStatement}
* @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}
*/
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 {@code INSERT},
* {@code UPDATE}, or {@code DELETE} statement or an
* SQL statement that returns nothing, such as an SQL DDL statement.
* <p>
* <strong>Note:</strong>This method cannot be called on a
* {@code PreparedStatement} or {@code CallableStatement}.
* @param sql an SQL Data Manipulation Language (DML) statement, such as {@code INSERT}, {@code UPDATE} or
* {@code DELETE}; 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
*
* @throws SQLException if a database access error occurs,
* this method is called on a closed {@code Statement}, the given
* SQL statement produces a {@code ResultSet} object, the method is called on a
* {@code PreparedStatement} or {@code CallableStatement}
* @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}
*/
public synchronized int executeUpdate(String sql) throws SQLException {
fetchResult(
sql,
StatementTypes.RETURN_COUNT,
JDBCStatementBase.NO_GENERATED_KEYS,
null,
null);
return resultIn.getUpdateCount();
}
/**
* Releases this {@code 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.
* <P>
* Calling the method {@code close} on a {@code Statement}
* object that is already closed has no effect.
* <P>
* <B>Note:</B>When a {@code Statement} object is
* closed, its current {@code ResultSet} object, if one exists, is
* also closed.
*
* @throws 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 {@code ResultSet}
* object produced by this {@code Statement} object.
* This limit applies only to {@code BINARY}, {@code VARBINARY},
* {@code LONGVARBINARY}, {@code CHAR}, {@code VARCHAR},
* {@code NCHAR}, {@code NVARCHAR}, {@code LONGNVARCHAR}
* and {@code LONGVARCHAR} columns. If the limit is exceeded, the
* excess data is silently discarded.
*
* <!-- start release-specific documentation -->
* <div class="ReleaseSpecificDocumentation">
* <p class="rshead">HSQLDB-Specific Information:</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
* @throws SQLException if a database access error occurs or
* this method is called on a closed {@code Statement}
* @see #setMaxFieldSize
*/
public synchronized int getMaxFieldSize() throws SQLException {
checkClosed();
return 0;
}
/**
* Sets the limit for the maximum number of bytes in a {@code ResultSet}
* Sets the limit for the maximum number of bytes that can be returned for
* character and binary column values in a {@code ResultSet}
* object produced by this {@code Statement} object.
*
* This limit applies
* only to {@code BINARY}, {@code VARBINARY},
* {@code LONGVARBINARY}, {@code CHAR}, {@code VARCHAR},
* {@code NCHAR}, {@code NVARCHAR}, {@code LONGNVARCHAR} and
* {@code LONGVARCHAR} fields. If the limit is exceeded, the excess data
* is silently discarded. For maximum portability, use values
* greater than 256.
*
* <!-- start release-specific documentation -->
* <div class="ReleaseSpecificDocumentation">
* <p class="rshead">HSQLDB-Specific Information:</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
* @throws SQLException if a database access error occurs,
* this method is called on a closed {@code Statement}
* 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
* {@code ResultSet} object produced by this
* {@code Statement} object can contain. If this limit is exceeded,
* the excess rows are silently dropped.
*
* @return the current maximum number of rows for a {@code ResultSet}
* object produced by this {@code Statement} object;
* zero means there is no limit
* @throws SQLException if a database access error occurs or
* this method is called on a closed {@code Statement}
* @see #setMaxRows
*/
public synchronized int getMaxRows() throws SQLException {
checkClosed();
return maxRows;
}
/**
* Sets the limit for the maximum number of rows that any
* {@code ResultSet} object generated by this {@code Statement}
* object can contain to the given number.
* If the limit is exceeded, the excess
* rows are silently dropped.
*
* @param 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 {@code Statement}
* 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.
*<p>
* The {@code Connection} and {@code DataSource} property
* {@code escapeProcessing} may be used to change the default escape processing
* behavior. A value of true (the default) enables escape Processing for
* all {@code Statement} objects. A value of false disables escape processing
* for all {@code Statement} objects. The {@code setEscapeProcessing}
* method may be used to specify the escape processing behavior for an
* individual {@code Statement} object.
* <p>
* Note: Since prepared statements have usually been parsed prior
* to making this call, disabling escape processing for
* {@code PreparedStatements} objects will have no effect.
*
* @param enable {@code true} to enable escape processing;
* {@code false} to disable it
* @throws SQLException if a database access error occurs or
* this method is called on a closed {@code Statement}
*/
public void setEscapeProcessing(boolean enable) throws SQLException {
checkClosed();
isEscapeProcessing = enable;
}
/**
* Retrieves the number of seconds the driver will
* wait for a {@code Statement} object to execute.
* If the limit is exceeded, a
* {@code SQLException} is thrown.
*
* <!-- start release-specific documentation -->
* <div class="ReleaseSpecificDocumentation">
* <p class="rshead">HSQLDB-Specific Information:</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
* @throws SQLException if a database access error occurs or
* this method is called on a closed {@code Statement}
* @see #setQueryTimeout
*/
public synchronized int getQueryTimeout() throws SQLException {
checkClosed();
return queryTimeout;
}
/**
* Sets the number of seconds the driver will wait for a
* {@code Statement} object to execute to the given number of seconds.
* By default there is no limit on the amount of time allowed for a running
* statement to complete. If the limit is exceeded, an
* {@code SQLTimeoutException} is thrown.
* A JDBC driver must apply this limit to the {@code execute},
* {@code executeQuery} and {@code executeUpdate} methods.
* <p>
* <strong>Note:</strong> JDBC driver implementations may also apply this
* limit to {@code ResultSet} methods
* (consult your driver vendor documentation for details).
* <p>
* <strong>Note:</strong> In the case of {@code Statement} batching, it is
* implementation defined as to whether the time-out is applied to
* individual SQL commands added via the {@code addBatch} method or to
* the entire batch of SQL commands invoked by the {@code executeBatch}
* method (consult your driver vendor documentation for details).
*
* <!-- start release-specific documentation -->
* <div class="ReleaseSpecificDocumentation">
* <p class="rshead">HSQLDB-Specific Information:</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
* @throws SQLException if a database access error occurs,
* this method is called on a closed {@code Statement}
* 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 {@code 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.
*
* <!-- start release-specific documentation -->
* <div class="ReleaseSpecificDocumentation">
* <p class="rshead">HSQLDB-Specific Information:</p>
*
* HSQLDB version 2.3.4 and later supports aborting an SQL query
* or data update statement.
* </div>
* <!-- end release-specific documentation -->
*
* @throws SQLException if a database access error occurs or
* this method is called on a closed {@code Statement}
* @throws 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 {@code Statement} object.
* Subsequent {@code Statement} object warnings will be chained to this
* {@code SQLWarning} 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} object; doing so will cause an {@code SQLException}
* to be thrown.
*
* <P><B>Note:</B> If you are processing a {@code ResultSet} object, any
* warnings associated with reads on that {@code ResultSet} object
* will be chained on it rather than on the {@code Statement}
* object that produced it.
*
* <!-- start release-specific documentation -->
* <div class="ReleaseSpecificDocumentation">
* <p class="rshead">HSQLDB-Specific Information:</p>
*
* In 2.0, HSQLDB may produces Statement warnings;
* this method always returns null.
* </div>
* <!-- end release-specific documentation -->
*
* @return the first {@code SQLWarning} object or {@code null}
* if there are no warnings
* @throws SQLException if a database access error occurs or
* this method is called on a closed {@code Statement}
*/
public synchronized SQLWarning getWarnings() throws SQLException {
checkClosed();
return rootWarning;
}
/**
* Clears all the warnings reported on this {@code Statement}
* object. After a call to this method,
* the method {@code getWarnings} will return
* {@code null} until a new warning is reported for this
* {@code Statement} object.
*
* <!-- start release-specific documentation -->
* <div class="ReleaseSpecificDocumentation">
* <p class="rshead">HSQLDB-Specific Information:</p>
*
* In HSQLDB 2.0, {@code SQLWarning} objects may
* be produced for Statement Objects; calls to this method clear the warnings.
* </div>
* <!-- end release-specific documentation -->
*
* @throws SQLException if a database access error occurs or
* this method is called on a closed {@code Statement}
*/
public synchronized void clearWarnings() throws SQLException {
checkClosed();
rootWarning = null;
}
/* @todo 1.9.0 - implement */
/**
* Sets the SQL cursor name to the given {@code String}, which
* will be used by subsequent {@code Statement} object
* {@code execute} methods. This name can then be
* used in SQL positioned update or delete statements to identify the
* current row in the {@code ResultSet} object generated by this
* statement. If the database does not support positioned update/delete,
* this method is a noop. To ensure that a cursor has the proper isolation
* level to support updates, the cursor's {@code SELECT} statement
* should have the form {@code SELECT FOR UPDATE}. If
* {@code FOR UPDATE} 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} object than
* the one that generated the {@code ResultSet} object being used for
* positioning. Also, cursor names must be unique within a connection.
*
* <!-- start release-specific documentation -->
* <div class="ReleaseSpecificDocumentation">
* <p class="rshead">HSQLDB-Specific Information:</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
* @throws SQLException if a database access error occurs or
* this method is called on a closed {@code Statement}
* @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.
* <P>
* The {@code execute} method executes an SQL statement and indicates the
* form of the first result. You must then use the methods
* {@code getResultSet} or {@code getUpdateCount}
* to retrieve the result, and {@code getMoreResults} to
* move to any subsequent result(s).
* <p>
*<strong>Note:</strong>This method cannot be called on a
* {@code PreparedStatement} or {@code CallableStatement}.
* @param sql any SQL statement
* @return {@code true} if the first result is a {@code ResultSet}
* object; {@code false} if it is an update count or there are
* no results
* @throws SQLException if a database access error occurs,
* this method is called on a closed {@code Statement},
* the method is called on a
* {@code PreparedStatement} or {@code CallableStatement}
* @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 #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 {@code ResultSet} object.
* This method should be called only once per result.
*
* <!-- start release-specific documentation -->
* <div class="ReleaseSpecificDocumentation">
* <p class="rshead">HSQLDB-Specific Information:</p>
*
* </div>
* <!-- end release-specific documentation -->
*
* @return the current result as a {@code ResultSet} object or
* {@code null} if the result is an update count or there are no more results
* @throws SQLException if a database access error occurs or
* this method is called on a closed {@code Statement}
* @see #execute
*/
public synchronized ResultSet getResultSet() throws SQLException {
return super.getResultSet();
}
/**
* Retrieves the current result as an update count;
* if the result is a {@code ResultSet} object or there are no more results, -1
* is returned. This method should be called only once per result.
*
* @return the current result as an update count; -1 if the current result is a
* {@code ResultSet} object or there are no more results
* @throws SQLException if a database access error occurs or
* this method is called on a closed {@code Statement}
* @see #execute
*/
public synchronized int getUpdateCount() throws SQLException {
return super.getUpdateCount();
}
/**
* Moves to this {@code Statement} object's next result, returns
* {@code true} if it is a {@code ResultSet} object, and
* implicitly closes any current {@code ResultSet}
* object(s) obtained with the method {@code getResultSet}.
*
* <P>There are no more results when the following is true:
* <PRE>{@code
* // stmt is a Statement object
* ((stmt.getMoreResults() == false) && (stmt.getUpdateCount() == -1))
* }</PRE>
*
* @return {@code true} if the next result is a {@code ResultSet}
* object; {@code false} if it is an update count or there are
* no more results
* @throws SQLException if a database access error occurs or
* this method is called on a closed {@code Statement}
* @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 {@code ResultSet}
* objects created using this {@code Statement} object. The
* default value is {@code ResultSet.FETCH_FORWARD}.
* <P>
* Note that this method sets the default fetch direction for
* result sets generated by this {@code Statement} object.
* Each result set has its own methods for getting and setting
* its own fetch direction.
*
* <!-- start release-specific documentation -->
* <div class="ReleaseSpecificDocumentation">
* <p class="rshead">HSQLDB-Specific Information:</p>
*
* HSQLDB accepts all valid parameters.
* </div>
* <!-- end release-specific documentation -->
*
* @param direction the initial direction for processing rows
* @throws SQLException if a database access error occurs,
* this method is called on a closed {@code Statement}
* or the given direction
* is not one of {@code ResultSet.FETCH_FORWARD},
* {@code ResultSet.FETCH_REVERSE}, or {@code ResultSet.FETCH_UNKNOWN}
* @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 {@code Statement} object.
* If this {@code Statement} object has not set
* a fetch direction by calling the method {@code setFetchDirection},
* the return value is implementation-specific.
*
* <!-- start release-specific documentation -->
* <div class="ReleaseSpecificDocumentation">
* <p class="rshead">HSQLDB-Specific Information:</p>
*
* HSQLDB returns the fetch direction.
* </div>
* <!-- end release-specific documentation -->
*
* @return the default fetch direction for result sets generated
* from this {@code Statement} object
* @throws SQLException if a database access error occurs or
* this method is called on a closed {@code Statement}
* @since JDK 1.2
* @see #setFetchDirection
*/
public int getFetchDirection() throws SQLException {
checkClosed();
return this.fetchDirection;
}
/**
* 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} objects generated by this {@code Statement}.
* If the value specified is zero, then the hint is ignored.
* The default value is zero.
*
* <!-- start release-specific documentation -->
* <div class="ReleaseSpecificDocumentation">
* <p class="rshead">HSQLDB-Specific Information:</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
* @throws SQLException if a database access error occurs,
* this method is called on a closed {@code Statement} or the
* 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 {@code ResultSet} objects
* generated from this {@code Statement} object.
* If this {@code Statement} object has not set
* a fetch size by calling the method {@code setFetchSize},
* the return value is implementation-specific.
*
* <!-- 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} object
* @throws SQLException if a database access error occurs or
* this method is called on a closed {@code Statement}
* @since JDK 1.2
* @see #setFetchSize
*/
public synchronized int getFetchSize() throws SQLException {
checkClosed();
return fetchSize;
}
/**
* Retrieves the result set concurrency for {@code ResultSet} objects
* generated by this {@code Statement} object.
*
* <!-- start release-specific documentation -->
* <div class="ReleaseSpecificDocumentation">
* <p class="rshead">HSQLDB-Specific Information:</p>
*
* HSQLDB supports {@code CONCUR_READ_ONLY} and
* {@code CONCUR_UPDATABLE} concurrency.
* </div>
* <!-- end release-specific documentation -->
*
* @return either {@code ResultSet.CONCUR_READ_ONLY} or
* {@code ResultSet.CONCUR_UPDATABLE}
* @throws SQLException if a database access error occurs or
* this method is called on a closed {@code Statement}
* @since JDK 1.2
*/
public synchronized int getResultSetConcurrency() throws SQLException {
checkClosed();
return ResultProperties.getJDBCConcurrency(rsProperties);
}
/**
* Retrieves the result set type for {@code ResultSet} objects
* generated by this {@code Statement} object.
*
* <!-- start release-specific documentation -->
* <div class="ReleaseSpecificDocumentation">
* <p class="rshead">HSQLDB-Specific Information:</p>
*
* HSQLDB 1.7.0 and later versions support {@code TYPE_FORWARD_ONLY}
* and {@code TYPE_SCROLL_INSENSITIVE}.
* </div>
* <!-- end release-specific documentation -->
*
* @return one of {@code ResultSet.TYPE_FORWARD_ONLY},
* {@code ResultSet.TYPE_SCROLL_INSENSITIVE}, or
* {@code ResultSet.TYPE_SCROLL_SENSITIVE}
* @throws SQLException if a database access error occurs or
* this method is called on a closed {@code Statement}
* @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
* {@code Statement} object. The commands in this list can be
* executed as a batch by calling the method {@code executeBatch}.
* <P>
* <strong>Note:</strong>This method cannot be called on a
* {@code PreparedStatement} or {@code CallableStatement}.
*
*
* <!-- start release-specific documentation -->
* <div class="ReleaseSpecificDocumentation">
* <p class="rshead">HSQLDB-Specific Information:</p>
*
* Starting with 1.7.2, this feature is supported.
* </div>
* <!-- end release-specific documentation -->
*
* @param sql typically this is a SQL {@code INSERT} or
* {@code UPDATE} statement
* @throws SQLException if a database access error occurs,
* this method is called on a closed {@code Statement}, the
* driver does not support batch updates, the method is called on a
* {@code PreparedStatement} or {@code CallableStatement}
* @see #executeBatch
* @see java.sql.DatabaseMetaData#supportsBatchUpdates
* @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 {@code Statement} object's current list of
* SQL commands.
* <P>
* <B>NOTE:</B> Support of an ability to batch updates is optional.
*
* <!-- start release-specific documentation -->
* <div class="ReleaseSpecificDocumentation">
* <p class="rshead">HSQLDB-Specific Information:</p>
*
* Starting with HSQLDB 1.7.2, this feature is supported.
* </div>
* <!-- end release-specific documentation -->
*
* @throws SQLException if a database access error occurs,
* this method is called on a closed {@code Statement} or the
* driver does not support batch updates
* @see #addBatch
* @see java.sql.DatabaseMetaData#supportsBatchUpdates
* @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 {@code 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 {@code executeBatch}
* 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} -- 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}, 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}
* 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} -- indicates that the command failed
* to execute successfully and occurs only if a driver continues to
* process commands after a command fails
* </OL>
* <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} object has been thrown.
*
* <!-- start release-specific documentation -->
* <div class="ReleaseSpecificDocumentation">
* <p class="rshead">HSQLDB-Specific Information:</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.
*
* </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.
* @throws SQLException if a database access error occurs,
* this method is called on a closed {@code Statement} or the
* driver does not support batch statements. Throws {@link BatchUpdateException}
* (a subclass of {@code SQLException}) 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 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 {@code Connection} object
* that produced this {@code Statement} object.
*
* @return the connection that produced this statement
* @throws SQLException if a database access error occurs or
* this method is called on a closed {@code Statement}
* @since JDK 1.2
*/
public synchronized Connection getConnection() throws SQLException {
checkClosed();
return connection;
}
//--------------------------JDBC 3.0-----------------------------
/**
* Moves to this {@code Statement} object's next result, deals with
* any current {@code ResultSet} object(s) according to the instructions
* specified by the given flag, and returns
* {@code true} if the next result is a {@code ResultSet} object.
*
* <P>There are no more results when the following is true:
* <PRE>{@code
* // stmt is a Statement object
* ((stmt.getMoreResults(current) == false) && (stmt.getUpdateCount() == -1))
* }</PRE>
*
* <!-- start release-specific documentation -->
* <div class="ReleaseSpecificDocumentation">
* <p class="rshead">HSQLDB-Specific Information:</p>
*
* HSQLDB moves to the next ResultSet and returns the correct result.
* </div>
* <!-- end release-specific documentation -->
*
* @param current one of the following {@code Statement}
* constants indicating what should happen to current
* {@code ResultSet} objects obtained using the method
* {@code getResultSet}:
* {@code Statement.CLOSE_CURRENT_RESULT},
* {@code Statement.KEEP_CURRENT_RESULT}, or
* {@code Statement.CLOSE_ALL_RESULTS}
* @return {@code true} if the next result is a {@code ResultSet}
* object; {@code false} if it is an update count or there are no
* more results
* @throws SQLException if a database access error occurs,
* this method is called on a closed {@code Statement} or the argument
* supplied is not one of the following:
* {@code Statement.CLOSE_CURRENT_RESULT},
* {@code Statement.KEEP_CURRENT_RESULT} or
* {@code Statement.CLOSE_ALL_RESULTS}
* @throws SQLFeatureNotSupportedException if
* {@code DatabaseMetaData.supportsMultipleOpenResults} returns
* {@code false} and either
* {@code Statement.KEEP_CURRENT_RESULT} or
* {@code Statement.CLOSE_ALL_RESULTS} are supplied as
* the argument.
* @since JDK 1.4, HSQLDB 1.7.0
* @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
* {@code Statement} object. If this {@code Statement} object did
* not generate any keys, an empty {@code ResultSet}
* object is returned.
*
* <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.
*
* <!-- start release-specific documentation -->
* <div class="ReleaseSpecificDocumentation">
* <p class="rshead">HSQLDB-Specific Information:</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} object containing the auto-generated key(s)
* generated by the execution of this {@code Statement} object
* @throws SQLException if a database access error occurs or
* this method is called on a closed {@code Statement}
* @throws SQLFeatureNotSupportedException if the JDBC driver does not support this method
* @since JDK 1.4, HSQLDB 1.7.0
*/
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 {@code Statement} object
* should be made available for retrieval. The driver will ignore the
* flag if the SQL statement
* is not an {@code INSERT} statement, or an SQL statement able to return
* auto-generated keys (the list of such statements is vendor-specific).
*
* <!-- start release-specific documentation -->
* <div class="ReleaseSpecificDocumentation">
* <p class="rshead">HSQLDB-Specific Information:</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().
*
* HSQLDB also supports returning primary key values from the rows by using the
* {@code org.hsqldb.jdbc.JDBCStatement.RETURN_PRIMARY_KEYS} constant.
*
* </div>
* <!-- end release-specific documentation -->
* @param sql an SQL Data Manipulation Language (DML) statement, such as {@code INSERT}, {@code UPDATE} or
* {@code DELETE}; 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 Statement.NO_GENERATED_KEYS}
* @return either (1) the row count for SQL Data Manipulation Language (DML) statements
* or (2) 0 for SQL statements that return nothing
*
* @throws SQLException if a database access error occurs,
* this method is called on a closed {@code Statement}, the given
* SQL statement returns a {@code ResultSet} object,
* the given constant is not one of those allowed, the method is called on a
* {@code PreparedStatement} or {@code CallableStatement}
* @throws 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 JDK 1.4, HSQLDB 1.7.0
*/
public synchronized int executeUpdate(
String sql,
int autoGeneratedKeys)
throws SQLException {
if (autoGeneratedKeys != Statement.RETURN_GENERATED_KEYS
&& autoGeneratedKeys != Statement.NO_GENERATED_KEYS
&& autoGeneratedKeys != JDBCStatement.RETURN_PRIMARY_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. 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} statement, or an SQL statement able to return
* auto-generated keys (the list of such statements is vendor-specific).
*<p>
* <strong>Note:</strong>This method cannot be called on a
* {@code PreparedStatement} or {@code CallableStatement}.
*
* <!-- start release-specific documentation -->
* <div class="ReleaseSpecificDocumentation">
* <p class="rshead">HSQLDB-Specific Information:</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 UPDATE} or
* {@code DELETE}; 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
*
* @throws SQLException if a database access error occurs,
* this method is called on a closed {@code Statement}, the SQL
* statement returns a {@code ResultSet} object, the second argument
* supplied to this method is not an
* {@code int} array whose elements are valid column indexes, the method is called on a
* {@code PreparedStatement} or {@code CallableStatement}
* @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 JDK 1.4, HSQLDB 1.7.0
*/
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. 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} statement, or an SQL statement able to return
* auto-generated keys (the list of such statements is vendor-specific).
* <p>
* <strong>Note:</strong>This method cannot be called on a
* {@code PreparedStatement} or {@code CallableStatement}.
*
* <!-- start release-specific documentation -->
* <div class="ReleaseSpecificDocumentation">
* <p class="rshead">HSQLDB-Specific Information:</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 UPDATE} or
* {@code DELETE}; 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 UPDATE},
* or {@code DELETE} statements, or 0 for SQL statements
* that return nothing
* @throws SQLException if a database access error occurs,
* this method is called on a closed {@code Statement}, the SQL
* statement returns a {@code ResultSet} object, the
* second argument supplied to this method is not a {@code String} array
* whose elements are valid column names, the method is called on a
* {@code PreparedStatement} or {@code CallableStatement}
* @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 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 {@code INSERT} 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} method executes an SQL statement and indicates the
* form of the first result. You must then use the methods
* {@code getResultSet} or {@code getUpdateCount}
* to retrieve the result, and {@code getMoreResults} to
* move to any subsequent result(s).
*<p>
*<strong>Note:</strong>This method cannot be called on a
* {@code PreparedStatement} or {@code CallableStatement}.
*
* <!-- start release-specific documentation -->
* <div class="ReleaseSpecificDocumentation">
* <p class="rshead">HSQLDB-Specific Information:</p>
*
* Starting with 2.0, HSQLDB supports this feature.
*
* HSQLDB also supports returning primary key values from the rows by using the
* {@code org.hsqldb.result.ResultConstants.RETURN_PRIMARY_KEYS} constant.
*
* </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}; one of the following constants:
* {@code Statement.RETURN_GENERATED_KEYS} or
* {@code Statement.NO_GENERATED_KEYS}
* @return {@code true} if the first result is a {@code ResultSet}
* object; {@code false} if it is an update count or there are
* no results
* @throws SQLException if a database access error occurs,
* this method is called on a closed {@code Statement}, the second
* parameter supplied to this method is not
* {@code Statement.RETURN_GENERATED_KEYS} or
* {@code Statement.NO_GENERATED_KEYS},
* the method is called on a
* {@code PreparedStatement} or {@code CallableStatement}
* @throws 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}
* @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
&& autoGeneratedKeys != JDBCStatement.RETURN_PRIMARY_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
* is not an {@code INSERT} 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} method executes an SQL statement and indicates the
* form of the first result. You must then use the methods
* {@code getResultSet} or {@code getUpdateCount}
* to retrieve the result, and {@code getMoreResults} to
* move to any subsequent result(s).
*<p>
* <strong>Note:</strong>This method cannot be called on a
* {@code PreparedStatement} or {@code CallableStatement}.
*
* <!-- start release-specific documentation -->
* <div class="ReleaseSpecificDocumentation">
* <p class="rshead">HSQLDB-Specific Information:</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}
* @return {@code true} if the first result is a {@code ResultSet}
* object; {@code false} if it is an update count or there
* are no results
* @throws SQLException if a database access error occurs,
* this method is called on a closed {@code Statement}, the
* elements in the {@code int} array passed to this method
* are not valid column indexes, the method is called on a
* {@code PreparedStatement} or {@code CallableStatement}
* @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}
* @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 {@code INSERT} 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} method executes an SQL statement and indicates the
* form of the first result. You must then use the methods
* {@code getResultSet} or {@code getUpdateCount}
* to retrieve the result, and {@code getMoreResults} to
* move to any subsequent result(s).
* <p>
* <strong>Note:</strong>This method cannot be called on a
* {@code PreparedStatement} or {@code CallableStatement}.
*
* <!-- start release-specific documentation -->
* <div class="ReleaseSpecificDocumentation">
* <p class="rshead">HSQLDB-Specific Information:</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}
* @return {@code true} if the next result is a {@code ResultSet}
* object; {@code false} if it is an update count or there
* are no more results
* @throws SQLException if a database access error occurs,
* this method is called on a closed {@code Statement}, the
* elements of the {@code String} array passed to this
* method are not valid column names, the method is called on a
* {@code PreparedStatement} or {@code CallableStatement}
* @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}
* @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 {@code ResultSet} objects
* generated by this {@code Statement} object.
*
* @return either {@code ResultSet.HOLD_CURSORS_OVER_COMMIT} or
* {@code ResultSet.CLOSE_CURSORS_AT_COMMIT}
* @throws SQLException if a database access error occurs or
* this method is called on a closed {@code Statement}
* @since JDK 1.4, HSQLDB 1.7
*/
public synchronized int getResultSetHoldability() throws SQLException {
return ResultProperties.getJDBCHoldability(rsProperties);
}
//----------------------------- JDBC 4.0 -----------------------------------
/**
* Retrieves whether this {@code Statement} object has been closed. A {@code Statement} is closed if the
* method close has been called on it, or if it is automatically closed.
* @return true if this {@code Statement} object is closed; false if it is still open
* @since JDK 1.6, HSQLDB 2.0
*/
public synchronized boolean isClosed() {
return isClosed;
}
// --------------------------- Added: JAVA 1.6 (Mustang) Build 81 -------------------------
boolean poolable = false;
/**
* Requests that a {@code 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.
* <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} is not poolable when created, and
* a {@code PreparedStatement} and {@code CallableStatement}
* are poolable when created.
* @param 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
* {@code Statement}
* @since JDK 1.6, HSQLDB 2.0
*/
public synchronized void setPoolable(boolean poolable) throws SQLException {
checkClosed();
this.poolable = poolable;
}
/**
* Returns a value indicating whether this {@code Statement} will be
* closed when all its dependent result sets are closed.
* @return {@code true} if the {@code Statement} will be closed when all
* of its dependent result sets are closed; {@code false} otherwise
* @throws SQLException if this method is called on a closed
* {@code Statement}
* @since JDK 1.7, HSQLDB 2.0
* @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
* result of calling {@code 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 {@code SQLException} 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 {@code 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 {@code unwrap} so that
* callers can use this method to avoid expensive {@code unwrap} calls that may fail. If this method
* returns true then calling {@code unwrap} 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 {@code ResultSet} 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 default implementation will throw {@code UnsupportedOperationException}
*
* @return the current result as an update count; -1 if the current result
* is a {@code ResultSet} object or there are no more results
* @throws SQLException if a database access error occurs or
* this method is called on a closed {@code Statement}
* @see #execute
* @since 1.8
*/
public long getLargeUpdateCount() throws SQLException {
return super.getUpdateCount();
}
/**
* Sets the limit for the maximum number of rows that any
* {@code ResultSet} object generated by this {@code Statement}
* 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
* @throws SQLException if a database access error occurs,
* this method is called on a closed {@code Statement}
* or the condition {@code max >= 0} is not satisfied
* @see #getMaxRows
* @since 1.8
*/
public void setLargeMaxRows(long max) throws SQLException {
int maxRows = max > Integer.MAX_VALUE
? Integer.MAX_VALUE
: (int) max;
setMaxRows(maxRows);
}
/**
* Retrieves the maximum number of rows that a
* {@code ResultSet} object produced by this
* {@code Statement} 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}
* object produced by this {@code Statement} object;
* zero means there is no limit
* @throws SQLException if a database access error occurs or
* this method is called on a closed {@code Statement}
* @see #setMaxRows
* @since 1.8
*/
public long getLargeMaxRows() throws SQLException {
return maxRows;
}
/**
* 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} 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} -- 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}, 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}
* 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} -- 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.
* @throws SQLException if a database access error occurs,
* this method is called on a closed {@code Statement} or the
* driver does not support batch statements. Throws {@link BatchUpdateException}
* (a subclass of {@code SQLException}) 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
*/
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;
}
/**
* Executes the given SQL statement, which may be an {@code INSERT},
* {@code UPDATE}, or {@code DELETE} 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} or {@code CallableStatement}.
*<p>
* The default implementation will throw {@code UnsupportedOperationException}
*
* @param sql an SQL Data Manipulation Language (DML) statement,
* such as {@code INSERT}, {@code UPDATE} or
* {@code DELETE}; 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
*
* @throws SQLException if a database access error occurs,
* this method is called on a closed {@code Statement}, the given
* SQL statement produces a {@code ResultSet} object, the method is called on a
* {@code PreparedStatement} or {@code CallableStatement}
* @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
*/
public long executeLargeUpdate(String sql) throws SQLException {
return executeUpdate(sql);
}
/**
* Executes the given SQL statement and signals the driver with the
* given flag about whether the
* auto-generated keys produced by this {@code Statement} object
* should be made available for retrieval. The driver will ignore the
* flag if the SQL statement
* is not an {@code INSERT} 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} or {@code CallableStatement}.
*<p>
* The default implementation will throw {@code SQLFeatureNotSupportedException}
*
* @param sql an SQL Data Manipulation Language (DML) statement,
* such as {@code INSERT}, {@code UPDATE} or
* {@code DELETE}; 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 Statement.NO_GENERATED_KEYS}
* @return either (1) the row count for SQL Data Manipulation Language (DML) statements
* or (2) 0 for SQL statements that return nothing
*
* @throws SQLException if a database access error occurs,
* this method is called on a closed {@code Statement}, the given
* SQL statement returns a {@code ResultSet} object,
* the given constant is not one of those allowed, the method is called on a
* {@code PreparedStatement} or {@code CallableStatement}
* @throws 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
*/
public long executeLargeUpdate(
String sql,
int autoGeneratedKeys)
throws SQLException {
return executeUpdate(sql, autoGeneratedKeys);
}
/**
* 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} 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} or {@code CallableStatement}.
*<p>
* The default implementation will throw {@code SQLFeatureNotSupportedException}
*
* @param sql an SQL Data Manipulation Language (DML) statement,
* such as {@code INSERT}, {@code UPDATE} or
* {@code DELETE}; 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
*
* @throws SQLException if a database access error occurs,
* this method is called on a closed {@code Statement}, the SQL
* statement returns a {@code ResultSet} object,the second argument
* supplied to this method is not an
* {@code int} array whose elements are valid column indexes, the method is called on a
* {@code PreparedStatement} or {@code CallableStatement}
* @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
*/
public long executeLargeUpdate(
String sql,
int[] columnIndexes)
throws SQLException {
return executeUpdate(sql, columnIndexes);
}
/**
* 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} 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} or {@code CallableStatement}.
*<p>
* The default implementation will throw {@code SQLFeatureNotSupportedException}
*
* @param sql an SQL Data Manipulation Language (DML) statement,
* such as {@code INSERT}, {@code UPDATE} or
* {@code DELETE}; 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 UPDATE},
* or {@code DELETE} statements, or 0 for SQL statements
* that return nothing
* @throws SQLException if a database access error occurs,
* this method is called on a closed {@code Statement}, the SQL
* statement returns a {@code ResultSet} object, the
* second argument supplied to this method is not a {@code String} array
* whose elements are valid column names, the method is called on a
* {@code PreparedStatement} or {@code CallableStatement}
* @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
*/
public long executeLargeUpdate(
String sql,
String[] columnNames)
throws SQLException {
return executeUpdate(sql, columnNames);
}
//--------------------------JDBC 4.3 -----------------------------
/*
* @todo
* The default methods for literals added to java.sql.Statement are fine.
*
* The enquoteIdentifier and isSimpleIdentifier methods may be too restrictive
* with non-ASCII characters.
*/
// -------------------- Internal Implementation ----------------------------
/**
* 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).
*
* @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();
}
}
public int getResultSetScrollability() {
return ResultProperties.getJDBCScrollability(rsProperties);
}
}