Class jdbcPreparedStatement
- All Implemented Interfaces:
AutoCloseable, PreparedStatement, Statement, Wrapper
- Direct Known Subclasses:
jdbcCallableStatement
An SQL statement is precompiled and stored in a
PreparedStatement object. This object can then be used to
efficiently execute this statement multiple times.
Note: The setter methods (setShort,
setString, and so on) for setting IN parameter values
must specify types that are compatible with the defined SQL type of
the input parameter. For instance, if the IN parameter has SQL type
INTEGER, then the method setInt should be
used.
If arbitrary parameter type conversions are required, the method
setObject should be used with a target SQL type.
In the following example of setting a parameter, con
represents an active connection:
PreparedStatement pstmt = con.prepareStatement("UPDATE EMPLOYEES
SET SALARY = ? WHERE ID = ?");
pstmt.setBigDecimal(1, 153833.00)
pstmt.setInt(2, 110592)
HSQLDB-Specific Information:
Starting with HSQLDB 1.7.2, jdbcPreparedStatement objects are backed by a true compiled parameteric representation. Hence, there are now significant performance gains to be had by using a jdbcPreparedStatement object in preference to a jdbcStatement object, if a short-running SQL statement is to be executed more than a small number of times.
When it can be otherwise avoided, it is to be considered poor practice to fully prepare (construct), parameterize, execute, fetch and close a jdbcPreparedStatement object for each execution cycle. Indeed, under HSQLDB 1.8.0, this practice is likely to be noticably less performant 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 identifing 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.
Multi thread use:
A PreparedStatement object is stateful and should not normally be shared by multiple threads. If it has to be shared, the calls to set the parameters, calls to add batch statements, the execute call and any post-execute calls should be made within a block synchronized on the PreparedStatement Object.
JRE 1.1.x Notes:
In general, JDBC 2 support requires Java 1.2 and above, and JDBC3 requires Java 1.4 and above. In HSQLDB, support for methods introduced in different versions of JDBC depends on the JDK version used for compiling and building HSQLDB.
Since 1.7.0, it is possible to build the product so that
all JDBC 2 methods can be called while executing under the version 1.1.x
Java Runtime EnvironmentTM.
However, in addition to requiring explicit casts to the org.hsqldb.jdbcXXX
interface implementations, some of these method calls require
int values that are defined only in the JDBC 2 or greater
version of
ResultSet interface. For this reason, when the
product is compiled under JDK 1.1.x, these values are defined in
jdbcResultSet.
In a JRE 1.1.x environment, calling JDBC 2 methods that take or return the
JDBC2-only ResultSet values can be achieved by referring
to them in parameter specifications and return value comparisons,
respectively, as follows:
jdbcResultSet.FETCH_FORWARD jdbcResultSet.TYPE_FORWARD_ONLY jdbcResultSet.TYPE_SCROLL_INSENSITIVE jdbcResultSet.CONCUR_READ_ONLY // etc.However, please note that code written in such a manner will not be compatible for use with other JDBC 2 drivers, since they expect and use
ResultSet, rather than jdbcResultSet. Also
note, this feature is offered solely as a convenience to developers
who must work under JDK 1.1.x due to operating constraints, yet wish to
use some of the more advanced features available under the JDBC 2
specification.
(fredt@users)
(boucherb@users)
- Author:
- boucherb@users, fredt@users
- See Also:
-
Field Summary
Fields inherited from interface 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 TypeMethodDescriptionvoidaddBatch()Adds a set of parameters to thisPreparedStatementobject's batch of commands.voidThis method should always throw if called for a PreparedStatement or CallableStatment.voidClears the current parameter values immediately.voidclose()Does the specialized work required to free this object's resources and that of it's parent class.booleanexecute()Executes the SQL statement in thisPreparedStatementobject, which may be any kind of SQL statement.booleanThis method should always throw if called for a PreparedStatement or CallableStatment.int[]Submits a batch of commands to the database for execution and if all commands execute successfully, returns an array of update counts.Executes the SQL query in thisPreparedStatementobject and returns theResultSetobject generated by the query.executeQuery(String sql) This method should always throw if called for a PreparedStatement or CallableStatment.intExecutes the SQL statement in thisPreparedStatementobject, which must be an SQLINSERT,UPDATEorDELETEstatement; or an SQL statement that returns nothing, such as a DDL statement.intexecuteUpdate(String sql) This method should always throw if called for a PreparedStatement or CallableStatment.Retrieves aResultSetMetaDataobject that contains information about the columns of theResultSetobject that will be returned when thisPreparedStatementobject is executed.Retrieves the number, types and properties of thisPreparedStatementobject's parameters.booleanbooleanisWrapperFor(Class<?> iface) voidSets the designated parameter to the givenArrayobject.voidsetAsciiStream(int parameterIndex, InputStream x) voidsetAsciiStream(int parameterIndex, InputStream x, int length) Sets the designated parameter to the given input stream, which will have the specified number of bytes.voidsetAsciiStream(int parameterIndex, InputStream x, long length) voidsetBigDecimal(int parameterIndex, BigDecimal x) Sets the designated parameter to the givenjava.math.BigDecimalvalue.voidsetBinaryStream(int parameterIndex, InputStream x) voidsetBinaryStream(int parameterIndex, InputStream x, int length) Sets the designated parameter to the given input stream, which will have the specified number of bytes.voidsetBinaryStream(int parameterIndex, InputStream x, long length) voidsetBlob(int parameterIndex, InputStream inputStream) voidsetBlob(int parameterIndex, InputStream inputStream, long length) voidSets the designated parameter to the givenBlobobject.voidsetBoolean(int parameterIndex, boolean x) Sets the designated parameter to the given Javabooleanvalue.voidsetByte(int parameterIndex, byte x) Sets the designated parameter to the given Javabytevalue.voidsetBytes(int paramIndex, byte[] x) Sets the designated parameter to the given Java array of bytes.voidsetCharacterStream(int parameterIndex, Reader reader) voidsetCharacterStream(int parameterIndex, Reader reader, int length) Sets the designated parameter to the givenReaderobject, which is the given number of characters long.voidsetCharacterStream(int parameterIndex, Reader reader, long length) voidvoidvoidSets the designated parameter to the givenClobobject.voidSets the designated parameter to the givenjava.sql.Datevalue.voidSets the designated parameter to the givenjava.sql.Datevalue, using the givenCalendarobject.voidsetDouble(int parameterIndex, double x) Sets the designated parameter to the given Javadoublevalue.voidsetEscapeProcessing(boolean enable) Sets escape processing on or off.voidsetFloat(int parameterIndex, float x) Sets the designated parameter to the given Javafloatvalue.voidsetInt(int parameterIndex, int x) Sets the designated parameter to the given Javaintvalue.voidsetLong(int parameterIndex, long x) Sets the designated parameter to the given Javalongvalue.voidsetNCharacterStream(int parameterIndex, Reader value) voidsetNCharacterStream(int parameterIndex, Reader value, long length) voidvoidvoidvoidsetNString(int parameterIndex, String value) voidsetNull(int paramIndex, int sqlType) Sets the designated parameter to SQLNULL.voidSets the designated parameter to SQLNULL.voidSets the value of the designated parameter using the given object.voidSets the value of the designated parameter with the given object.voidSets the value of the designated parameter with the given object.voidsetPoolable(boolean poolable) voidSets the designated parameter to the givenREF(<structured-type>)value.voidvoidsetShort(int parameterIndex, short x) Sets the designated parameter to the given Javashortvalue.voidvoidSets the designated parameter to the given JavaStringvalue.voidSets the designated parameter to the givenjava.sql.Timevalue.voidSets the designated parameter to the givenjava.sql.Timevalue, using the givenCalendarobject.voidsetTimestamp(int parameterIndex, Timestamp x) Sets the designated parameter to the givenjava.sql.Timestampvalue.voidsetTimestamp(int parameterIndex, Timestamp x, Calendar cal) Sets the designated parameter to the givenjava.sql.Timestampvalue, using the givenCalendarobject.voidsetUnicodeStream(int parameterIndex, InputStream x, int length) Deprecated.Sun does not include a reason, but presumably this is because setCharacterStream is now preferedvoidSets the designated parameter to the givenjava.net.URLvalue.toString()Retrieves a String representation of this object.<T> TMethods inherited from class jdbcStatement
cancel, clearBatch, clearWarnings, closeOnCompletion, execute, execute, execute, executeUpdate, executeUpdate, executeUpdate, getConnection, getFetchDirection, getFetchSize, getGeneratedKeys, getMaxFieldSize, getMaxRows, getMoreResults, getMoreResults, getQueryTimeout, getResultSet, getResultSetConcurrency, getResultSetHoldability, getResultSetType, getUpdateCount, getWarnings, isClosed, isCloseOnCompletion, setCursorName, setFetchDirection, setFetchSize, setMaxFieldSize, setMaxRows, setQueryTimeoutMethods inherited from interface PreparedStatement
executeLargeUpdate, setObject, setObjectMethods inherited from interface Statement
cancel, clearBatch, clearWarnings, closeOnCompletion, enquoteIdentifier, enquoteLiteral, enquoteNCharLiteral, execute, execute, execute, executeLargeBatch, executeLargeUpdate, executeLargeUpdate, executeLargeUpdate, executeLargeUpdate, executeUpdate, executeUpdate, executeUpdate, getConnection, getFetchDirection, getFetchSize, getGeneratedKeys, getLargeMaxRows, getLargeUpdateCount, getMaxFieldSize, getMaxRows, getMoreResults, getMoreResults, getQueryTimeout, getResultSet, getResultSetConcurrency, getResultSetHoldability, getResultSetType, getUpdateCount, getWarnings, isClosed, isCloseOnCompletion, isSimpleIdentifier, setCursorName, setFetchDirection, setFetchSize, setLargeMaxRows, setMaxFieldSize, setMaxRows, setQueryTimeout
-
Method Details
-
setEscapeProcessing
Sets escape processing on or off.HSQLDB-Specific Information:
Since 1.7.0, the implementation follows the standard behaviour by overriding the same method in jdbcStatement class.
In other words, calling this method has no effect.
- Specified by:
setEscapeProcessingin interfaceStatement- Overrides:
setEscapeProcessingin classjdbcStatement- Parameters:
enable-trueto enable escape processing;falseto disable it- Throws:
SQLException- if a database access error occurs
-
execute
Executes the SQL statement in thisPreparedStatementobject, which may be any kind of SQL statement. Some prepared statements return multiple results; theexecutemethod handles these complex statements as well as the simpler form of statements handled by the methodsexecuteQueryandexecuteUpdate.The
executemethod returns abooleanto indicate the form of the first result. You must call either the methodgetResultSetorgetUpdateCountto retrieve the result; you must callgetMoreResultsto move to any subsequent result(s).HSQLDB-Specific Information:
Including 1.8.0, prepared statements do not generate multiple fetchable results.
In future versions, it will be possible that statements generate multiple fetchable results under certain conditions.
- Specified by:
executein interfacePreparedStatement- Returns:
trueif the first result is aResultSetobject;falseif the first result is an update count or there is no result- Throws:
SQLException- if a database access error occurs or an argument is supplied to this method- See Also:
-
executeQuery
Executes the SQL query in thisPreparedStatementobject and returns theResultSetobject generated by the query.- Specified by:
executeQueryin interfacePreparedStatement- Returns:
- a
ResultSetobject that contains the data produced by the query; nevernull - Throws:
SQLException- if a database access error occurs or the SQL statement does not return aResultSetobject
-
executeUpdate
Executes the SQL statement in thisPreparedStatementobject, which must be an SQLINSERT,UPDATEorDELETEstatement; or an SQL statement that returns nothing, such as a DDL statement.- Specified by:
executeUpdatein interfacePreparedStatement- Returns:
- either (1) the row count for
INSERT,UPDATE, orDELETEstatements or (2) 0 for SQL statements that return nothing - Throws:
SQLException- if a database access error occurs or the SQL statement returns aResultSetobject
-
executeBatch
Submits a batch of commands to the database for execution and if all commands execute successfully, returns an array of update counts. Theintelements 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 methodexecuteBatchmay 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.getUpdateCountswill 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 proccess commands in a batch update after a
BatchUpdateExceptionobejct 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.
When the product is built under the JAVA1 target, an exception is never thrown and it is the responsibility of the client software to check the size of the returned update count array to determine if any batch items failed. To build and run under the JAVA2 target, JDK/JRE 1.3 or higher must be used.
- Specified by:
executeBatchin interfaceStatement- Overrides:
executeBatchin classjdbcStatement- 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 or the driver does not support batch statements. ThrowsBatchUpdateException(a subclass ofjava.sql.SQLException) if one of the commands sent to the database fails to execute properly or attempts to return a result set.- Since:
- JDK 1.3 (JDK 1.1.x developers: read the new overview for jdbcStatement)
-
setNull
Sets the designated parameter to SQLNULL.Note: You must specify the parameter's SQL type.
HSQLDB-Specific Information:
HSQLDB ignores the sqlType argument.
- Specified by:
setNullin interfacePreparedStatement- Parameters:
paramIndex- 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
-
setBoolean
Sets the designated parameter to the given Javabooleanvalue. The driver converts this to an SQLBITvalue when it sends it to the database.HSQLDB-Specific Information:
Since 1.7.2, HSQLDB uses the BOOLEAN type instead of BIT, as per SQL 200n (SQL 3).
- Specified by:
setBooleanin interfacePreparedStatement- Parameters:
parameterIndex- the first parameter is 1, the second is 2, ...x- the parameter value- Throws:
SQLException- if a database access error occurs
-
setByte
Sets the designated parameter to the given Javabytevalue. The driver converts this to an SQLTINYINTvalue when it sends it to the database.- Specified by:
setBytein interfacePreparedStatement- Parameters:
parameterIndex- the first parameter is 1, the second is 2, ...x- the parameter value- Throws:
SQLException- if a database access error occurs
-
setShort
Sets the designated parameter to the given Javashortvalue. The driver converts this to an SQLSMALLINTvalue when it sends it to the database.- Specified by:
setShortin interfacePreparedStatement- Parameters:
parameterIndex- the first parameter is 1, the second is 2, ...x- the parameter value- Throws:
SQLException- if a database access error occurs
-
setInt
Sets the designated parameter to the given Javaintvalue. The driver converts this to an SQLINTEGERvalue when it sends it to the database.- Specified by:
setIntin interfacePreparedStatement- Parameters:
parameterIndex- the first parameter is 1, the second is 2, ...x- the parameter value- Throws:
SQLException- if a database access error occurs
-
setLong
Sets the designated parameter to the given Javalongvalue. The driver converts this to an SQLBIGINTvalue when it sends it to the database.- Specified by:
setLongin interfacePreparedStatement- Parameters:
parameterIndex- the first parameter is 1, the second is 2, ...x- the parameter value- Throws:
SQLException- if a database access error occurs
-
setFloat
Sets the designated parameter to the given Javafloatvalue. The driver converts this to an SQLFLOATvalue when it sends it to the database.HSQLDB-Specific Information:
Since 1.7.1, HSQLDB handles Java positive/negative Infinity and NaN
floatvalues consistent with the Java Language Specification; these special values are now correctly stored to and retrieved from the database.- Specified by:
setFloatin interfacePreparedStatement- Parameters:
parameterIndex- the first parameter is 1, the second is 2, ...x- the parameter value- Throws:
SQLException- if a database access error occurs
-
setDouble
Sets the designated parameter to the given Javadoublevalue. The driver converts this to an SQLDOUBLEvalue when it sends it to the database.HSQLDB-Specific Information:
Since 1.7.1, HSQLDB handles Java positive/negative Infinity and NaN
doublevalues consistent with the Java Language Specification; these special values are now correctly stored to and retrieved from the database.- Specified by:
setDoublein interfacePreparedStatement- Parameters:
parameterIndex- the first parameter is 1, the second is 2, ...x- the parameter value- Throws:
SQLException- if a database access error occurs
-
setBigDecimal
Sets the designated parameter to the givenjava.math.BigDecimalvalue. The driver converts this to an SQLNUMERICvalue when it sends it to the database.- Specified by:
setBigDecimalin interfacePreparedStatement- Parameters:
parameterIndex- the first parameter is 1, the second is 2, ...x- the parameter value- Throws:
SQLException- if a database access error occurs
-
setString
Sets the designated parameter to the given JavaStringvalue. The driver converts this to an SQLVARCHARorLONGVARCHARvalue (depending on the argument's size relative to the driver's limits onVARCHARvalues) when it sends it to the database.HSQLDB-Specific Information:
Including 1.7.2, HSQLDB stores all XXXCHAR values as java.lang.String objects; there is no appreciable difference between CHAR, VARCHAR and LONGVARCHAR.
- Specified by:
setStringin interfacePreparedStatement- Parameters:
parameterIndex- the first parameter is 1, the second is 2, ...x- the parameter value- Throws:
SQLException- if a database access error occurs
-
setBytes
Sets the designated parameter to the given Java array of bytes. The driver converts this to an SQLVARBINARYorLONGVARBINARY(depending on the argument's size relative to the driver's limits onVARBINARYvalues) when it sends it to the database.HSQLDB-Specific Information:
Including 1.7.2, HSQLDB stores all XXXBINARY values the same way; there is no appreciable difference between BINARY, VARBINARY and LONGVARBINARY.
- Specified by:
setBytesin interfacePreparedStatement- Parameters:
paramIndex- the first parameter is 1, the second is 2, ...x- the parameter value- Throws:
SQLException- if a database access error occurs
-
setDate
Sets the designated parameter to the givenjava.sql.Datevalue. The driver converts this to an SQLDATEvalue when it sends it to the database.- Specified by:
setDatein interfacePreparedStatement- Parameters:
parameterIndex- the first parameter is 1, the second is 2, ...x- the parameter value- Throws:
SQLException- if a database access error occurs
-
setTime
Sets the designated parameter to the givenjava.sql.Timevalue. The driver converts this to an SQLTIMEvalue when it sends it to the database.- Specified by:
setTimein interfacePreparedStatement- Parameters:
parameterIndex- the first parameter is 1, the second is 2, ...x- the parameter value- Throws:
SQLException- if a database access error occurs
-
setTimestamp
Sets the designated parameter to the givenjava.sql.Timestampvalue. The driver converts this to an SQLTIMESTAMPvalue when it sends it to the database.- Specified by:
setTimestampin interfacePreparedStatement- Parameters:
parameterIndex- the first parameter is 1, the second is 2, ...x- the parameter value- Throws:
SQLException- if a database access error occurs
-
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 aLONGVARCHARparameter, 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:
This method uses the default platform character encoding to convert bytes from the stream into the characters of a String. In the future this is likely to change to always treat the stream as ASCII.
Before HSQLDB 1.7.0,
setAsciiStreamandsetUnicodeStreamwere identical.- Specified by:
setAsciiStreamin 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
-
setUnicodeStream
Deprecated.Sun does not include a reason, but presumably this is because setCharacterStream is now preferedSets the designated parameter to the given input stream, which will have the specified number of bytes. 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 aLONGVARCHARparameter, it may be more practical to send it via ajava.io.InputStreamobject. 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:
Since 1.7.0, this method complies with behavior as defined by the JDBC3 specification.
- Specified by:
setUnicodeStreamin interfacePreparedStatement- Parameters:
parameterIndex- the first parameter is 1, the second is 2, ...x- ajava.io.InputStreamobject that contains the Unicode parameter value as two-byte Unicode characterslength- the number of bytes in the stream- Throws:
SQLException- if a database access error occurs
-
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 aLONGVARBINARYparameter, it may be more practical to send it via ajava.io.InputStreamobject. 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:
setBinaryStreamin 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
-
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:
clearParametersin interfacePreparedStatement- Throws:
SQLException- if a database access error occurs
-
setObject
public void setObject(int parameterIndex, Object x, int targetSqlType, int scale) 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.langequivalent objects should be used.The given Java object will be converted to the given targetSqlType before being sent to the database. If the object has a custom mapping (is of a class implementing the interface
SQLData), the JDBC driver should call the methodSQLData.writeSQLto write it to the SQL data stream. If, on the other hand, the object is of a class implementingRef,Blob,Clob,Struct, 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.
HSQLDB-Specific Information:
Inculding 1.7.1,this method was identical to
setObject(int, Object, int). That is, this method simply called setObject(int, Object, int), ignoring the scale specification.Since 1.7.2, this method supports the conversions listed in the conversion table B-5 of the JDBC 3 specification. The scale argument is not used.
- Specified by:
setObjectin 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.scale- for java.sql.Types.DECIMAL or java.sql.Types.NUMERIC types, this is the number of digits after the decimal point. For all other types, this value will be ignored.Up to and including HSQLDB 1.7.0, this parameter is ignored.
- Throws:
SQLException- if a database access error occurs- See Also:
-
setObject
Sets the value of the designated parameter with the given object. This method is like the methodsetObjectabove, 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:
setObjectin 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- See Also:
-
setObject
Sets the value of the designated parameter using the given object.The second parameter must be of type
Object; therefore, thejava.langequivalent objects should be used for built-in types.The JDBC specification specifies a standard mapping from Java
Objecttypes to SQL types. The given argument will be converted to the corresponding SQL type before being sent to the database.Note that this method may be used to pass datatabase- specific abstract data types, by using a driver-specific Java type. If the object is of a class implementing the interface
SQLData, the JDBC driver should call the methodSQLData.writeSQLto write it to the SQL data stream. If, on the other hand, the object is of a class implementingRef,Blob,Clob,Struct, orArray, the driver should pass it to the database as a value of the corresponding SQL type.This method throws an exception if there is an ambiguity, for example, if the object is of a class implementing more than one of the interfaces named above.
HSQLDB-Specific Information:
Since 1.7.2, this method supports conversions listed in the conversion table B-5 of the JDBC 3 specification.
- Specified by:
setObjectin 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 or the type of the given object is ambiguous
-
addBatch
Adds a set of parameters to thisPreparedStatementobject's batch of commands.HSQLDB-Specific Information:
Since 1.7.2, this feature is supported.
- Specified by:
addBatchin interfacePreparedStatement- Throws:
SQLException- if a database access error occurs- Since:
- JDK 1.2 (JDK 1.1.x developers: read the new overview for jdbcPreparedStatement)
- See Also:
-
setCharacterStream
Sets the designated parameter to the givenReaderobject, which is the given number of characters long. When a very large UNICODE value is input to aLONGVARCHARparameter, it may be more practical to send it via ajava.io.Readerobject. The data will be read from the stream as needed until end-of-file is reached. The JDBC driver will do any necessary conversion from UNICODE to the database char format.Note: This stream object can either be a standard Java stream object or your own subclass that implements the standard interface.
HSQLDB-Specific Information:
HSQLDB stores CHARACTER and related SQL types as Unicode so this method does not perform any conversion.
- Specified by:
setCharacterStreamin interfacePreparedStatement- Parameters:
parameterIndex- the first parameter is 1, the second is 2, ...reader- thejava.io.Readerobject that contains the Unicode datalength- the number of characters in the stream- Throws:
SQLException- if a database access error occurs- Since:
- JDK 1.2 (JDK 1.1.x developers: read the new overview for jdbcPreparedStatement)
-
setRef
Sets the designated parameter to the givenREF(<structured-type>)value. The driver converts this to an SQLREFvalue when it sends it to the database.HSQLDB-Specific Information:
HSQLDB 1.7.2 does not support the SQL REF type. Calling this method throws an exception.
- Specified by:
setRefin interfacePreparedStatement- Parameters:
i- the first parameter is 1, the second is 2, ...x- an SQLREFvalue- Throws:
SQLException- if a database access error occurs- Since:
- JDK 1.2 (JDK 1.1.x developers: read the new overview for jdbcPreparedStatement)
-
setBlob
Sets the designated parameter to the givenBlobobject. The driver converts this to an SQLBLOBvalue when it sends it to the database.HSQLDB-Specific Information:
Previous to 1.7.2, this feature was not supported.
Since 1.7.2, setBlob is supported. With 1.7.2, setting Blob objects is limited to those of length less than or equal to Integer.MAX_VALUE. In 1.7.2, setBlob(i,x) is roughly equivalent (null and length handling not shown) to:
setBinaryStream(i, x.getBinaryStream(), (int) x.length());- Specified by:
setBlobin interfacePreparedStatement- Parameters:
i- the first parameter is 1, the second is 2, ...x- aBlobobject that maps an SQLBLOBvalue- Throws:
SQLException- if a database access error occurs- Since:
- JDK 1.2 (JDK 1.1.x developers: read the new overview for jdbcPreparedStatement)
-
setClob
Sets the designated parameter to the givenClobobject. The driver converts this to an SQLCLOBvalue when it sends it to the database.HSQLDB-Specific Information:
Previous to 1.7.2, this feature was not supported.
Since 1.7.2, setClob is supported. With 1.7.2, setting Blob objects is limited to those of length less than or equal to Integer.MAX_VALUE. In 1.7.2, setClob(i,x) is rougly equivalent (null and length handling not shown) to:
setCharacterStream(i, x.getCharacterStream(), (int) x.length());- Specified by:
setClobin interfacePreparedStatement- Parameters:
i- the first parameter is 1, the second is 2, ...x- aClobobject that maps an SQLCLOBvalue- Throws:
SQLException- if a database access error occurs- Since:
- JDK 1.2 (JDK 1.1.x developers: read the new overview for jdbcPreparedStatement)
-
setArray
Sets the designated parameter to the givenArrayobject. The driver converts this to an SQLARRAYvalue when it sends it to the database.HSQLDB-Specific Information:
HSQLDB 1.7.2 does not support the SQL ARRAY type. Calling this method throws an exception.
- Specified by:
setArrayin interfacePreparedStatement- Parameters:
i- the first parameter is 1, the second is 2, ...x- anArrayobject that maps an SQLARRAYvalue- Throws:
SQLException- if a database access error occurs- Since:
- JDK 1.2 (JDK 1.1.x developers: read the new overview for jdbcPreparedStatement)
-
getMetaData
Retrieves aResultSetMetaDataobject that contains information about the columns of theResultSetobject that will be returned when thisPreparedStatementobject is executed.Because a
PreparedStatementobject is precompiled, it is possible to know about theResultSetobject that it will return without having to execute it. Consequently, it is possible to invoke the methodgetMetaDataon aPreparedStatementobject rather than waiting to execute it and then invoking theResultSet.getMetaDatamethod on theResultSetobject 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. If the statement generates an update count, then null is returned.
- Specified by:
getMetaDatain interfacePreparedStatement- Returns:
- the description of a
ResultSetobject's columns ornullif the driver cannot return aResultSetMetaDataobject - Throws:
SQLException- if a database access error occurs- Since:
- JDK 1.2 (JDK 1.1.x developers: read the new overview for jdbcPreparedStatement)
-
setDate
Sets the designated parameter to the givenjava.sql.Datevalue, using the givenCalendarobject. The driver uses theCalendarobject to construct an SQLDATEvalue,which the driver then sends to the database. With a aCalendarobject, the driver can calculate the date taking into account a custom timezone. If noCalendarobject is specified, the driver uses the default timezone, which is that of the virtual machine running the application.- Specified by:
setDatein interfacePreparedStatement- Parameters:
parameterIndex- the first parameter is 1, the second is 2, ...x- the parameter valuecal- theCalendarobject the driver will use to construct the date- Throws:
SQLException- if a database access error occurs- Since:
- JDK 1.2 (JDK 1.1.x developers: read the new overview for jdbcPreparedStatement)
-
setTime
Sets the designated parameter to the givenjava.sql.Timevalue, using the givenCalendarobject. The driver uses theCalendarobject to construct an SQLTIMEvalue, which the driver then sends to the database. With a aCalendarobject, the driver can calculate the time taking into account a custom timezone. If noCalendarobject is specified, the driver uses the default timezone, which is that of the virtual machine running the application.- Specified by:
setTimein interfacePreparedStatement- Parameters:
parameterIndex- the first parameter is 1, the second is 2, ...x- the parameter valuecal- theCalendarobject the driver will use to construct the time- Throws:
SQLException- if a database access error occurs- Since:
- JDK 1.2 (JDK 1.1.x developers: read the new overview for jdbcPreparedStatement)
-
setTimestamp
Sets the designated parameter to the givenjava.sql.Timestampvalue, using the givenCalendarobject. The driver uses theCalendarobject to construct an SQLTIMESTAMPvalue, which the driver then sends to the database. With aCalendarobject, the driver can calculate the timestamp taking into account a custom timezone. If noCalendarobject is specified, the driver uses the default timezone, which is that of the virtual machine running the application.- Specified by:
setTimestampin interfacePreparedStatement- Parameters:
parameterIndex- the first parameter is 1, the second is 2, ...x- the parameter valuecal- theCalendarobject the driver will use to construct the timestamp- Throws:
SQLException- if a database access error occurs- Since:
- JDK 1.2 (JDK 1.1.x developers: read the new overview for jdbcPreparedStatement)
-
setNull
Sets the designated parameter to SQLNULL. This version of the methodsetNullshould be used for user-defined types and REF type parameters. Examples of user-defined types include: STRUCT, DISTINCT, JAVA_OBJECT, and named array types.Note: To be portable, applications must give the SQL type code and the fully-qualified SQL type name when specifying a NULL user-defined or REF parameter. In the case of a user-defined type the name is the type name of the parameter itself. For a REF parameter, the name is the type name of the referenced type. If a JDBC driver does not need the type code or type name information, it may ignore it. Although it is intended for user-defined and Ref parameters, this method may be used to set a null parameter of any JDBC type. If the parameter does not have a user-defined or REF type, the given typeName is ignored.
HSQLDB-Specific Information:
HSQLDB ignores the sqlType and typeName arguments.
- Specified by:
setNullin interfacePreparedStatement- Parameters:
paramIndex- the first parameter is 1, the second is 2, ...sqlType- a value fromjava.sql.TypestypeName- 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- Since:
- JDK 1.2 (JDK 1.1.x developers: read the new overview for jdbcPreparedStatement)
-
setURL
Sets the designated parameter to the givenjava.net.URLvalue. The driver converts this to an SQLDATALINKvalue when it sends it to the database.HSQLDB-Specific Information:
HSQLDB 1.7.2 does not support the DATALINK SQL type for which this method is intended. Calling this method throws an exception.
- Specified by:
setURLin interfacePreparedStatement- Parameters:
parameterIndex- the first parameter is 1, the second is 2, ...x- thejava.net.URLobject to be set- Throws:
SQLException- if a database access error occurs- Since:
- JDK 1.4, HSQL 1.7.0
-
getParameterMetaData
Retrieves the number, types and properties of thisPreparedStatementobject's parameters.HSQLDB-Specific Information:
Since 1.7.2, this feature is supported.
- Specified by:
getParameterMetaDatain interfacePreparedStatement- Returns:
- a
ParameterMetaDataobject that contains information about the number, types and properties of thisPreparedStatementobject's parameters - Throws:
SQLException- if a database access error occurs- Since:
- JDK 1.4, HSQL 1.7.0
- See Also:
-
addBatch
This method should always throw if called for a PreparedStatement or CallableStatment.- Specified by:
addBatchin interfaceStatement- Overrides:
addBatchin classjdbcStatement- Parameters:
sql- ignored- Throws:
SQLException- always- See Also:
-
executeQuery
This method should always throw if called for a PreparedStatement or CallableStatment.- Specified by:
executeQueryin interfaceStatement- Overrides:
executeQueryin classjdbcStatement- Parameters:
sql- ignored- Returns:
- nothing
- Throws:
SQLException- always
-
execute
This method should always throw if called for a PreparedStatement or CallableStatment.- Specified by:
executein interfaceStatement- Overrides:
executein classjdbcStatement- Parameters:
sql- ignored- Returns:
- nothing
- Throws:
SQLException- always- See Also:
-
executeUpdate
This method should always throw if called for a PreparedStatement or CallableStatment.- Specified by:
executeUpdatein interfaceStatement- Overrides:
executeUpdatein classjdbcStatement- Parameters:
sql- ignored- Returns:
- nothing
- Throws:
SQLException- always
-
close
Does the specialized work required to free this object's resources and that of it's parent class.- Specified by:
closein interfaceAutoCloseable- Specified by:
closein interfaceStatement- Overrides:
closein classjdbcStatement- 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.
-
setPoolable
- Specified by:
setPoolablein interfaceStatement- Overrides:
setPoolablein classjdbcStatement- Throws:
SQLException
-
isPoolable
- Specified by:
isPoolablein interfaceStatement- Overrides:
isPoolablein classjdbcStatement- Throws:
SQLException
-
unwrap
- Specified by:
unwrapin interfaceWrapper- Overrides:
unwrapin classjdbcStatement- Throws:
SQLException
-
isWrapperFor
- Specified by:
isWrapperForin interfaceWrapper- Overrides:
isWrapperForin classjdbcStatement- Throws:
SQLException
-
setRowId
- Specified by:
setRowIdin interfacePreparedStatement- Throws:
SQLException
-
setNString
- Specified by:
setNStringin interfacePreparedStatement- Throws:
SQLException
-
setNCharacterStream
- Specified by:
setNCharacterStreamin interfacePreparedStatement- Throws:
SQLException
-
setNClob
- Specified by:
setNClobin interfacePreparedStatement- Throws:
SQLException
-
setClob
- Specified by:
setClobin interfacePreparedStatement- Throws:
SQLException
-
setBlob
- Specified by:
setBlobin interfacePreparedStatement- Throws:
SQLException
-
setNClob
- Specified by:
setNClobin interfacePreparedStatement- Throws:
SQLException
-
setSQLXML
- Specified by:
setSQLXMLin interfacePreparedStatement- Throws:
SQLException
-
setAsciiStream
- Specified by:
setAsciiStreamin interfacePreparedStatement- Throws:
SQLException
-
setBinaryStream
- Specified by:
setBinaryStreamin interfacePreparedStatement- Throws:
SQLException
-
setCharacterStream
- Specified by:
setCharacterStreamin interfacePreparedStatement- Throws:
SQLException
-
setAsciiStream
- Specified by:
setAsciiStreamin interfacePreparedStatement- Throws:
SQLException
-
setBinaryStream
- Specified by:
setBinaryStreamin interfacePreparedStatement- Throws:
SQLException
-
setCharacterStream
- Specified by:
setCharacterStreamin interfacePreparedStatement- Throws:
SQLException
-
setNCharacterStream
- Specified by:
setNCharacterStreamin interfacePreparedStatement- Throws:
SQLException
-
setClob
- Specified by:
setClobin interfacePreparedStatement- Throws:
SQLException
-
setBlob
- Specified by:
setBlobin interfacePreparedStatement- Throws:
SQLException
-
setNClob
- Specified by:
setNClobin interfacePreparedStatement- Throws:
SQLException
-