- All Implemented Interfaces:
AutoCloseable
,PreparedStatement
,Statement
,Wrapper
- Direct Known Subclasses:
JDBCCallableStatement
A SQL statement is precompiled and stored in a
PreparedStatement
object. This object can then be used to
efficiently execute this statement multiple times.
Note: The setter methods (setShort
, setString
,
and so on) for setting IN parameter values
must specify types that are compatible with the defined SQL type of
the input parameter. For instance, if the IN parameter has SQL type
INTEGER
, then the method setInt
should be used.
If arbitrary parameter type conversions are required, the method
setObject
should be used with a target SQL type.
In the following example of setting a parameter, con
represents
an active connection:
PreparedStatement pstmt = con.prepareStatement("UPDATE EMPLOYEES SET SALARY = ? WHERE ID = ?"); pstmt.setBigDecimal(1, 153833.00) pstmt.setInt(2, 110592)
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.
JDBCPreparedStatement objects are backed by a true compiled parametric representation. Hence, there are now significant performance gains to be had by using a JDBCPreparedStatement object in preference to a JDBCStatement object when a short-running SQL statement is to be executed more than once.
When it can be otherwise avoided, it should be considered poor practice to fully prepare (construct), parameterize, execute, fetch and close a JDBCParameterMetaData object for each execution cycle. Indeed, because the prepare and execute phases both represent a round-trip to the engine, this practice is likely to be noticeably less performant for short-running statements (and possibly even orders of magnitude less performant over network connections for short-running statements) than the equivalent process using JDBCStatement objects, albeit far more convenient, less error prone and certainly much less resource-intensive, especially when large binary and character values are involved, due to the optimized parameterization facility.
Instead, when developing an application that is not totally oriented toward the execution of ad hoc SQL, it is recommended to expend some effort toward identifying the SQL statements that are good candidates for regular reuse and adapting the structure of the application accordingly. Often, this is done by recording the text of candidate SQL statements in an application resource object (which has the nice side-benefit of isolating and hiding differences in SQL dialects across different drivers) and caching for possible reuse the PreparedStatement objects derived from the recorded text.
Starting with 2.0, when built under a JDBC 4 environment, statement caching can be transparently enabled or disabled on a statement-by-statement basis by invoking setPoolable(true | false), respectively, upon Statement objects of interest.
Multi thread use:
A PreparedStatement object is stateful and should not normally be shared by multiple threads. If it has to be shared, the calls to set the parameters, calls to add batch statements, the execute call and any post-execute calls should be made within a block synchronized on the PreparedStatement Object.
(fredt@users)
(campbell-burnet@users)
- Since:
- 1.9.0
- Author:
- Campbell Burnet (campbell-burnet@users dot sourceforge.net), Fred Toussi (fredt@users dot sourceforge.net)
- See Also:
-
Field Summary
Fields inherited from interface java.sql.Statement
CLOSE_ALL_RESULTS, CLOSE_CURRENT_RESULT, EXECUTE_FAILED, KEEP_CURRENT_RESULT, NO_GENERATED_KEYS, RETURN_GENERATED_KEYS, SUCCESS_NO_INFO
-
Method Summary
Modifier and TypeMethodDescriptionvoid
addBatch()
Adds a set of parameters to thisPreparedStatement
object's batch of commands.void
This method should always throw if called for a PreparedStatement or CallableStatement.void
cancel()
Cancels thisStatement
object if both the DBMS and driver support aborting an SQL statement.void
Empties thisStatement
object's current list of SQL commands.void
Clears the current parameter values immediately.void
Clears all the warnings reported on thisStatement
object.void
close()
Does the specialized work required to free this object's resources and that of its parent class.void
Specifies that thisStatement
will be closed when all its dependent result sets are closed.boolean
execute()
Executes the SQL statement in thisPreparedStatement
object, which may be any kind of SQL statement.boolean
This method should always throw if called for a PreparedStatement or CallableStatement.boolean
boolean
boolean
int[]
Submits a batch of commands to the database for execution and if all commands execute successfully, returns an array of update counts.long[]
Submits a batch of commands to the database for execution and if all commands execute successfully, returns an array of update counts.long
Executes the SQL statement in thisPreparedStatement
object, which must be an SQL Data Manipulation Language (DML) statement, such asINSERT
,UPDATE
orDELETE
; or an SQL statement that returns nothing, such as a DDL statement.Executes the SQL query in thisPreparedStatement
object and returns theResultSet
object generated by the query.executeQuery
(String sql) This method should always throw if called for a PreparedStatement or CallableStatement.int
Executes the SQL statement in thisPreparedStatement
object, (JDBC4 clarification:) which must be an SQL Data Manipulation Language (DML) statement, such asINSERT
,UPDATE
orDELETE
; or an SQL statement that returns nothing, such as a DDL statement.int
executeUpdate
(String sql) This method should always throw if called for a PreparedStatement or CallableStatement.int
executeUpdate
(String sql, int autoGeneratedKeys) Statement methods that must be overridden in this class and throw an exception.int
executeUpdate
(String sql, int[] columnIndexes) int
executeUpdate
(String sql, String[] columnNames) Retrieves theConnection
object that produced thisStatement
object.int
Retrieves the direction for fetching rows from database tables that is the default for result sets generated from thisStatement
object.int
Retrieves the number of result set rows that is the default fetch size forResultSet
objects generated from thisStatement
object.Retrieves any auto-generated keys created as a result of executing thisStatement
object.long
Retrieves the maximum number of rows that aResultSet
object produced by thisStatement
object can contain.long
Retrieves the current result as an update count; if the result is aResultSet
object or there are no more results, -1 is returned.int
Retrieves the maximum number of bytes that can be returned for character and binary column values in aResultSet
object produced by thisStatement
object.int
Retrieves the maximum number of rows that aResultSet
object produced by thisStatement
object can contain.Retrieves aResultSetMetaData
object that contains information about the columns of theResultSet
object that will be returned when thisPreparedStatement
object is executed.boolean
Moves to thisStatement
object's next result, returnstrue
if it is aResultSet
object, and implicitly closes any currentResultSet
object(s) obtained with the methodgetResultSet
.boolean
getMoreResults
(int current) Moves to thisStatement
object's next result, deals with any currentResultSet
object(s) according to the instructions specified by the given flag, and returnstrue
if the next result is aResultSet
object.Retrieves the number, types and properties of thisPreparedStatement
object's parameters.org.hsqldb.result.ResultMetaData
int
Retrieves the number of seconds the driver will wait for aStatement
object to execute.Retrieves the current result as aResultSet
object.int
Retrieves the result set concurrency forResultSet
objects generated by thisStatement
object.int
Retrieves the result set holdability forResultSet
objects generated by thisStatement
object.int
Retrieves the result set type forResultSet
objects generated by thisStatement
object.getSQL()
long
int
Retrieves the current result as an update count; if the result is aResultSet
object or there are no more results, -1 is returned.Retrieves the first warning reported by calls on thisStatement
object.boolean
isClosed()
Retrieves whether thisStatement
object has been closed.boolean
Returns a value indicating whether thisStatement
will be closed when all its dependent result sets are closed.boolean
Returns a value indicating whether theStatement
is poolable or not.boolean
boolean
isWrapperFor
(Class<?> iface) Returns true if this either implements the interface argument or is directly or indirectly a wrapper for an object that does.void
Sets the designated parameter to the givenjava.sql.Array
object.void
setAsciiStream
(int parameterIndex, InputStream x) Sets the designated parameter to the given input stream.void
setAsciiStream
(int parameterIndex, InputStream x, int length) Sets the designated parameter to the given input stream, which will have the specified number of bytes.void
setAsciiStream
(int parameterIndex, InputStream x, long length) Sets the designated parameter to the given input stream, which will have the specified number of bytes.void
setBigDecimal
(int parameterIndex, BigDecimal x) Sets the designated parameter to the givenjava.math.BigDecimal
value.void
setBinaryStream
(int parameterIndex, InputStream x) Sets the designated parameter to the given input stream.void
setBinaryStream
(int parameterIndex, InputStream x, int length) Sets the designated parameter to the given input stream, which will have the specified number of bytes.void
setBinaryStream
(int parameterIndex, InputStream x, long length) Sets the designated parameter to the given input stream, which will have the specified number of bytes.void
setBlob
(int parameterIndex, InputStream inputStream) Sets the designated parameter to aInputStream
object.void
setBlob
(int parameterIndex, InputStream inputStream, long length) Sets the designated parameter to aInputStream
object.void
Sets the designated parameter to the givenjava.sql.Blob
object.void
setBoolean
(int parameterIndex, boolean x) Sets the designated parameter to the given Javaboolean
value.void
setByte
(int parameterIndex, byte x) Sets the designated parameter to the given Javabyte
value.void
setBytes
(int parameterIndex, byte[] x) Sets the designated parameter to the given Java array of bytes.void
setCharacterStream
(int parameterIndex, Reader reader) Sets the designated parameter to the givenReader
object.void
setCharacterStream
(int parameterIndex, Reader reader, int length) Sets the designated parameter to the givenReader
object, which is the given number of characters long.void
setCharacterStream
(int parameterIndex, Reader reader, long length) Sets the designated parameter to the givenReader
object, which is the given number of characters long.void
Sets the designated parameter to aReader
object.void
Sets the designated parameter to aReader
object.void
Sets the designated parameter to the givenjava.sql.Clob
object.void
setCursorName
(String name) Sets the SQL cursor name to the givenString
, which will be used by subsequentStatement
objectexecute
methods.void
(JDBC4 clarification:) Sets the designated parameter to the givenjava.sql.Date
value using the default time zone of the virtual machine that is running the application.void
Sets the designated parameter to the givenjava.sql.Date
value, using the givenCalendar
object.void
setDouble
(int parameterIndex, double x) Sets the designated parameter to the given Javadouble
value.void
setEscapeProcessing
(boolean enable) Sets escape processing on or off.void
setFetchDirection
(int direction) Gives the driver a hint as to the direction in which rows will be processed inResultSet
objects created using thisStatement
object.void
setFetchSize
(int rows) (JDBC4 clarification:) Gives the JDBC driver a hint as to the number of rows that should be fetched from the database when more rows are needed forResultSet
objects generated by thisStatement
.void
setFloat
(int parameterIndex, float x) Sets the designated parameter to the given Javafloat
value.void
setInt
(int parameterIndex, int x) Sets the designated parameter to the given Javaint
value.void
setLargeMaxRows
(long max) Sets the limit for the maximum number of rows that anyResultSet
object generated by thisStatement
object can contain to the given number.void
setLong
(int parameterIndex, long x) Sets the designated parameter to the given Javalong
value.void
setMaxFieldSize
(int max) (JDBC4 clarification:) Sets the limit for the maximum number of bytes in aResultSet
Sets the limit for the maximum number of bytes that can be returned for character and binary column values in aResultSet
object produced by thisStatement
object.void
setMaxRows
(int max) (JDBC4 clarification:) Sets the limit for the maximum number of rows that anyResultSet
object generated by thisStatement
object can contain to the given number.void
setNCharacterStream
(int parameterIndex, Reader value) Sets the designated parameter to aReader
object.void
setNCharacterStream
(int parameterIndex, Reader value, long length) Sets the designated parameter to aReader
object.void
Sets the designated parameter to aReader
object.void
Sets the designated parameter to aReader
object.void
Sets the designated parameter to ajava.sql.NClob
object.void
setNString
(int parameterIndex, String value) Sets the designated parameter to the givenString
object.void
setNull
(int parameterIndex, int sqlType) Sets the designated parameter to SQLNULL
.void
Sets the designated parameter to SQLNULL
.void
void
Sets the value of the designated parameter with the given object.void
Sets the value of the designated parameter with the given object.void
Sets the value of the designated parameter with the given object.void
Sets the value of the designated parameter with the given object.void
setPoolable
(boolean poolable) Requests that aStatement
be pooled or not pooled.void
setQueryTimeout
(int seconds) Sets the number of seconds the driver will wait for aStatement
object to execute to the given number of seconds.void
Sets the designated parameter to the givenREF(<structured-type>)
value.void
Sets the designated parameter to the givenjava.sql.RowId
object.void
setShort
(int parameterIndex, short x) Sets the designated parameter to the given Javashort
value.void
Sets the designated parameter to the givenjava.sql.SQLXML
object.void
Sets the designated parameter to the given JavaString
value.void
Sets the designated parameter to the givenjava.sql.Time
value.void
Sets the designated parameter to the givenjava.sql.Time
value, using the givenCalendar
object.void
setTimestamp
(int parameterIndex, Timestamp x) Sets the designated parameter to the givenjava.sql.Timestamp
value.void
setTimestamp
(int parameterIndex, Timestamp x, Calendar cal) Sets the designated parameter to the givenjava.sql.Timestamp
value, using the givenCalendar
object.void
setUnicodeStream
(int parameterIndex, InputStream x, int length) Deprecated.Sun does not include a reason, but presumably this is because setCharacterStream is now preferredvoid
Sets the designated parameter to the givenjava.net.URL
value.toString()
Retrieves a String representation of this object.<T> T
Returns an object that implements the given interface to allow access to non-standard methods, or standard methods not exposed by the proxy.Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface java.sql.Statement
closeOnCompletion, enquoteIdentifier, enquoteLiteral, enquoteNCharLiteral, executeLargeUpdate, executeLargeUpdate, executeLargeUpdate, executeLargeUpdate, isCloseOnCompletion, isSimpleIdentifier
-
Method Details
-
executeQuery
Executes the SQL query in thisPreparedStatement
object and returns theResultSet
object generated by the query.- Specified by:
executeQuery
in interfacePreparedStatement
- Returns:
- a
ResultSet
object that contains the data produced by the query; nevernull
- Throws:
SQLException
- if a database access error occurs, this method is called on a closedPreparedStatement
or the SQL statement does not return aResultSet
object
-
executeUpdate
Executes the SQL statement in thisPreparedStatement
object, (JDBC4 clarification:) which must be an SQL Data Manipulation Language (DML) statement, such asINSERT
,UPDATE
orDELETE
; or an SQL statement that returns nothing, such as a DDL statement.- Specified by:
executeUpdate
in interfacePreparedStatement
- Returns:
- (JDBC4 clarification:) 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 closedPreparedStatement
or the SQL statement returns aResultSet
object
-
setNull
Sets the designated parameter to SQLNULL
.Note: You must specify the parameter's SQL type.
HSQLDB-Specific Information:
HSQLDB currently ignores the sqlType argument.
- Specified by:
setNull
in interfacePreparedStatement
- Parameters:
parameterIndex
- the first parameter is 1, the second is 2, ...sqlType
- the SQL type code defined injava.sql.Types
- Throws:
SQLException
- if a database access error occurs or this method is called on a closedPreparedStatement
SQLFeatureNotSupportedException
- ifsqlType
is aARRAY
,BLOB
,CLOB
,DATALINK
,JAVA_OBJECT
,NCHAR
,NCLOB
,NVARCHAR
,LONGNVARCHAR
,REF
,ROWID
,SQLXML
orSTRUCT
data type and the JDBC driver does not support this data type
-
setBoolean
Sets the designated parameter to the given Javaboolean
value. The driver converts this (JDBC4 Modified:) to an SQLBIT
orBOOLEAN
value when it sends it to the database.HSQLDB-Specific Information:
HSQLDB supports BOOLEAN type for boolean values. This method can also be used to set the value of a parameter of the SQL type BIT(1), which is a bit string consisting of a 0 or 1.
- Specified by:
setBoolean
in interfacePreparedStatement
- Parameters:
parameterIndex
- the first parameter is 1, the second is 2, ...x
- the parameter value- Throws:
SQLException
- if a database access error occurs or this method is called on a closedPreparedStatement
-
setByte
Sets the designated parameter to the given Javabyte
value. The driver converts this to an SQLTINYINT
value when it sends it to the database.- Specified by:
setByte
in interfacePreparedStatement
- Parameters:
parameterIndex
- the first parameter is 1, the second is 2, ...x
- the parameter value- Throws:
SQLException
- if a database access error occurs or this method is called on a closedPreparedStatement
-
setShort
Sets the designated parameter to the given Javashort
value. The driver converts this to an SQLSMALLINT
value when it sends it to the database.- Specified by:
setShort
in interfacePreparedStatement
- Parameters:
parameterIndex
- the first parameter is 1, the second is 2, ...x
- the parameter value- Throws:
SQLException
- if a database access error occurs or this method is called on a closedPreparedStatement
-
setInt
Sets the designated parameter to the given Javaint
value. The driver converts this to an SQLINTEGER
value when it sends it to the database.- Specified by:
setInt
in interfacePreparedStatement
- Parameters:
parameterIndex
- the first parameter is 1, the second is 2, ...x
- the parameter value- Throws:
SQLException
- if a database access error occurs or this method is called on a closedPreparedStatement
-
setLong
Sets the designated parameter to the given Javalong
value. The driver converts this to an SQLBIGINT
value when it sends it to the database.- Specified by:
setLong
in interfacePreparedStatement
- Parameters:
parameterIndex
- the first parameter is 1, the second is 2, ...x
- the parameter value- Throws:
SQLException
- if a database access error occurs or this method is called on a closedPreparedStatement
-
setFloat
Sets the designated parameter to the given Javafloat
value. The driver converts this (JDBC4 correction:) to an SQLREAL
value when it sends it to the database.HSQLDB-Specific Information:
Since 1.7.1, HSQLDB handles Java positive/negative Infinity and NaN
float
values consistent with the Java Language Specification; these special values are now correctly stored to and retrieved from the database.- Specified by:
setFloat
in interfacePreparedStatement
- Parameters:
parameterIndex
- the first parameter is 1, the second is 2, ...x
- the parameter value- Throws:
SQLException
- if a database access error occurs or this method is called on a closedPreparedStatement
-
setDouble
Sets the designated parameter to the given Javadouble
value. The driver converts this to an SQLDOUBLE
value when it sends it to the database.HSQLDB-Specific Information:
Since 1.7.1, HSQLDB handles Java positive/negative Infinity and NaN
double
values consistent with the Java Language Specification; these special values are now correctly stored to and retrieved from the database.- Specified by:
setDouble
in interfacePreparedStatement
- Parameters:
parameterIndex
- the first parameter is 1, the second is 2, ...x
- the parameter value- Throws:
SQLException
- if a database access error occurs or this method is called on a closedPreparedStatement
-
setBigDecimal
Sets the designated parameter to the givenjava.math.BigDecimal
value. The driver converts this to an SQLNUMERIC
value when it sends it to the database.- Specified by:
setBigDecimal
in interfacePreparedStatement
- Parameters:
parameterIndex
- the first parameter is 1, the second is 2, ...x
- the parameter value- Throws:
SQLException
- if a database access error occurs or this method is called on a closedPreparedStatement
-
setString
Sets the designated parameter to the given JavaString
value. The driver converts this to an SQLVARCHAR
orLONGVARCHAR
value (depending on the argument's size relative to the driver's limits onVARCHAR
values) when it sends it to the database.HSQLDB-Specific Information:
Including 2.0, HSQLDB represents all XXXCHAR values internally as java.lang.String objects; there is no appreciable difference between CHAR, VARCHAR and LONGVARCHAR.
- Specified by:
setString
in interfacePreparedStatement
- Parameters:
parameterIndex
- the first parameter is 1, the second is 2, ...x
- the parameter value- Throws:
SQLException
- if a database access error occurs or this method is called on a closedPreparedStatement
-
setBytes
Sets the designated parameter to the given Java array of bytes. The driver converts this to an SQLVARBINARY
orLONGVARBINARY
(depending on the argument's size relative to the driver's limits onVARBINARY
values) when it sends it to the database.HSQLDB-Specific Information:
Including 2.0, HSQLDB represents all XXXBINARY values the same way internally; there is no appreciable difference between BINARY, VARBINARY and LONGVARBINARY as far as JDBC is concerned.
- Specified by:
setBytes
in interfacePreparedStatement
- Parameters:
parameterIndex
- the first parameter is 1, the second is 2, ...x
- the parameter value- Throws:
SQLException
- if a database access error occurs or this method is called on a closedPreparedStatement
-
setDate
(JDBC4 clarification:) Sets the designated parameter to the givenjava.sql.Date
value using the default time zone of the virtual machine that is running the application. The driver converts this to an SQLDATE
value when it sends it to the database.HSQLDB-Specific Information:
When a setXXX method is used to set a parameter of type TIMESTAMP WITH TIME ZONE or TIME WITH TIME ZONE the time zone of the client application is used as time zone
- Specified by:
setDate
in interfacePreparedStatement
- Parameters:
parameterIndex
- the first parameter is 1, the second is 2, ...x
- the parameter value- Throws:
SQLException
- if a database access error occurs or this method is called on a closedPreparedStatement
-
setTime
Sets the designated parameter to the givenjava.sql.Time
value. The driver converts this to an SQLTIME
value when it sends it to the database.HSQLDB-Specific Information:
When a setXXX method is used to set a parameter of type TIMESTAMP WITH TIME ZONE or TIME WITH TIME ZONE the time zone of the client application is used as time zone
- Specified by:
setTime
in interfacePreparedStatement
- Parameters:
parameterIndex
- the first parameter is 1, the second is 2, ...x
- the parameter value- Throws:
SQLException
- if a database access error occurs or this method is called on a closedPreparedStatement
-
setTimestamp
Sets the designated parameter to the givenjava.sql.Timestamp
value. The driver converts this to an SQLTIMESTAMP
value when it sends it to the database.HSQLDB-Specific Information:
When a setXXX method is used to set a parameter of type TIMESTAMP WITH TIME ZONE or TIME WITH TIME ZONE the time zone of the client application is used as time zone.
When this method is used to set a parameter of type TIME or TIME WITH TIME ZONE, then the nanosecond value of the Timestamp object will be used if the TIME parameter accepts fractional seconds.
- Specified by:
setTimestamp
in interfacePreparedStatement
- Parameters:
parameterIndex
- the first parameter is 1, the second is 2, ...x
- the parameter value- Throws:
SQLException
- if a database access error occurs or this method is called on a closedPreparedStatement
-
setAsciiStream
Sets the designated parameter to the given input stream, which will have the specified number of bytes. When a very large ASCII value is input to aLONGVARCHAR
parameter, it may be more practical to send it via ajava.io.InputStream
. Data will be read from the stream as needed until end-of-file is reached. The JDBC driver will do any necessary conversion from ASCII to the database char format.Note: This stream object can either be a standard Java stream object or your own subclass that implements the standard interface.
HSQLDB-Specific Information:
From HSQLDB 2.0 this method uses the US-ASCII character encoding to convert bytes from the stream into the characters of a String.
This method does not use streaming to send the data, whether the target is a CLOB or other binary object.
For long streams (larger than a few megabytes) with CLOB targets, it is more efficient to use a version of setCharacterStream which takes the a length parameter.
- Specified by:
setAsciiStream
in interfacePreparedStatement
- Parameters:
parameterIndex
- the first parameter is 1, the second is 2, ...x
- the Java input stream that contains the ASCII parameter valuelength
- the number of bytes in the stream- Throws:
SQLException
- if a database access error occurs or this method is called on a closedPreparedStatement
-
setUnicodeStream
@Deprecated public void setUnicodeStream(int parameterIndex, InputStream x, int length) throws SQLException Deprecated.Sun does not include a reason, but presumably this is because setCharacterStream is now preferredSets the designated parameter to the given input stream, which will have the specified number of bytes. (JDBC4 deleted:) [A Unicode character has two bytes, with the first byte being the high byte, and the second being the low byte.]When a very large Unicode value is input to a
LONGVARCHAR
parameter, it may be more practical to send it via ajava.io.InputStream
object. The data will be read from the stream as needed until end-of-file is reached. The JDBC driver will do any necessary conversion from Unicode to the database char format. (JDBC4 added:) The byte format of the Unicode stream must be a Java UTF-8, as defined in the Java Virtual Machine Specification.Note: This stream object can either be a standard Java stream object or your own subclass that implements the standard interface.
HSQLDB-Specific Information:
Starting with 2.0, this method behaves according to the JDBC4 specification (the stream is treated as though it has UTF-8 encoding. This method is deprecated: please use setCharacterStream(...) instead.
- Specified by:
setUnicodeStream
in interfacePreparedStatement
- Parameters:
parameterIndex
- the first parameter is 1, the second is 2, ...x
- ajava.io.InputStream
object that contains the Unicode parameter value (JDBC4 deleted:) [as two-byte Unicode characters]length
- the number of bytes in the stream- Throws:
SQLException
- if a database access error occurs or this method is called on a closedPreparedStatement
SQLFeatureNotSupportedException
- if the JDBC driver does not support this method
-
setBinaryStream
Sets the designated parameter to the given input stream, which will have the specified number of bytes. When a very large binary value is input to aLONGVARBINARY
parameter, it may be more practical to send it via ajava.io.InputStream
object. The data will be read from the stream as needed until end-of-file is reached.Note: This stream object can either be a standard Java stream object or your own subclass that implements the standard interface.
HSQLDB-Specific Information:
Since 1.7.2, this method works according to the standard.
- Specified by:
setBinaryStream
in interfacePreparedStatement
- Parameters:
parameterIndex
- the first parameter is 1, the second is 2, ...x
- the java input stream which contains the binary parameter valuelength
- the number of bytes in the stream- Throws:
SQLException
- if a database access error occurs or this method is called on a closedPreparedStatement
-
clearParameters
Clears the current parameter values immediately.In general, parameter values remain in force for repeated use of a statement. Setting a parameter value automatically clears its previous value. However, in some cases it is useful to immediately release the resources used by the current parameter values; this can be done by calling the method
clearParameters
.- Specified by:
clearParameters
in interfacePreparedStatement
- Throws:
SQLException
- if a database access error occurs or this method is called on a closedPreparedStatement
-
setObject
public void setObject(int parameterIndex, Object x, int targetSqlType, int scaleOrLength) throws SQLException Sets the value of the designated parameter with the given object. The second argument must be an object type; for integral values, the
java.lang
equivalent objects should be used. If the second argument is anInputStream
then the stream must contain the number of bytes specified by scaleOrLength. If the second argument is aReader
then the reader must contain the number of characters specified by scaleOrLength. If these conditions are not true the driver will generate aSQLException
when the prepared statement is executed.The given Java object will be converted to the given targetSqlType before being sent to the database. If the object has a custom mapping (is of a class implementing the interface
SQLData
), the JDBC driver should call the methodSQLData.writeSQL
to write it to the SQL data stream. If, on the other hand, the object is of a class implementingRef
,Blob
,Clob
,NClob
,Struct
,java.net.URL
, orArray
, the driver should pass it to the database as a value of the corresponding SQL type.Note that this method may be used to pass database-specific abstract data types.
- Specified by:
setObject
in interfacePreparedStatement
- Parameters:
parameterIndex
- the first parameter is 1, the second is 2, ...x
- the object containing the input parameter valuetargetSqlType
- the SQL type (as defined in java.sql.Types) to be sent to the database. The scale argument may further qualify this type.scaleOrLength
- forjava.sql.Types.DECIMAL
orjava.sql.Types.NUMERIC types
, this is the number of digits after the decimal point. For Java Object typesInputStream
andReader
, this is the length of the data in the stream or reader. For all other types, this value will be ignored.- Throws:
SQLException
- if a database access error occurs, this method is called on a closedPreparedStatement
or if the Java Object specified by x is an InputStream or Reader object and the value of the scale parameter is less than zeroSQLFeatureNotSupportedException
- iftargetSqlType
is aARRAY
,BLOB
,CLOB
,DATALINK
,JAVA_OBJECT
,NCHAR
,NCLOB
,NVARCHAR
,LONGNVARCHAR
,REF
,ROWID
,SQLXML
orSTRUCT
data type and the JDBC driver does not support this data type- See Also:
-
setObject
Sets the value of the designated parameter with the given object. This method is like the methodsetObject
above, except that it assumes a scale of zero.HSQLDB-Specific Information:
Since 1.7.2, this method supports conversions listed in the conversion table B-5 of the JDBC 3 specification.
- Specified by:
setObject
in interfacePreparedStatement
- Parameters:
parameterIndex
- the first parameter is 1, the second is 2, ...x
- the object containing the input parameter valuetargetSqlType
- the SQL type (as defined in java.sql.Types) to be sent to the database- Throws:
SQLException
- if a database access error occurs or this method is called on a closedPreparedStatement
SQLFeatureNotSupportedException
- iftargetSqlType
is aARRAY
,BLOB
,CLOB
,DATALINK
,JAVA_OBJECT
,NCHAR
,NCLOB
,NVARCHAR
,LONGNVARCHAR
,REF
,ROWID
,SQLXML
orSTRUCT
data type and the JDBC driver does not support this data type- See Also:
-
setObject
Sets the value of the designated parameter using the given object. The second parameter must be of type
Object
; therefore, thejava.lang
equivalent objects should be used for built-in types.The JDBC specification specifies a standard mapping from Java
Object
types to SQL types. The given argument will be converted to the corresponding SQL type before being sent to the database.Note that this method may be used to pass database- specific abstract data types, by using a driver-specific Java type. If the object is of a class implementing the interface
SQLData
, the JDBC driver should call the methodSQLData.writeSQL
to write it to the SQL data stream. If, on the other hand, the object is of a class implementingRef
,Blob
,Clob
, (JDBC4 new:) [NClob
],Struct
,java.net.URL
, (JDBC4 new:) [RowId
,SQLXML
] orArray
, the driver should pass it to the database as a value of the corresponding SQL type.Note: Not all databases allow for a non-typed Null to be sent to the backend. For maximum portability, the
setNull
or thesetObject(int parameterIndex, Object x, int sqlType)
method should be used instead ofsetObject(int parameterIndex, Object x)
.Note: This method throws an exception if there is an ambiguity, for example, if the object is of a class implementing more than one of the interfaces named above.
HSQLDB-Specific Information:
Since 1.7.2, this method supports conversions listed in the conversion table B-5 of the JDBC 3 specification.
- Specified by:
setObject
in interfacePreparedStatement
- Parameters:
parameterIndex
- the first parameter is 1, the second is 2, ...x
- the object containing the input parameter value- Throws:
SQLException
- if a database access error occurs, this method is called on a closedPreparedStatement
or the type of the given object is ambiguous
-
execute
Executes the SQL statement in thisPreparedStatement
object, which may be any kind of SQL statement. Some prepared statements return multiple results; theexecute
method handles these complex statements as well as the simpler form of statements handled by the methodsexecuteQuery
andexecuteUpdate
.The
execute
method returns aboolean
to indicate the form of the first result. You must call either the methodgetResultSet
orgetUpdateCount
to retrieve the result; you must callgetMoreResults
to move to any subsequent result(s).HSQLDB-Specific Information:
If the statement is a call to a PROCEDURE, it may return multiple multiple fetchable results.
- Specified by:
execute
in interfacePreparedStatement
- Returns:
true
if the first result is aResultSet
object;false
if the first result is an update count or there is no result- Throws:
SQLException
- if a database access error occurs, this method is called on a closedPreparedStatement
or an argument is supplied to this method- See Also:
-
addBatch
Adds a set of parameters to thisPreparedStatement
object's batch of commands.HSQLDB-Specific Information:
Since 1.7.2, this feature is supported.
- Specified by:
addBatch
in interfacePreparedStatement
- Throws:
SQLException
- if a database access error occurs or this method is called on a closedPreparedStatement
- Since:
- JDK 1.2
- See Also:
-
setCharacterStream
Sets the designated parameter to the givenReader
object, which is the given number of characters long. When a very large UNICODE value is input to aLONGVARCHAR
parameter, it may be more practical to send it via ajava.io.Reader
object. The data will be read from the stream as needed until end-of-file is reached. The JDBC driver will do any necessary conversion from UNICODE to the database char format.Note: This stream object can either be a standard Java stream object or your own subclass that implements the standard interface.
HSQLDB-Specific Information:
From HSQLDB 2.0 this method uses streaming to send data when the target is a CLOB.
HSQLDB represents CHARACTER and related SQL types as UTF16 Unicode internally, so this method does not perform any conversion.
- Specified by:
setCharacterStream
in interfacePreparedStatement
- Parameters:
parameterIndex
- the first parameter is 1, the second is 2, ...reader
- thejava.io.Reader
object that contains the Unicode datalength
- the number of characters in the stream- Throws:
SQLException
- if a database access error occurs or this method is called on a closedPreparedStatement
- Since:
- JDK 1.2
-
setRef
Sets the designated parameter to the givenREF(<structured-type>)
value. The driver converts this to an SQLREF
value when it sends it to the database.HSQLDB-Specific Information:
Including 2.0 HSQLDB does not support the SQL REF type. Calling this method throws an exception.
- Specified by:
setRef
in interfacePreparedStatement
- Parameters:
parameterIndex
- the first parameter is 1, the second is 2, ...x
- an SQLREF
value- Throws:
SQLException
- if a database access error occurs or this method is called on a closedPreparedStatement
SQLFeatureNotSupportedException
- if the JDBC driver does not support this method- Since:
- JDK 1.2
-
setBlob
Sets the designated parameter to the givenjava.sql.Blob
object. The driver converts this to an SQLBLOB
value when it sends it to the database.HSQLDB-Specific Information:
For parameters of type Blob, setBlob works normally.
In addition since 1.7.2, setBlob is supported for BINARY and VARBINARY parameters. In this context, the Blob object is hard-limited to those of length less than or equal to Integer.MAX_VALUE. In practice, soft limits such as available heap and maximum disk usage per file (such as the transaction log) dictate a much smaller maximum length.
For BINARY and VARBINARY parameter types setBlob(i,x) is roughly equivalent (null and length handling not shown) to:
setBinaryStream(i, x.getBinaryStream(), (int) x.length());
- Specified by:
setBlob
in interfacePreparedStatement
- Parameters:
parameterIndex
- the first parameter is 1, the second is 2, ...x
- aBlob
object that maps an SQLBLOB
value- Throws:
SQLException
- if a database access error occurs or this method is called on a closedPreparedStatement
SQLFeatureNotSupportedException
- if the JDBC driver does not support this method- Since:
- JDK 1.2
-
setClob
Sets the designated parameter to the givenjava.sql.Clob
object. The driver converts this to an SQLCLOB
value when it sends it to the database.HSQLDB-Specific Information:
For parameters of type Clob, setClob works normally.
In addition since 1.7.2, setClob is supported for CHARACTER and VARCHAR parameters. In this context, the Clob object is hard-limited to those of length less than or equal to Integer.MAX_VALUE. In practice, soft limits such as available heap and maximum disk usage per file (such as the transaction log) dictate a much smaller maximum length.
For CHARACTER and VARCHAR parameter types setClob(i,x) is roughly equivalent (null and length handling not shown) to:
setCharacterStream(i, x.getCharacterStream(), (int) x.length());
- Specified by:
setClob
in interfacePreparedStatement
- Parameters:
parameterIndex
- the first parameter is 1, the second is 2, ...x
- aClob
object that maps an SQLCLOB
value- Throws:
SQLException
- if a database access error occurs or this method is called on a closedPreparedStatement
SQLFeatureNotSupportedException
- if the JDBC driver does not support this method- Since:
- JDK 1.2
-
setArray
Sets the designated parameter to the givenjava.sql.Array
object. The driver converts this to an SQLARRAY
value when it sends it to the database.HSQLDB-Specific Information:
From version 2.0, HSQLDB supports the SQL ARRAY type.
- Specified by:
setArray
in interfacePreparedStatement
- Parameters:
parameterIndex
- the first parameter is 1, the second is 2, ...x
- anArray
object that maps an SQLARRAY
value- Throws:
SQLException
- if a database access error occurs or this method is called on a closedPreparedStatement
SQLFeatureNotSupportedException
- if the JDBC driver does not support this method- Since:
- JDK 1.2
-
getMetaData
Retrieves aResultSetMetaData
object that contains information about the columns of theResultSet
object that will be returned when thisPreparedStatement
object is executed.Because a
PreparedStatement
object is pre-compiled, it is possible to know about theResultSet
object that it will return without having to execute it. Consequently, it is possible to invoke the methodgetMetaData
on aPreparedStatement
object rather than waiting to execute it and then invoking theResultSet.getMetaData
method on theResultSet
object that is returned.NOTE: Using this method may be expensive for some drivers due to the lack of underlying DBMS support.
HSQLDB-Specific Information:
Since 1.7.2, this feature is supported and is inexpensive as it is backed by underlying DBMS support. If the statement generates an update count, then null is returned.
- Specified by:
getMetaData
in interfacePreparedStatement
- Returns:
- the description of a
ResultSet
object's columns ornull
if the driver cannot return aResultSetMetaData
object - Throws:
SQLException
- if a database access error occurs or this method is called on a closedPreparedStatement
SQLFeatureNotSupportedException
- if the JDBC driver does not support this method- Since:
- JDK 1.2
-
setDate
Sets the designated parameter to the givenjava.sql.Date
value, using the givenCalendar
object. The driver uses theCalendar
object to construct an SQLDATE
value, which the driver then sends to the database. With aCalendar
object, the driver can calculate the date taking into account a custom timezone. If noCalendar
object is specified, the driver uses the default timezone, which is that of the virtual machine running the application.- Specified by:
setDate
in interfacePreparedStatement
- Parameters:
parameterIndex
- the first parameter is 1, the second is 2, ...x
- the parameter valuecal
- theCalendar
object the driver will use to construct the date- Throws:
SQLException
- if a database access error occurs or this method is called on a closedPreparedStatement
- Since:
- JDK 1.2
-
setTime
Sets the designated parameter to the givenjava.sql.Time
value, using the givenCalendar
object. The driver uses theCalendar
object to construct an SQLTIME
value, which the driver then sends to the database. With aCalendar
object, the driver can calculate the time taking into account a custom timezone. If noCalendar
object is specified, the driver uses the default timezone, which is that of the virtual machine running the application.HSQLDB-Specific Information:
When a setXXX method is used to set a parameter of type TIMESTAMP WITH TIME ZONE or TIME WITH TIME ZONE the time zone (including Daylight Saving Time) of the Calendar is used as time zone for the value.
- Specified by:
setTime
in interfacePreparedStatement
- Parameters:
parameterIndex
- the first parameter is 1, the second is 2, ...x
- the parameter valuecal
- theCalendar
object the driver will use to construct the time- Throws:
SQLException
- if a database access error occurs or this method is called on a closedPreparedStatement
- Since:
- JDK 1.2
-
setTimestamp
Sets the designated parameter to the givenjava.sql.Timestamp
value, using the givenCalendar
object. The driver uses theCalendar
object to construct an SQLTIMESTAMP
value, which the driver then sends to the database. With aCalendar
object, the driver can calculate the timestamp taking into account a custom timezone. If noCalendar
object is specified, the driver uses the default timezone, which is that of the virtual machine running the application.HSQLDB-Specific Information:
When a setXXX method is used to set a parameter of type TIMESTAMP WITH TIME ZONE or TIME WITH TIME ZONE the time zone (including Daylight Saving Time) of the Calendar is used as time zone.
In this case, if the Calendar argument is null, then the default Calendar for the clients JVM is used as the Calendar
When this method is used to set a parameter of type TIME or TIME WITH TIME ZONE, then the nanosecond value of the Timestamp object is used if the TIME parameter accepts fractional seconds.
- Specified by:
setTimestamp
in interfacePreparedStatement
- Parameters:
parameterIndex
- the first parameter is 1, the second is 2, ...x
- the parameter valuecal
- theCalendar
object the driver will use to construct the timestamp- Throws:
SQLException
- if a database access error occurs or this method is called on a closedPreparedStatement
- Since:
- JDK 1.2
-
setNull
Sets the designated parameter to SQLNULL
. This version of the methodsetNull
should be used for user-defined types and REF type parameters. Examples of user-defined types include: STRUCT, DISTINCT, JAVA_OBJECT, and named array types.Note: To be portable, applications must give the SQL type code and the fully-qualified SQL type name when specifying a NULL user-defined or REF parameter. In the case of a user-defined type the name is the type name of the parameter itself. For a REF parameter, the name is the type name of the referenced type. If a JDBC driver does not need the type code or type name information, it may ignore it. Although it is intended for user-defined and Ref parameters, this method may be used to set a null parameter of any JDBC type. If the parameter does not have a user-defined or REF type, the given typeName is ignored.
HSQLDB-Specific Information:
HSQLDB simply ignores the sqlType and typeName arguments.
- Specified by:
setNull
in interfacePreparedStatement
- Parameters:
parameterIndex
- the first parameter is 1, the second is 2, ...sqlType
- a value fromjava.sql.Types
typeName
- the fully-qualified name of an SQL user-defined type; ignored if the parameter is not a user-defined type or REF- Throws:
SQLException
- if a database access error occurs or this method is called on a closedPreparedStatement
SQLFeatureNotSupportedException
- ifsqlType
is aARRAY
,BLOB
,CLOB
,DATALINK
,JAVA_OBJECT
,NCHAR
,NCLOB
,NVARCHAR
,LONGNVARCHAR
,REF
,ROWID
,SQLXML
orSTRUCT
data type and the JDBC driver does not support this data type or if the JDBC driver does not support this method- Since:
- JDK 1.2
-
executeBatch
Submits a batch of commands to the database for execution and if all commands execute successfully, returns an array of update counts. Theint
elements of the array that is returned are ordered to correspond to the commands in the batch, which are ordered according to the order in which they were added to the batch. The elements in the array returned by the methodexecuteBatch
may be one of the following:- A 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 unknownIf 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 methodBatchUpdateException.getUpdateCounts
will contain as many elements as there are commands in the batch, and at least one of the elements will be the following: - A value of
EXECUTE_FAILED
-- indicates that the command failed to execute successfully and occurs only if a driver continues to process commands after a command fails
A driver is not required to implement this method. The possible implementations and return values have been modified in the Java 2 SDK, Standard Edition, version 1.3 to accommodate the option of continuing to 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.
- Specified by:
executeBatch
in interfaceStatement
- 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.
- Throws:
SQLException
- if a database access error occurs, this method is called on a closedStatement
or the driver does not support batch statements. ThrowsBatchUpdateException
(a subclass ofSQLException
) if one of the commands sent to the database fails to execute properly or attempts to return a result set.- Since:
- JDK 1.3
- See Also:
-
setEscapeProcessing
Sets escape processing on or off.HSQLDB-Specific Information:
As per JDBC spec, calling this method has no effect.
- Specified by:
setEscapeProcessing
in interfaceStatement
- Parameters:
enable
-true
to enable escape processing;false
to disable it- Throws:
SQLException
- if a database access error occurs
-
addBatch
This method should always throw if called for a PreparedStatement or CallableStatement.- Specified by:
addBatch
in interfaceStatement
- Parameters:
sql
- ignored- Throws:
SQLException
- always
-
executeQuery
This method should always throw if called for a PreparedStatement or CallableStatement.- Specified by:
executeQuery
in interfaceStatement
- Parameters:
sql
- ignored- Returns:
- nothing
- Throws:
SQLException
- always
-
execute
This method should always throw if called for a PreparedStatement or CallableStatement.- Specified by:
execute
in interfaceStatement
- Parameters:
sql
- ignored- Returns:
- nothing
- Throws:
SQLException
- always
-
executeUpdate
This method should always throw if called for a PreparedStatement or CallableStatement.- Specified by:
executeUpdate
in interfaceStatement
- Parameters:
sql
- ignored- Returns:
- nothing
- Throws:
SQLException
- always
-
close
Does the specialized work required to free this object's resources and that of its parent class.- Specified by:
close
in interfaceAutoCloseable
- Specified by:
close
in interfaceStatement
- Throws:
SQLException
- if a database access error occurs
-
toString
Retrieves a String representation of this object.The representation is of the form:
class-name@hash[sql=[char-sequence], parameters=[p1, ...pi, ...pn]]
p1, ...pi, ...pn are the String representations of the currently set parameter values that will be used with the non-batch execution methods.
-
setURL
Sets the designated parameter to the givenjava.net.URL
value. The driver converts this to an SQLDATALINK
value when it sends it to the database.HSQLDB-Specific Information:
Including 2.0, HSQLDB does not support the DATALINK SQL type for which this method is intended. Calling this method throws an exception.
- Specified by:
setURL
in interfacePreparedStatement
- Parameters:
parameterIndex
- the first parameter is 1, the second is 2, ...x
- thejava.net.URL
object to be set- Throws:
SQLException
- if a database access error occurs or this method is called on a closedPreparedStatement
SQLFeatureNotSupportedException
- if the JDBC driver does not support this method- Since:
- JDK 1.4, HSQL 1.7.0
-
getParameterMetaData
Retrieves the number, types and properties of thisPreparedStatement
object's parameters.HSQLDB-Specific Information:
Since 1.7.2, this feature is supported.
- Specified by:
getParameterMetaData
in interfacePreparedStatement
- Returns:
- a
ParameterMetaData
object that contains information about the number, types and properties for each parameter marker of thisPreparedStatement
object - Throws:
SQLException
- if a database access error occurs or this method is called on a closedPreparedStatement
- Since:
- JDK 1.4, HSQL 1.7.0
- See Also:
-
executeUpdate
Statement methods that must be overridden in this class and throw an exception.- Specified by:
executeUpdate
in interfaceStatement
- Throws:
SQLException
-
execute
- Specified by:
execute
in interfaceStatement
- Throws:
SQLException
-
executeUpdate
- Specified by:
executeUpdate
in interfaceStatement
- Throws:
SQLException
-
execute
- Specified by:
execute
in interfaceStatement
- Throws:
SQLException
-
executeUpdate
- Specified by:
executeUpdate
in interfaceStatement
- Throws:
SQLException
-
execute
- Specified by:
execute
in interfaceStatement
- Throws:
SQLException
-
getMoreResults
Moves to thisStatement
object's next result, deals with any currentResultSet
object(s) according to the instructions specified by the given flag, and returnstrue
if the next result is aResultSet
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 supports this feature.
This is used with CallableStatement objects that return multiple ResultSet objects.
- Specified by:
getMoreResults
in interfaceStatement
- Parameters:
current
- one of the followingStatement
constants indicating what should happen to currentResultSet
objects obtained using the methodgetResultSet
:Statement.CLOSE_CURRENT_RESULT
,Statement.KEEP_CURRENT_RESULT
, orStatement.CLOSE_ALL_RESULTS
- Returns:
true
if the next result is aResultSet
object;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 closedStatement
or the argument supplied is not one of the following:Statement.CLOSE_CURRENT_RESULT
,Statement.KEEP_CURRENT_RESULT
, orStatement.CLOSE_ALL_RESULTS
- Since:
- JDK 1.4, HSQLDB 1.7
- See Also:
-
getGeneratedKeys
Retrieves any auto-generated keys created as a result of executing thisStatement
object. If thisStatement
object did not generate any keys, an emptyResultSet
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 executeUpdate method did not specify the columns which represent the auto-generated keys the IDENTITY column or GENERATED column(s) of the table are returned.
The executeUpdate methods with column indexes or column names return the post-insert or post-update values of the specified columns, whether the columns are generated or not. This allows values that have been modified by execution of triggers to be returned.
If column names or indexes provided by the user in the executeUpdate() method calls do not correspond to table columns (incorrect names or indexes larger than the column count), an empty result is returned.
- Specified by:
getGeneratedKeys
in interfaceStatement
- Returns:
- a
ResultSet
object containing the auto-generated key(s) generated by the execution of thisStatement
object - Throws:
SQLException
- if a database access error occurs or this method is called on a closedStatement
SQLFeatureNotSupportedException
- if the JDBC driver does not support this method- Since:
- JDK 1.4, HSQLDB 1.7
-
getResultSetHoldability
Retrieves the result set holdability forResultSet
objects generated by thisStatement
object.- Specified by:
getResultSetHoldability
in interfaceStatement
- Returns:
- either
ResultSet.HOLD_CURSORS_OVER_COMMIT
orResultSet.CLOSE_CURSORS_AT_COMMIT
- Throws:
SQLException
- if a database access error occurs or this method is called on a closedStatement
- Since:
- JDK 1.4, HSQLDB 1.7
-
isClosed
public boolean isClosed()Retrieves whether thisStatement
object has been closed. AStatement
is closed if the method close has been called on it, or if it is automatically closed. -
setRowId
Sets the designated parameter to the givenjava.sql.RowId
object. The driver converts this to a SQLROWID
value when it sends it to the database- Specified by:
setRowId
in interfacePreparedStatement
- Parameters:
parameterIndex
- the first parameter is 1, the second is 2, ...x
- the parameter value- Throws:
SQLException
- if a database access error occurs or this method is called on a closedPreparedStatement
SQLFeatureNotSupportedException
- if the JDBC driver does not support this method- Since:
- JDK 1.6, HSQLDB 2.0
-
setNString
Sets the designated parameter to the givenString
object. The driver converts this to a SQLNCHAR
orNVARCHAR
orLONGNVARCHAR
value (depending on the argument's size relative to the driver's limits onNVARCHAR
values) when it sends it to the database.- Specified by:
setNString
in interfacePreparedStatement
- Parameters:
parameterIndex
- of the first parameter is 1, the second is 2, ...value
- the parameter value- Throws:
SQLException
- if the driver does not support national character sets; if the driver can detect that a data conversion error could occur ; if a database access error occurs; or this method is called on a closedPreparedStatement
SQLFeatureNotSupportedException
- if the JDBC driver does not support this method- Since:
- JDK 1.6, HSQLDB 2.0
-
setNCharacterStream
Sets the designated parameter to aReader
object. TheReader
reads the data till end-of-file is reached. The driver does the necessary conversion from Java character format to the national character set in the database.- Specified by:
setNCharacterStream
in interfacePreparedStatement
- Parameters:
parameterIndex
- of the first parameter is 1, the second is 2, ...value
- the parameter valuelength
- the number of characters in the parameter data.- Throws:
SQLException
- if the driver does not support national character sets; if the driver can detect that a data conversion error could occur ; if a database access error occurs; or this method is called on a closedPreparedStatement
SQLFeatureNotSupportedException
- if the JDBC driver does not support this method- Since:
- JDK 1.6, HSQLDB 2.0
-
setNClob
Sets the designated parameter to ajava.sql.NClob
object. The driver converts this to a SQLNCLOB
value when it sends it to the database.- Specified by:
setNClob
in interfacePreparedStatement
- Parameters:
parameterIndex
- of the first parameter is 1, the second is 2, ...value
- the parameter value- Throws:
SQLException
- if the driver does not support national character sets; if the driver can detect that a data conversion error could occur ; if a database access error occurs; or this method is called on a closedPreparedStatement
SQLFeatureNotSupportedException
- if the JDBC driver does not support this method- Since:
- JDK 1.6, HSQLDB 2.0
-
setClob
Sets the designated parameter to aReader
object. The reader must contain the number of characters specified by length otherwise aSQLException
will be generated when thePreparedStatement
is executed. This method differs from thesetCharacterStream (int, Reader, int)
method because it informs the driver that the parameter value should be sent to the server as aCLOB
. When thesetCharacterStream
method is used, the driver may have to do extra work to determine whether the parameter data should be sent to the server as aLONGVARCHAR
or aCLOB
- Specified by:
setClob
in interfacePreparedStatement
- Parameters:
parameterIndex
- index of the first parameter is 1, the second is 2, ...reader
- An object that contains the data to set the parameter value to.length
- the number of characters in the parameter data.- Throws:
SQLException
- if a database access error occurs, this method is called on a closedPreparedStatement
, if parameterIndex does not correspond to a parameter marker in the SQL statement, or if the length specified is less than zero.SQLFeatureNotSupportedException
- if the JDBC driver does not support this method- Since:
- JDK 1.6, HSQLDB 2.0
-
setBlob
Sets the designated parameter to aInputStream
object. The input stream must contain the number of characters specified by length otherwise aSQLException
will be generated when thePreparedStatement
is executed. This method differs from thesetBinaryStream (int, InputStream, int)
method because it informs the driver that the parameter value should be sent to the server as aBLOB
. When thesetBinaryStream
method is used, the driver may have to do extra work to determine whether the parameter data should be sent to the server as aLONGVARBINARY
or aBLOB
HSQLDB-Specific Information:
In HSQLDB 2.0, this method uses streaming to send the data when the stream is assigned to a BLOB target. For other binary targets the stream is read on the client side and a byte array is sent.
- Specified by:
setBlob
in interfacePreparedStatement
- Parameters:
parameterIndex
- index of the first parameter is 1, the second is 2, ...inputStream
- An object that contains the data to set the parameter value to.length
- the number of bytes in the parameter data.- Throws:
SQLException
- if a database access error occurs, this method is called on a closedPreparedStatement
, if parameterIndex does not correspond to a parameter marker in the SQL statement, if the length specified is less than zero or if the number of bytes in the input stream does not match the specified length.SQLFeatureNotSupportedException
- if the JDBC driver does not support this method- Since:
- JDK 1.6, HSQLDB 2.0
-
setNClob
Sets the designated parameter to aReader
object. The reader must contain the number of characters specified by length otherwise aSQLException
will be generated when thePreparedStatement
is executed. This method differs from thesetCharacterStream (int, Reader, int)
method because it informs the driver that the parameter value should be sent to the server as aNCLOB
. When thesetCharacterStream
method is used, the driver may have to do extra work to determine whether the parameter data should be sent to the server as aLONGNVARCHAR
or aNCLOB
- Specified by:
setNClob
in interfacePreparedStatement
- Parameters:
parameterIndex
- index of the first parameter is 1, the second is 2, ...reader
- An object that contains the data to set the parameter value to.length
- the number of characters in the parameter data.- Throws:
SQLException
- if parameterIndex does not correspond to a parameter marker in the SQL statement; if the length specified is less than zero; if the driver does not support national character sets; if the driver can detect that a data conversion error could occur; if a database access error occurs or this method is called on a closedPreparedStatement
SQLFeatureNotSupportedException
- if the JDBC driver does not support this method- Since:
- JDK 1.6, HSQLDB 2.0
-
setSQLXML
Sets the designated parameter to the givenjava.sql.SQLXML
object. The driver converts this to an SQLXML
value when it sends it to the database.- Specified by:
setSQLXML
in interfacePreparedStatement
- Parameters:
parameterIndex
- index of the first parameter is 1, the second is 2, ...xmlObject
- aSQLXML
object that maps an SQLXML
value- Throws:
SQLException
- if a database access error occurs, this method is called on a closedPreparedStatement
or thejava.xml.transform.Result
,Writer
orOutputStream
has not been closed for theSQLXML
objectSQLFeatureNotSupportedException
- if the JDBC driver does not support this method- Since:
- JDK 1.6, HSQLDB 2.0
-
setAsciiStream
Sets the designated parameter to the given input stream, which will have the specified number of bytes. When a very large ASCII value is input to aLONGVARCHAR
parameter, it may be more practical to send it via ajava.io.InputStream
. Data will be read from the stream as needed until end-of-file is reached. The JDBC driver will do any necessary conversion from ASCII to the database char format.Note: This stream object can either be a standard Java stream object or your own subclass that implements the standard interface.
HSQLDB-Specific Information:
From HSQLDB 2.0 this method uses the US-ASCII character encoding to convert bytes from the stream into the characters of a String.
This method does not use streaming to send the data, whether the target is a CLOB or other binary object.
For long streams (larger than a few megabytes) with CLOB targets, it is more efficient to use a version of setCharacterStream which takes the a length parameter.
- Specified by:
setAsciiStream
in interfacePreparedStatement
- Parameters:
parameterIndex
- the first parameter is 1, the second is 2, ...x
- the Java input stream that contains the ASCII parameter valuelength
- the number of bytes in the stream- Throws:
SQLException
- if a database access error occurs or this method is called on a closedPreparedStatement
- Since:
- JDK 1.6, HSQLDB 2.0
-
setBinaryStream
Sets the designated parameter to the given input stream, which will have the specified number of bytes. When a very large binary value is input to aLONGVARBINARY
parameter, it may be more practical to send it via ajava.io.InputStream
object. The data will be read from the stream as needed until end-of-file is reached.Note: This stream object can either be a standard Java stream object or your own subclass that implements the standard interface.
HSQLDB-Specific Information:
This method uses streaming to send the data when the stream is assigned to a BLOB target. For other binary targets the stream is read on the client side and a byte array is sent.
- Specified by:
setBinaryStream
in interfacePreparedStatement
- Parameters:
parameterIndex
- the first parameter is 1, the second is 2, ...x
- the java input stream which contains the binary parameter valuelength
- the number of bytes in the stream- Throws:
SQLException
- if a database access error occurs or this method is called on a closedPreparedStatement
- Since:
- JDK 1.6, HSQLDB 2.0
-
setCharacterStream
Sets the designated parameter to the givenReader
object, which is the given number of characters long. When a very large UNICODE value is input to aLONGVARCHAR
parameter, it may be more practical to send it via ajava.io.Reader
object. The data will be read from the stream as needed until end-of-file is reached. The JDBC driver will do any necessary conversion from UNICODE to the database char format.Note: This stream object can either be a standard Java stream object or your own subclass that implements the standard interface.
HSQLDB-Specific Information:
This method uses streaming to send data when the target is a CLOB.
- Specified by:
setCharacterStream
in interfacePreparedStatement
- Parameters:
parameterIndex
- the first parameter is 1, the second is 2, ...reader
- thejava.io.Reader
object that contains the Unicode datalength
- the number of characters in the stream- Throws:
SQLException
- if a database access error occurs or this method is called on a closedPreparedStatement
- Since:
- JDK 1.6, HSQLDB 2.0
-
setAsciiStream
Sets the designated parameter to the given input stream. When a very large ASCII value is input to aLONGVARCHAR
parameter, it may be more practical to send it via ajava.io.InputStream
. Data will be read from the stream as needed until end-of-file is reached. The JDBC driver will do any necessary conversion from ASCII to the database char format.Note: This stream object can either be a standard Java stream object or your own subclass that implements the standard interface.
Note: Consult your JDBC driver documentation to determine if it might be more efficient to use a version of
setAsciiStream
which takes a length parameter.HSQLDB-Specific Information:
In HSQLDB 2.0, this method does not use streaming to send the data, whether the target is a CLOB or other binary object. For long streams (larger than a few megabytes), it is more efficient to use a version of setCharacterStream which takes the a length parameter.
- Specified by:
setAsciiStream
in interfacePreparedStatement
- Parameters:
parameterIndex
- the first parameter is 1, the second is 2, ...x
- the Java input stream that contains the ASCII parameter value- Throws:
SQLException
- if parameterIndex does not correspond to a parameter marker in the SQL statement; if a database access error occurs or this method is called on a closedPreparedStatement
SQLFeatureNotSupportedException
- if the JDBC driver does not support this method- Since:
- 1.6
-
setBinaryStream
Sets the designated parameter to the given input stream. When a very large binary value is input to aLONGVARBINARY
parameter, it may be more practical to send it via ajava.io.InputStream
object. The data will be read from the stream as needed until end-of-file is reached.Note: This stream object can either be a standard Java stream object or your own subclass that implements the standard interface.
Note: Consult your JDBC driver documentation to determine if it might be more efficient to use a version of
setBinaryStream
which takes a length parameter.HSQLDB-Specific Information:
This method does not use streaming to send the data, whether the target is a CLOB or other binary object.
For long streams (larger than a few megabytes) with CLOB targets, it is more efficient to use a version of setCharacterStream which takes the a length parameter.
- Specified by:
setBinaryStream
in interfacePreparedStatement
- Parameters:
parameterIndex
- the first parameter is 1, the second is 2, ...x
- the java input stream which contains the binary parameter value- Throws:
SQLException
- if parameterIndex does not correspond to a parameter marker in the SQL statement; if a database access error occurs or this method is called on a closedPreparedStatement
SQLFeatureNotSupportedException
- if the JDBC driver does not support this method- Since:
- 1.6
-
setCharacterStream
Sets the designated parameter to the givenReader
object. When a very large UNICODE value is input to aLONGVARCHAR
parameter, it may be more practical to send it via ajava.io.Reader
object. The data will be read from the stream as needed until end-of-file is reached. The JDBC driver will do any necessary conversion from UNICODE to the database char format.Note: This stream object can either be a standard Java stream object or your own subclass that implements the standard interface.
Note: Consult your JDBC driver documentation to determine if it might be more efficient to use a version of
setCharacterStream
which takes a length parameter.HSQLDB-Specific Information:
In HSQLDB 2.0, this method does not use streaming to send the data, whether the target is a CLOB or other binary object. For long streams (larger than a few megabytes), it is more efficient to use a version of setCharacterStream which takes the a length parameter.
- Specified by:
setCharacterStream
in interfacePreparedStatement
- Parameters:
parameterIndex
- the first parameter is 1, the second is 2, ...reader
- thejava.io.Reader
object that contains the Unicode data- Throws:
SQLException
- if parameterIndex does not correspond to a parameter marker in the SQL statement; if a database access error occurs or this method is called on a closedPreparedStatement
SQLFeatureNotSupportedException
- if the JDBC driver does not support this method- Since:
- 1.6
-
setNCharacterStream
Sets the designated parameter to aReader
object. TheReader
reads the data till end-of-file is reached. The driver does the necessary conversion from Java character format to the national character set in the database.Note: This stream object can either be a standard Java stream object or your own subclass that implements the standard interface.
Note: Consult your JDBC driver documentation to determine if it might be more efficient to use a version of
setNCharacterStream
which takes a length parameter.- Specified by:
setNCharacterStream
in interfacePreparedStatement
- Parameters:
parameterIndex
- of the first parameter is 1, the second is 2, ...value
- the parameter value- Throws:
SQLException
- if parameterIndex does not correspond to a parameter marker in the SQL statement; if the driver does not support national character sets; if the driver can detect that a data conversion error could occur; if a database access error occurs; or this method is called on a closedPreparedStatement
SQLFeatureNotSupportedException
- if the JDBC driver does not support this method- Since:
- 1.6
-
setClob
Sets the designated parameter to aReader
object. This method differs from thesetCharacterStream (int, Reader)
method because it informs the driver that the parameter value should be sent to the server as aCLOB
. When thesetCharacterStream
method is used, the driver may have to do extra work to determine whether the parameter data should be sent to the server as aLONGVARCHAR
or aCLOB
Note: Consult your JDBC driver documentation to determine if it might be more efficient to use a version of
setClob
which takes a length parameter.- Specified by:
setClob
in interfacePreparedStatement
- Parameters:
parameterIndex
- index of the first parameter is 1, the second is 2, ...reader
- An object that contains the data to set the parameter value to.- Throws:
SQLException
- if parameterIndex does not correspond to a parameter marker in the SQL statement; if a database access error occurs; this method is called on a closedPreparedStatement
or if parameterIndex does not correspond to a parameter marker in the SQL statementSQLFeatureNotSupportedException
- if the JDBC driver does not support this method- Since:
- 1.6
-
setBlob
Sets the designated parameter to aInputStream
object. This method differs from thesetBinaryStream (int, InputStream)
method because it informs the driver that the parameter value should be sent to the server as aBLOB
. When thesetBinaryStream
method is used, the driver may have to do extra work to determine whether the parameter data should be sent to the server as aLONGVARBINARY
or aBLOB
Note: Consult your JDBC driver documentation to determine if it might be more efficient to use a version of
setBlob
which takes a length parameter.- Specified by:
setBlob
in interfacePreparedStatement
- Parameters:
parameterIndex
- index of the first parameter is 1, the second is 2, ...inputStream
- An object that contains the data to set the parameter value to.- Throws:
SQLException
- if parameterIndex does not correspond to a parameter marker in the SQL statement; if a database access error occurs; this method is called on a closedPreparedStatement
or if parameterIndex does not correspond to a parameter marker in the SQL statement,SQLFeatureNotSupportedException
- if the JDBC driver does not support this method- Since:
- 1.6
-
setNClob
Sets the designated parameter to aReader
object. This method differs from thesetCharacterStream (int, Reader)
method because it informs the driver that the parameter value should be sent to the server as aNCLOB
. When thesetCharacterStream
method is used, the driver may have to do extra work to determine whether the parameter data should be sent to the server as aLONGNVARCHAR
or aNCLOB
Note: Consult your JDBC driver documentation to determine if it might be more efficient to use a version of
setNClob
which takes a length parameter.- Specified by:
setNClob
in interfacePreparedStatement
- Parameters:
parameterIndex
- index of the first parameter is 1, the second is 2, ...reader
- An object that contains the data to set the parameter value to.- Throws:
SQLException
- if parameterIndex does not correspond to a parameter marker in the SQL statement; if the driver does not support national character sets; if the driver can detect that a data conversion error could occur; if a database access error occurs or this method is called on a closedPreparedStatement
SQLFeatureNotSupportedException
- if the JDBC driver does not support this method- Since:
- 1.6
-
getMaxFieldSize
Retrieves the maximum number of bytes that can be returned for character and binary column values in aResultSet
object produced by thisStatement
object. This limit applies only toBINARY
,VARBINARY
,LONGVARBINARY
,CHAR
,VARCHAR
, (JDBC4 new:)NCHAR
,NVARCHAR
,LONGNVARCHAR
andLONGVARCHAR
columns. If the limit is exceeded, the excess data is silently discarded.HSQLDB-Specific Information:
HSQLDB always returns zero, meaning there is no limit.
- Specified by:
getMaxFieldSize
in interfaceStatement
- Returns:
- 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 closedStatement
- See Also:
-
setMaxFieldSize
(JDBC4 clarification:) Sets the limit for the maximum number of bytes in aResultSet
Sets the limit for the maximum number of bytes that can be returned for character and binary column values in aResultSet
object produced by thisStatement
object. This limit applies only toBINARY
,VARBINARY
,LONGVARBINARY
,CHAR
,VARCHAR
, (JDBC4 new:)NCHAR
,NVARCHAR
,LONGNVARCHAR
andLONGVARCHAR
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.
- Specified by:
setMaxFieldSize
in interfaceStatement
- Parameters:
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 closedStatement
or the conditionmax >= 0
is not satisfied- See Also:
-
getMaxRows
Retrieves the maximum number of rows that aResultSet
object produced by thisStatement
object can contain. If this limit is exceeded, the excess rows are silently dropped.- Specified by:
getMaxRows
in interfaceStatement
- Returns:
- the current maximum number of rows for a
ResultSet
object produced by thisStatement
object; zero means there is no limit - Throws:
SQLException
- if a database access error occurs or this method is called on a closedStatement
- See Also:
-
setMaxRows
(JDBC4 clarification:) Sets the limit for the maximum number of rows that anyResultSet
object generated by thisStatement
object can contain to the given number. If the limit is exceeded, the excess rows are silently dropped.- Specified by:
setMaxRows
in interfaceStatement
- Parameters:
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 closedStatement
or the conditionmax >= 0
is not satisfied- See Also:
-
getQueryTimeout
Retrieves the number of seconds the driver will wait for aStatement
object to execute. If the limit is exceeded, aSQLException
is thrown.HSQLDB-Specific Information:
To present, HSQLDB always returns zero, meaning there is no limit.
- Specified by:
getQueryTimeout
in interfaceStatement
- Returns:
- 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 closedStatement
- See Also:
-
setQueryTimeout
Sets the number of seconds the driver will wait for aStatement
object to execute to the given number of seconds. If the limit is exceeded, anSQLException
is thrown. A JDBC (JDBC4 clarification:) driver must apply this limit to theexecute
,executeQuery
andexecuteUpdate
methods. JDBC driver implementations may also apply this limit toResultSet
methods (consult your driver vendor documentation for details).HSQLDB-Specific Information:
The maximum number of seconds to wait is 32767.
- Specified by:
setQueryTimeout
in interfaceStatement
- Parameters:
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 closedStatement
or the conditionseconds >= 0
is not satisfied- See Also:
-
cancel
Cancels thisStatement
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.
- Specified by:
cancel
in interfaceStatement
- Throws:
SQLException
- if a database access error occurs or this method is called on a closedStatement
SQLFeatureNotSupportedException
- if the JDBC driver does not support this method
-
getWarnings
Retrieves the first warning reported by calls on thisStatement
object. SubsequentStatement
object warnings will be chained to thisSQLWarning
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 anSQLException
to be thrown.Note: If you are processing a
ResultSet
object, any warnings associated with reads on thatResultSet
object will be chained on it rather than on theStatement
object that produced it.HSQLDB-Specific Information:
From 1.9 HSQLDB, produces Statement warnings.
- Specified by:
getWarnings
in interfaceStatement
- Returns:
- the first
SQLWarning
object ornull
if there are no warnings - Throws:
SQLException
- if a database access error occurs or this method is called on a closedStatement
-
clearWarnings
Clears all the warnings reported on thisStatement
object. After a call to this method, the methodgetWarnings
will returnnull
until a new warning is reported for thisStatement
object.HSQLDB-Specific Information:
Supported in HSQLDB 1.9.
- Specified by:
clearWarnings
in interfaceStatement
- Throws:
SQLException
- if a database access error occurs or this method is called on a closedStatement
-
setCursorName
Sets the SQL cursor name to the givenString
, which will be used by subsequentStatement
objectexecute
methods. This name can then be used in SQL positioned update or delete statements to identify the current row in theResultSet
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'sSELECT
statement should have the formSELECT FOR UPDATE
. IfFOR 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 theResultSet
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.
- Specified by:
setCursorName
in interfaceStatement
- Parameters:
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 closedStatement
SQLFeatureNotSupportedException
- if the JDBC driver does not support this method
-
getResultSet
Retrieves the current result as aResultSet
object. This method should be called only once per result.HSQLDB-Specific Information:
Without an interceding call to executeXXX, each invocation of this method will produce a new, initialized ResultSet instance referring to the current result, if any.
- Specified by:
getResultSet
in interfaceStatement
- Returns:
- the current result as a
ResultSet
object ornull
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 closedStatement
- See Also:
-
getUpdateCount
Retrieves the current result as an update count; if the result is aResultSet
object or there are no more results, -1 is returned. This method should be called only once per result.- Specified by:
getUpdateCount
in interfaceStatement
- Returns:
- the current result as an update count; -1 if the current result is a
ResultSet
object or there are no more results - Throws:
SQLException
- if a database access error occurs or this method is called on a closedStatement
- See Also:
-
getMoreResults
Moves to thisStatement
object's next result, returnstrue
if it is aResultSet
object, and implicitly closes any currentResultSet
object(s) obtained with the methodgetResultSet
.There are no more results when the following is true:
// stmt is a Statement object ((stmt.getMoreResults() == false) && (stmt.getUpdateCount() == -1))
- Specified by:
getMoreResults
in interfaceStatement
- Returns:
true
if the next result is aResultSet
object;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 closedStatement
- See Also:
-
setFetchDirection
Gives the driver a hint as to the direction in which rows will be processed inResultSet
objects created using thisStatement
object. The default value isResultSet.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:
Up to 1.8.0.x, HSQLDB supports only
FETCH_FORWARD
; Setting any other value would throw anSQLException
stating that the operation is not supported.Starting with 2.0, HSQLDB accepts any valid value.
- Specified by:
setFetchDirection
in interfaceStatement
- Parameters:
direction
- the initial direction for processing rows- Throws:
SQLException
- if a database access error occurs, this method is called on a closedStatement
or the given direction is not one ofResultSet.FETCH_FORWARD
,ResultSet.FETCH_REVERSE
, orResultSet.FETCH_UNKNOWN
- Since:
- JDK 1.2
- See Also:
-
getFetchDirection
Retrieves the direction for fetching rows from database tables that is the default for result sets generated from thisStatement
object. If thisStatement
object has not set a fetch direction by calling the methodsetFetchDirection
, the return value is implementation-specific.HSQLDB-Specific Information:
Up to 1.8.0.x, HSQLDB always returned FETCH_FORWARD. Starting with 2.0, HSQLDB returns FETCH_FORWARD by default, or whatever value has been explicitly assigned by invoking
setFetchDirection
. .- Specified by:
getFetchDirection
in interfaceStatement
- Returns:
- the default fetch direction for result sets generated
from this
Statement
object - Throws:
SQLException
- if a database access error occurs or this method is called on a closedStatement
- Since:
- JDK 1.2
- See Also:
-
setFetchSize
(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 forResultSet
objects generated by thisStatement
. 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.
- Specified by:
setFetchSize
in interfaceStatement
- Parameters:
rows
- the number of rows to fetch- Throws:
SQLException
- if a database access error occurs, this method is called on a closedStatement
or the (JDBC4 modified:) condition<code>rows >= 0</code>
is not satisfied.- Since:
- JDK 1.2
- See Also:
-
getFetchSize
Retrieves the number of result set rows that is the default fetch size forResultSet
objects generated from thisStatement
object. If thisStatement
object has not set a fetch size by calling the methodsetFetchSize
, the return value is implementation-specific.HSQLDB-Specific InformationHSQLDB returns 0 by default, or the fetch size specified by setFetchSize
- Specified by:
getFetchSize
in interfaceStatement
- Returns:
- the default fetch size for result sets generated
from this
Statement
object - Throws:
SQLException
- if a database access error occurs or this method is called on a closedStatement
- Since:
- JDK 1.2
- See Also:
-
getResultSetConcurrency
Retrieves the result set concurrency forResultSet
objects generated by thisStatement
object.HSQLDB-Specific Information:
HSQLDB supports
CONCUR_READ_ONLY
andCONCUR_READ_UPDATEBLE
concurrency.- Specified by:
getResultSetConcurrency
in interfaceStatement
- Returns:
- either
ResultSet.CONCUR_READ_ONLY
orResultSet.CONCUR_UPDATABLE
- Throws:
SQLException
- if a database access error occurs or this method is called on a closedStatement
- Since:
- JDK 1.2
-
getResultSetType
Retrieves the result set type forResultSet
objects generated by thisStatement
object.HSQLDB-Specific Information:
HSQLDB 1.7.0 and later versions support
TYPE_FORWARD_ONLY
andTYPE_SCROLL_INSENSITIVE
.- Specified by:
getResultSetType
in interfaceStatement
- Returns:
- one of
ResultSet.TYPE_FORWARD_ONLY
,ResultSet.TYPE_SCROLL_INSENSITIVE
, orResultSet.TYPE_SCROLL_SENSITIVE
- Throws:
SQLException
- if a database access error occurs or this method is called on a closedStatement
- Since:
- JDK 1.2
-
clearBatch
Empties thisStatement
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.
- Specified by:
clearBatch
in interfaceStatement
- Throws:
SQLException
- if a database access error occurs, this method is called on a closedStatement
or the driver does not support batch updates- Since:
- JDK 1.2
- See Also:
-
getConnection
Retrieves theConnection
object that produced thisStatement
object.- Specified by:
getConnection
in interfaceStatement
- Returns:
- the connection that produced this statement
- Throws:
SQLException
- if a database access error occurs or this method is called on a closedStatement
- Since:
- JDK 1.2
-
setPoolable
Requests that aStatement
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 aPreparedStatement
andCallableStatement
are poolable when created.- Specified by:
setPoolable
in interfaceStatement
- Parameters:
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 closedStatement
- Since:
- JDK 1.6, HSQLDB 2.0
-
isPoolable
Returns a value indicating whether theStatement
is poolable or not.- Specified by:
isPoolable
in interfaceStatement
- Returns:
true
if theStatement
is poolable;false
otherwise- Throws:
SQLException
- if this method is called on a closedStatement
- Since:
- JDK 1.6, HSQLDB 2.0
- See Also:
-
unwrap
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 callingunwrap
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 anSQLException
is thrown.- Specified by:
unwrap
in interfaceWrapper
- Parameters:
iface
- A Class defining an interface that the result must implement.- Returns:
- an object that implements the interface. May be a proxy for the actual implementing object.
- Throws:
SQLException
- If no object found that implements the interface- Since:
- JDK 1.6, HSQLDB 2.0
-
isWrapperFor
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 callingisWrapperFor
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 tounwrap
so that callers can use this method to avoid expensiveunwrap
calls that may fail. If this method returns true then callingunwrap
with the same argument should succeed.- Specified by:
isWrapperFor
in interfaceWrapper
- Parameters:
iface
- a Class defining an interface.- Returns:
- true if this implements the interface or directly or indirectly wraps an object that does.
- Throws:
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
-
getLargeUpdateCount
Retrieves the current result as an update count; if the result is aResultSet
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
- Specified by:
getLargeUpdateCount
in interfaceStatement
- Returns:
- the current result as an update count; -1 if the current result
is a
ResultSet
object or there are no more results - Throws:
SQLException
- if a database access error occurs or this method is called on a closedStatement
- Since:
- 1.8
- See Also:
-
setLargeMaxRows
Sets the limit for the maximum number of rows that anyResultSet
object generated by thisStatement
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
- Specified by:
setLargeMaxRows
in interfaceStatement
- Parameters:
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 closedStatement
or the conditionmax >= 0
is not satisfied- Since:
- 1.8
- See Also:
-
getLargeMaxRows
Retrieves the maximum number of rows that aResultSet
object produced by thisStatement
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
- Specified by:
getLargeMaxRows
in interfaceStatement
- Returns:
- the current maximum number of rows for a
ResultSet
object produced by thisStatement
object; zero means there is no limit - Throws:
SQLException
- if a database access error occurs or this method is called on a closedStatement
- Since:
- 1.8
- See Also:
-
executeLargeBatch
Submits a batch of commands to the database for execution and if all commands execute successfully, returns an array of update counts. Thelong
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 methodexecuteLargeBatch
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 unknownIf 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 methodBatchUpdateException.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
- Specified by:
executeLargeBatch
in interfaceStatement
- 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.
- Throws:
SQLException
- if a database access error occurs, this method is called on a closedStatement
or the driver does not support batch statements. ThrowsBatchUpdateException
(a subclass ofSQLException
) 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 thesetQueryTimeout
method has been exceeded and has at least attempted to cancel the currently runningStatement
- Since:
- 1.8
- See Also:
-
setObject
public void setObject(int parameterIndex, Object x, SQLType targetSqlType, int scaleOrLength) throws SQLException Sets the value of the designated parameter with the given object. If the second argument is an
InputStream
then the stream must contain the number of bytes specified by scaleOrLength. If the second argument is aReader
then the reader must contain the number of characters specified by scaleOrLength. If these conditions are not true the driver will generate aSQLException
when the prepared statement is executed.The given Java object will be converted to the given targetSqlType before being sent to the database. If the object has a custom mapping (is of a class implementing the interface
SQLData
), the JDBC driver should call the methodSQLData.writeSQL
to write it to the SQL data stream. If, on the other hand, the object is of a class implementingRef
,Blob
,Clob
,NClob
,Struct
,java.net.URL
, orArray
, the driver should pass it to the database as a value of the corresponding SQL type.Note that this method may be used to pass database-specific abstract data types.
The default implementation will throw
SQLFeatureNotSupportedException
- Specified by:
setObject
in interfacePreparedStatement
- Parameters:
parameterIndex
- the first parameter is 1, the second is 2, ...x
- the object containing the input parameter valuetargetSqlType
- the SQL type to be sent to the database. The scale argument may further qualify this type.scaleOrLength
- forjava.sql.JDBCType.DECIMAL
orjava.sql.JDBCType.NUMERIC types
, this is the number of digits after the decimal point. For Java Object typesInputStream
andReader
, this is the length of the data in the stream or reader. For all other types, this value will be ignored.- Throws:
SQLException
- if parameterIndex does not correspond to a parameter marker in the SQL statement; if a database access error occurs or this method is called on a closedPreparedStatement
or if the Java Object specified by x is an InputStream or Reader object and the value of the scale parameter is less than zeroSQLFeatureNotSupportedException
- if the JDBC driver does not support the specified targetSqlType- Since:
- 1.8
- See Also:
-
setObject
Sets the value of the designated parameter with the given object. This method is similar tosetObject(int parameterIndex, Object x, SQLType targetSqlType, int scaleOrLength)
, except that it assumes a scale of zero.The default implementation will throw
SQLFeatureNotSupportedException
- Specified by:
setObject
in interfacePreparedStatement
- Parameters:
parameterIndex
- the first parameter is 1, the second is 2, ...x
- the object containing the input parameter valuetargetSqlType
- the SQL type to be sent to the database- Throws:
SQLException
- if parameterIndex does not correspond to a parameter marker in the SQL statement; if a database access error occurs or this method is called on a closedPreparedStatement
SQLFeatureNotSupportedException
- if the JDBC driver does not support the specified targetSqlType- Since:
- 1.8
- See Also:
-
executeLargeUpdate
Executes the SQL statement in thisPreparedStatement
object, which must be an SQL Data Manipulation Language (DML) statement, such asINSERT
,UPDATE
orDELETE
; or an SQL statement that returns nothing, such as a DDL statement.This method should be used when the returned row count may exceed
Integer.MAX_VALUE
.The default implementation will throw
UnsupportedOperationException
- Specified by:
executeLargeUpdate
in interfacePreparedStatement
- Returns:
- 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 closedPreparedStatement
or the SQL statement returns aResultSet
objectSQLTimeoutException
- when the driver has determined that the timeout value that was specified by thesetQueryTimeout
method has been exceeded and has at least attempted to cancel the currently runningStatement
- Since:
- 1.8
-
getSQL
-
getStatementID
public long getStatementID() -
isRowCount
public boolean isRowCount() -
getResultSetMetaData
-
getParameterMetaDataDirect
public org.hsqldb.result.ResultMetaData getParameterMetaDataDirect() -
closeOnCompletion
Specifies that thisStatement
will be closed when all its dependent result sets are closed. If execution of theStatement
does not produce any result sets, this method has no effect.Note: Multiple calls to
closeOnCompletion
do not toggle the effect on thisStatement
. However, a call tocloseOnCompletion
does effect both the subsequent execution of statements, and statements that currently have open, dependent, result sets.- Throws:
SQLException
- if this method is called on a closedStatement
- Since:
- JDK 1.7 M11 2010/09/10 (b123), HSQLDB 2.0.1
-
isCloseOnCompletion
Returns a value indicating whether thisStatement
will be closed when all its dependent result sets are closed.- Returns:
true
if theStatement
will be closed when all of its dependent result sets are closed;false
otherwise- Throws:
SQLException
- if this method is called on a closedStatement
- Since:
- JDK 1.7 M11 2010/09/10 (b123), HSQLDB 2.0.1
-