org.hsqldb.jdbc.jdbcStatement
org.hsqldb.jdbc.jdbcPreparedStatement
|
|||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||
java.lang.Object
An object that represents a precompiled SQL statement.
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)
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)
jdbcConnection.prepareStatement(java.lang.String),
jdbcResultSet| 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 | |
void |
addBatch()
Adds a set of parameters to this PreparedStatement
object's batch of commands. |
void |
addBatch(java.lang.String sql)
This method should always throw if called for a PreparedStatement or CallableStatment. |
void |
clearParameters()
Clears the current parameter values immediately. |
void |
close()
Does the specialized work required to free this object's resources and that of it's parent class. |
boolean |
execute()
Executes the SQL statement in this PreparedStatement
object, which may be any kind of SQL statement. |
boolean |
execute(java.lang.String sql)
This method should always throw if called for a PreparedStatement or CallableStatment. |
int[] |
executeBatch()
Submits a batch of commands to the database for execution and if all commands execute successfully, returns an array of update counts. |
java.sql.ResultSet |
executeQuery()
Executes the SQL query in this PreparedStatement object
and returns the ResultSet object generated by the query. |
java.sql.ResultSet |
executeQuery(java.lang.String sql)
This method should always throw if called for a PreparedStatement or CallableStatment. |
int |
executeUpdate()
Executes the SQL statement in this PreparedStatement
object, which must be an SQL INSERT,
UPDATE or DELETE statement; or an SQL
statement that returns nothing, such as a DDL statement. |
int |
executeUpdate(java.lang.String sql)
This method should always throw if called for a PreparedStatement or CallableStatment. |
java.sql.ResultSetMetaData |
getMetaData()
Retrieves a ResultSetMetaData object that contains
information about the columns of the ResultSet object
that will be returned when this PreparedStatement object
is executed. |
java.sql.ParameterMetaData |
getParameterMetaData()
Retrieves the number, types and properties of this PreparedStatement object's parameters. |
void |
setArray(int i,
java.sql.Array x)
Sets the designated parameter to the given Array object. |
void |
setAsciiStream(int parameterIndex,
java.io.InputStream x,
int length)
Sets the designated parameter to the given input stream, which will have the specified number of bytes. |
void |
setBigDecimal(int parameterIndex,
java.math.BigDecimal x)
Sets the designated parameter to the given java.math.BigDecimal value. |
void |
setBinaryStream(int parameterIndex,
java.io.InputStream x,
int length)
Sets the designated parameter to the given input stream, which will have the specified number of bytes. |
void |
setBlob(int i,
java.sql.Blob x)
Sets the designated parameter to the given Blob object. |
void |
setBoolean(int parameterIndex,
boolean x)
Sets the designated parameter to the given Java boolean
value. |
void |
setByte(int parameterIndex,
byte x)
Sets the designated parameter to the given Java byte value. |
void |
setBytes(int paramIndex,
byte[] x)
Sets the designated parameter to the given Java array of bytes. |
void |
setCharacterStream(int parameterIndex,
java.io.Reader reader,
int length)
Sets the designated parameter to the given Reader
object, which is the given number of characters long. |
void |
setClob(int i,
java.sql.Clob x)
Sets the designated parameter to the given Clob object. |
void |
setDate(int parameterIndex,
java.sql.Date x)
Sets the designated parameter to the given java.sql.Date value. |
void |
setDate(int parameterIndex,
java.sql.Date x,
java.util.Calendar cal)
Sets the designated parameter to the given java.sql.Date
value, using the given Calendar object. |
void |
setDouble(int parameterIndex,
double x)
Sets the designated parameter to the given Java double value. |
void |
setEscapeProcessing(boolean enable)
Sets escape processing on or off. |
void |
setFloat(int parameterIndex,
float x)
Sets the designated parameter to the given Java float value. |
void |
setInt(int parameterIndex,
int x)
Sets the designated parameter to the given Java int value. |
void |
setLong(int parameterIndex,
long x)
Sets the designated parameter to the given Java long value. |
void |
setNull(int paramIndex,
int sqlType)
Sets the designated parameter to SQL NULL. |
void |
setNull(int paramIndex,
int sqlType,
java.lang.String typeName)
Sets the designated parameter to SQL NULL. |
void |
setObject(int parameterIndex,
java.lang.Object x)
Sets the value of the designated parameter using the given object. |
void |
setObject(int parameterIndex,
java.lang.Object x,
int targetSqlType)
Sets the value of the designated parameter with the given object. |
void |
setObject(int parameterIndex,
java.lang.Object x,
int targetSqlType,
int scale)
Sets the value of the designated parameter with the given object. |
void |
setRef(int i,
java.sql.Ref x)
Sets the designated parameter to the given REF(<structured-type>) value. |
void |
setShort(int parameterIndex,
short x)
Sets the designated parameter to the given Java short
value. |
void |
setString(int parameterIndex,
java.lang.String x)
Sets the designated parameter to the given Java String value. |
void |
setTime(int parameterIndex,
java.sql.Time x)
Sets the designated parameter to the given java.sql.Time
value. |
void |
setTime(int parameterIndex,
java.sql.Time x,
java.util.Calendar cal)
Sets the designated parameter to the given java.sql.Time
value, using the given Calendar object. |
void |
setTimestamp(int parameterIndex,
java.sql.Timestamp x)
Sets the designated parameter to the given java.sql.Timestamp value. |
void |
setTimestamp(int parameterIndex,
java.sql.Timestamp x,
java.util.Calendar cal)
Sets the designated parameter to the given java.sql.Timestamp
value, using the given Calendar object. |
void |
setUnicodeStream(int parameterIndex,
java.io.InputStream x,
int length)
Deprecated. Sun does not include a reason, but presumably this is because setCharacterStream is now prefered |
void |
setURL(int parameterIndex,
java.net.URL x)
Sets the designated parameter to the given java.net.URL
value. |
java.lang.String |
toString()
Retrieves a String representation of this object. |
| Methods inherited from class org.hsqldb.jdbc.jdbcStatement |
cancel, clearBatch, clearWarnings, execute, execute, execute, executeUpdate, executeUpdate, executeUpdate, getConnection, getFetchDirection, getFetchSize, getGeneratedKeys, getMaxFieldSize, getMaxRows, getMoreResults, getMoreResults, getQueryTimeout, getResultSet, getResultSetConcurrency, getResultSetHoldability, getResultSetType, getUpdateCount, getWarnings, setCursorName, setFetchDirection, setFetchSize, setMaxFieldSize, setMaxRows, setQueryTimeout |
| Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
| Methods inherited from interface java.sql.Statement |
cancel, clearBatch, clearWarnings, execute, execute, execute, executeUpdate, executeUpdate, executeUpdate, getConnection, getFetchDirection, getFetchSize, getGeneratedKeys, getMaxFieldSize, getMaxRows, getMoreResults, getMoreResults, getQueryTimeout, getResultSet, getResultSetConcurrency, getResultSetHoldability, getResultSetType, getUpdateCount, getWarnings, setCursorName, setFetchDirection, setFetchSize, setMaxFieldSize, setMaxRows, setQueryTimeout |
| Method Detail |
public void setEscapeProcessing(boolean enable)
throws java.sql.SQLException
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.
setEscapeProcessing in interface java.sql.StatementsetEscapeProcessing in class jdbcStatementenable - true to enable escape processing;
false to disable it
java.sql.SQLException - if a database access error occurs
public boolean execute()
throws java.sql.SQLException
PreparedStatement
object, which may be any kind of SQL statement.
Some prepared statements return multiple results; the
execute method handles these complex statements as well
as the simpler form of statements handled by the methods
executeQueryand executeUpdate.
The execute method returns a boolean to
indicate the form of the first result. You must call either the method
getResultSet or getUpdateCount
to retrieve the result; you must call getMoreResults to
move to any subsequent result(s).
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.
execute in interface java.sql.PreparedStatementtrue if the first result is a ResultSet
object; false if the first result is an update
count or there is no result
java.sql.SQLException - if a database access error occurs or an argument
is supplied to this methodjdbcStatement.execute(java.lang.String),
jdbcStatement.getResultSet(),
jdbcStatement.getUpdateCount(),
jdbcStatement.getMoreResults()
public java.sql.ResultSet executeQuery()
throws java.sql.SQLException
PreparedStatement object
and returns the ResultSet object generated by the query.
executeQuery in interface java.sql.PreparedStatementResultSet object that contains the data produced
by the query; never null
java.sql.SQLException - if a database access error occurs or the SQL
statement does not return a ResultSet object
public int executeUpdate()
throws java.sql.SQLException
PreparedStatement
object, which must be an SQL INSERT,
UPDATE or DELETE statement; or an SQL
statement that returns nothing, such as a DDL statement.
executeUpdate in interface java.sql.PreparedStatementINSERT,
UPDATE, or DELETE
statements or (2) 0 for SQL statements that
return nothing
java.sql.SQLException - if a database access error occurs or the SQL
statement returns a ResultSet object
public int[] executeBatch()
throws java.sql.SQLException
int elements of the array that is returned are ordered
to correspond to the commands in the batch, which are ordered
according to the order in which they were added to the batch.
The elements in the array returned by the method executeBatch
may be one of the following:
SUCCESS_NO_INFO -- indicates that the command was
processed successfully but that the number of rows affected is
unknown
If one of the commands in a batch update fails to execute properly,
this method throws a BatchUpdateException, and a JDBC
driver may or may not continue to process the remaining commands in
the batch. However, the driver's behavior must be consistent with a
particular DBMS, either always continuing to process commands or never
continuing to process commands. If the driver continues processing
after a failure, the array returned by the method
BatchUpdateException.getUpdateCounts
will contain as many elements as there are commands in the batch, and
at least one of the elements will be the following:
EXECUTE_FAILED -- indicates that the command failed
to execute successfully and occurs only if a driver continues to
process commands after a command fails
A driver is not required to implement this method.
The possible implementations and return values have been modified in
the Java 2 SDK, Standard Edition, version 1.3 to
accommodate the option of continuing to proccess commands in a batch
update after a BatchUpdateException obejct has been thrown.
Starting with HSQLDB 1.7.2, this feature is supported.
HSQLDB stops execution of commands in a batch when one of the commands results in an exception. The size of the returned array equals the number of commands that were executed successfully.
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.
executeBatch in interface java.sql.StatementexecuteBatch in class jdbcStatementjava.sql.SQLException - if a database access error occurs or the
driver does not support batch statements. Throws
BatchUpdateException
(a subclass of java.sql.SQLException) if one of the commands
sent to the database fails to execute properly or attempts to return a
result set.
public void setNull(int paramIndex,
int sqlType)
throws java.sql.SQLException
NULL. Note: You must specify the parameter's SQL type.
HSQLDB ignores the sqlType argument.
setNull in interface java.sql.PreparedStatementparamIndex - the first parameter is 1, the second is 2, ...sqlType - the SQL type code defined in java.sql.Types
java.sql.SQLException - if a database access error occurs
public void setBoolean(int parameterIndex,
boolean x)
throws java.sql.SQLException
boolean
value. The driver converts this to an SQL BIT value
when it sends it to the database.
Since 1.7.2, HSQLDB uses the BOOLEAN type instead of BIT, as per SQL 200n (SQL 3).
setBoolean in interface java.sql.PreparedStatementparameterIndex - the first parameter is 1, the second is 2, ...x - the parameter value
java.sql.SQLException - if a database access error occurs
public void setByte(int parameterIndex,
byte x)
throws java.sql.SQLException
byte value.
The driver converts this to an SQL TINYINT value when
it sends it to the database.
setByte in interface java.sql.PreparedStatementparameterIndex - the first parameter is 1, the second is 2, ...x - the parameter value
java.sql.SQLException - if a database access error occurs
public void setShort(int parameterIndex,
short x)
throws java.sql.SQLException
short
value. The driver converts this to an SQL SMALLINT
value when it sends it to the database.
setShort in interface java.sql.PreparedStatementparameterIndex - the first parameter is 1, the second is 2, ...x - the parameter value
java.sql.SQLException - if a database access error occurs
public void setInt(int parameterIndex,
int x)
throws java.sql.SQLException
int value.
The driver converts this to an SQL INTEGER value when
it sends it to the database.
setInt in interface java.sql.PreparedStatementparameterIndex - the first parameter is 1, the second is 2, ...x - the parameter value
java.sql.SQLException - if a database access error occurs
public void setLong(int parameterIndex,
long x)
throws java.sql.SQLException
long value.
The driver converts this to an SQL BIGINT value when
it sends it to the database.
setLong in interface java.sql.PreparedStatementparameterIndex - the first parameter is 1, the second is 2, ...x - the parameter value
java.sql.SQLException - if a database access error occurs
public void setFloat(int parameterIndex,
float x)
throws java.sql.SQLException
float value.
The driver converts this to an SQL FLOAT value when
it sends it to the database.
Since 1.7.1, HSQLDB handles Java positive/negative Infinity
and NaN float values consistent with the Java Language
Specification; these special values are now correctly stored
to and retrieved from the database.
setFloat in interface java.sql.PreparedStatementparameterIndex - the first parameter is 1, the second is 2, ...x - the parameter value
java.sql.SQLException - if a database access error occurs
public void setDouble(int parameterIndex,
double x)
throws java.sql.SQLException
double value.
The driver converts this to an SQL DOUBLE value when it
sends it to the database.
Since 1.7.1, HSQLDB handles Java positive/negative Infinity
and NaN double values consistent with the Java Language
Specification; these special values are now correctly stored
to and retrieved from the database.
setDouble in interface java.sql.PreparedStatementparameterIndex - the first parameter is 1, the second is 2, ...x - the parameter value
java.sql.SQLException - if a database access error occurs
public void setBigDecimal(int parameterIndex,
java.math.BigDecimal x)
throws java.sql.SQLException
java.math.BigDecimal value.
The driver converts this to an SQL NUMERIC value when
it sends it to the database.
setBigDecimal in interface java.sql.PreparedStatementparameterIndex - the first parameter is 1, the second is 2, ...x - the parameter value
java.sql.SQLException - if a database access error occurs
public void setString(int parameterIndex,
java.lang.String x)
throws java.sql.SQLException
String value.
The driver converts this
to an SQL VARCHAR or LONGVARCHAR value
(depending on the argument's
size relative to the driver's limits on VARCHAR values)
when it sends it to the database.
Including 1.7.2, HSQLDB stores all XXXCHAR values as java.lang.String objects; there is no appreciable difference between CHAR, VARCHAR and LONGVARCHAR.
setString in interface java.sql.PreparedStatementparameterIndex - the first parameter is 1, the second is 2, ...x - the parameter value
java.sql.SQLException - if a database access error occurs
public void setBytes(int paramIndex,
byte[] x)
throws java.sql.SQLException
VARBINARY or
LONGVARBINARY (depending on the argument's size relative
to the driver's limits on VARBINARY values) when it
sends it to the database.
Including 1.7.2, HSQLDB stores all XXXBINARY values the same way; there is no appreciable difference between BINARY, VARBINARY and LONGVARBINARY.
setBytes in interface java.sql.PreparedStatementparamIndex - the first parameter is 1, the second is 2, ...x - the parameter value
java.sql.SQLException - if a database access error occurs
public void setDate(int parameterIndex,
java.sql.Date x)
throws java.sql.SQLException
java.sql.Date value. The driver converts this
to an SQL DATE value when it sends it to the database.
setDate in interface java.sql.PreparedStatementparameterIndex - the first parameter is 1, the second is 2, ...x - the parameter value
java.sql.SQLException - if a database access error occurs
public void setTime(int parameterIndex,
java.sql.Time x)
throws java.sql.SQLException
java.sql.Time
value. The driver converts this to an SQL TIME value when it
sends it to the database.
setTime in interface java.sql.PreparedStatementparameterIndex - the first parameter is 1, the second is 2, ...x - the parameter value
java.sql.SQLException - if a database access error occurs
public void setTimestamp(int parameterIndex,
java.sql.Timestamp x)
throws java.sql.SQLException
java.sql.Timestamp value. The driver converts this to
an SQL TIMESTAMP value when it sends it to the
database.
setTimestamp in interface java.sql.PreparedStatementparameterIndex - the first parameter is 1, the second is 2, ...x - the parameter value
java.sql.SQLException - if a database access error occurs
public void setAsciiStream(int parameterIndex,
java.io.InputStream x,
int length)
throws java.sql.SQLException
LONGVARCHAR
parameter, it may be more practical to send it via a
java.io.InputStream. Data will be read from the stream
as needed until end-of-file is reached. The JDBC driver will
do any necessary conversion from ASCII to the database char format. Note: This stream object can either be a standard Java stream object or your own subclass that implements the standard interface.
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, setAsciiStream and
setUnicodeStream were identical.
setAsciiStream in interface java.sql.PreparedStatementparameterIndex - the first parameter is 1, the second is 2, ...x - the Java input stream that contains the ASCII parameter valuelength - the number of bytes in the stream
java.sql.SQLException - if a database access error occurs
public void setUnicodeStream(int parameterIndex,
java.io.InputStream x,
int length)
throws java.sql.SQLException
LONGVARCHAR
parameter, it may be more practical to send it via a
java.io.InputStream 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.
Since 1.7.0, this method complies with behavior as defined by the JDBC3 specification.
setUnicodeStream in interface java.sql.PreparedStatementparameterIndex - the first parameter is 1, the second is 2, ...x - a java.io.InputStream object that contains the
Unicode parameter value as two-byte Unicode characterslength - the number of bytes in the stream
java.sql.SQLException - if a database access error occurs
public void setBinaryStream(int parameterIndex,
java.io.InputStream x,
int length)
throws java.sql.SQLException
LONGVARBINARY
parameter, it may be more practical to send it via a
java.io.InputStream object. The data will be read from the
stream as needed until end-of-file is reached.
Note: This stream object can either be a standard Java stream object or your own subclass that implements the standard interface.
Since 1.7.2, this method works according to the standard.
setBinaryStream in interface java.sql.PreparedStatementparameterIndex - the first parameter is 1, the second is 2, ...x - the java input stream which contains the binary parameter valuelength - the number of bytes in the stream
java.sql.SQLException - if a database access error occurs
public void clearParameters()
throws java.sql.SQLException
In general, parameter values remain in force for repeated use of a
statement. Setting a parameter value automatically clears its
previous value. However, in some cases it is useful to immediately
release the resources used by the current parameter values; this can
be done by calling the method clearParameters.
clearParameters in interface java.sql.PreparedStatementjava.sql.SQLException - if a database access error occurs
public void setObject(int parameterIndex,
java.lang.Object x,
int targetSqlType,
int scale)
throws java.sql.SQLException
The second argument must be an object type; for integral values, the
java.lang equivalent 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 method SQLData.writeSQL to
write it to the SQL data stream.
If, on the other hand, the object is of a class implementing
Ref, Blob, Clob,
Struct, or Array, the driver should pass it
to the database as a value of the corresponding SQL type.
Note that this method may be used to pass database-specific abstract data types.
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.
setObject in interface java.sql.PreparedStatementparameterIndex - the first parameter is 1, the second is 2, ...x - the object containing the input parameter valuetargetSqlType - the SQL type (as defined in java.sql.Types) to be
sent to the database. The scale argument may further qualify this type.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.
java.sql.SQLException - if a database access error occursTypes,
setObject(int,Object,int)
public void setObject(int parameterIndex,
java.lang.Object x,
int targetSqlType)
throws java.sql.SQLException
setObject
above, except that it assumes a scale of zero.
Since 1.7.2, this method supports conversions listed in the conversion table B-5 of the JDBC 3 specification.
setObject in interface java.sql.PreparedStatementparameterIndex - the first parameter is 1, the second is 2, ...x - the object containing the input parameter valuetargetSqlType - the SQL type (as defined in java.sql.Types) to be
sent to the database
java.sql.SQLException - if a database access error occurssetObject(int,Object)
public void setObject(int parameterIndex,
java.lang.Object x)
throws java.sql.SQLException
The second parameter must be of type Object; therefore,
the java.lang equivalent objects should be used for
built-in types.
The JDBC specification specifies a standard mapping from
Java Object types to SQL types. The given argument
will be converted to the corresponding SQL type before being
sent to the database.
Note that this method may be used to pass 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 method
SQLData.writeSQL to write it to the SQL data stream.
If, on the other hand, the object is of a class implementing
Ref, Blob, Clob,
Struct, or Array, 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.
Since 1.7.2, this method supports conversions listed in the conversion table B-5 of the JDBC 3 specification.
setObject in interface java.sql.PreparedStatementparameterIndex - the first parameter is 1, the second is 2, ...x - the object containing the input parameter value
java.sql.SQLException - if a database access error occurs or the type
of the given object is ambiguous
public void addBatch()
throws java.sql.SQLException
PreparedStatement
object's batch of commands.
Since 1.7.2, this feature is supported.
addBatch in interface java.sql.PreparedStatementjava.sql.SQLException - if a database access error occursjdbcStatement.addBatch(java.lang.String)
public void setCharacterStream(int parameterIndex,
java.io.Reader reader,
int length)
throws java.sql.SQLException
Reader
object, which is the given number of characters long.
When a very large UNICODE value is input to a LONGVARCHAR
parameter, it may be more practical to send it via a
java.io.Reader object. The data will be read from the
stream as needed until end-of-file is reached. The JDBC driver will
do any necessary conversion from UNICODE to the database char format.
Note: This stream object can either be a standard Java stream object or your own subclass that implements the standard interface.
HSQLDB stores CHARACTER and related SQL types as Unicode so this method does not perform any conversion.
setCharacterStream in interface java.sql.PreparedStatementparameterIndex - the first parameter is 1, the second is 2, ...reader - the java.io.Reader object that contains the
Unicode datalength - the number of characters in the stream
java.sql.SQLException - if a database access error occurs
public void setRef(int i,
java.sql.Ref x)
throws java.sql.SQLException
REF(<structured-type>) value.
The driver converts this to an SQL REF value when it
sends it to the database.
HSQLDB 1.7.2 does not support the SQL REF type. Calling this method throws an exception.
setRef in interface java.sql.PreparedStatementi - the first parameter is 1, the second is 2, ...x - an SQL REF value
java.sql.SQLException - if a database access error occurs
public void setBlob(int i,
java.sql.Blob x)
throws java.sql.SQLException
Blob object.
The driver converts this to an SQL BLOB value when it
sends it to the database.
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());
setBlob in interface java.sql.PreparedStatementi - the first parameter is 1, the second is 2, ...x - a Blob object that maps an SQL BLOB
value
java.sql.SQLException - if a database access error occurs
public void setClob(int i,
java.sql.Clob x)
throws java.sql.SQLException
Clob object.
The driver converts this to an SQL CLOB value when it
sends it to the database.
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());
setClob in interface java.sql.PreparedStatementi - the first parameter is 1, the second is 2, ...x - a Clob object that maps an SQL CLOB
value
java.sql.SQLException - if a database access error occurs
public void setArray(int i,
java.sql.Array x)
throws java.sql.SQLException
Array object.
The driver converts this to an SQL ARRAY value when it
sends it to the database.
HSQLDB 1.7.2 does not support the SQL ARRAY type. Calling this method throws an exception.
setArray in interface java.sql.PreparedStatementi - the first parameter is 1, the second is 2, ...x - an Array object that maps an SQL ARRAY
value
java.sql.SQLException - if a database access error occurs
public java.sql.ResultSetMetaData getMetaData()
throws java.sql.SQLException
ResultSetMetaData object that contains
information about the columns of the ResultSet object
that will be returned when this PreparedStatement object
is executed.
Because a PreparedStatement object is precompiled, it is
possible to know about the ResultSet object that it will
return without having to execute it. Consequently, it is possible
to invoke the method getMetaData on a
PreparedStatement object rather than waiting to execute
it and then invoking the ResultSet.getMetaData method
on the ResultSet object that is returned.
NOTE: Using this method may be expensive for some drivers due to the lack of underlying DBMS support.
Since 1.7.2, this feature is supported. If the statement generates an update count, then null is returned.
getMetaData in interface java.sql.PreparedStatementResultSet object's columns or
null if the driver cannot return a
ResultSetMetaData object
java.sql.SQLException - if a database access error occurs
public void setDate(int parameterIndex,
java.sql.Date x,
java.util.Calendar cal)
throws java.sql.SQLException
java.sql.Date
value, using the given Calendar object. The driver uses
the Calendar object to construct an SQL DATE
value,which the driver then sends to the database. With a
a Calendar object, the driver can calculate the date
taking into account a custom timezone. If no
Calendar object is specified, the driver uses the default
timezone, which is that of the virtual machine running the
application.
setDate in interface java.sql.PreparedStatementparameterIndex - the first parameter is 1, the second is 2, ...x - the parameter valuecal - the Calendar object the driver will use
to construct the date
java.sql.SQLException - if a database access error occurs
public void setTime(int parameterIndex,
java.sql.Time x,
java.util.Calendar cal)
throws java.sql.SQLException
java.sql.Time
value, using the given Calendar object. The driver uses
the Calendar object to construct an SQL TIME
value, which the driver then sends to the database. With a
a Calendar object, the driver can calculate the time
taking into account a custom timezone. If no
Calendar object is specified, the driver uses the default
timezone, which is that of the virtual machine running the
application.
setTime in interface java.sql.PreparedStatementparameterIndex - the first parameter is 1, the second is 2, ...x - the parameter valuecal - the Calendar object the driver will use
to construct the time
java.sql.SQLException - if a database access error occurs
public void setTimestamp(int parameterIndex,
java.sql.Timestamp x,
java.util.Calendar cal)
throws java.sql.SQLException
java.sql.Timestamp
value, using the given Calendar object. The driver uses
the Calendar object to construct an SQL TIMESTAMP
value, which the driver then sends to the database. With a
Calendar object, the driver can calculate the timestamp
taking into account a custom timezone. If no
Calendar object is specified, the driver uses the default
timezone, which is that of the virtual machine running the application.
setTimestamp in interface java.sql.PreparedStatementparameterIndex - the first parameter is 1, the second is 2, ...x - the parameter valuecal - the Calendar object the driver will use
to construct the timestamp
java.sql.SQLException - if a database access error occurs
public void setNull(int paramIndex,
int sqlType,
java.lang.String typeName)
throws java.sql.SQLException
NULL.
This version of the method setNull should
be used for user-defined types and REF type parameters. Examples
of user-defined types include: STRUCT, DISTINCT, JAVA_OBJECT, and
named array types.
Note: To be portable, applications must give the SQL type code and the fully-qualified SQL type name when specifying a NULL user-defined or REF parameter. In the case of a user-defined type the name is the type name of the parameter itself. For a REF parameter, the name is the type name of the referenced type. If a JDBC driver does not need the type code or type name information, it may ignore it. Although it is intended for user-defined and Ref parameters, this method may be used to set a null parameter of any JDBC type. If the parameter does not have a user-defined or REF type, the given typeName is ignored.
HSQLDB ignores the sqlType and typeName arguments.
setNull in interface java.sql.PreparedStatementparamIndex - the first parameter is 1, the second is 2, ...sqlType - a value from java.sql.TypestypeName - the fully-qualified name of an SQL user-defined type;
ignored if the parameter is not a user-defined type or REF
java.sql.SQLException - if a database access error occurs
public void setURL(int parameterIndex,
java.net.URL x)
throws java.sql.SQLException
java.net.URL
value. The driver converts this to an SQL DATALINK value
when it sends it to the database.
HSQLDB 1.7.2 does not support the DATALINK SQL type for which this method is intended. Calling this method throws an exception.
setURL in interface java.sql.PreparedStatementparameterIndex - the first parameter is 1, the second is 2, ...x - the java.net.URL object to be set
java.sql.SQLException - if a database access error occurs
public java.sql.ParameterMetaData getParameterMetaData()
throws java.sql.SQLException
PreparedStatement object's parameters.
Since 1.7.2, this feature is supported.
getParameterMetaData in interface java.sql.PreparedStatementParameterMetaData object that contains information
about the number, types and properties of this
PreparedStatement object's parameters
java.sql.SQLException - if a database access error occursParameterMetaData
public void addBatch(java.lang.String sql)
throws java.sql.SQLException
addBatch in interface java.sql.StatementaddBatch in class jdbcStatementsql - ignored
java.sql.SQLException - alwaysjdbcStatement.executeBatch()
public java.sql.ResultSet executeQuery(java.lang.String sql)
throws java.sql.SQLException
executeQuery in interface java.sql.StatementexecuteQuery in class jdbcStatementsql - ignored
java.sql.SQLException - always
public boolean execute(java.lang.String sql)
throws java.sql.SQLException
execute in interface java.sql.Statementexecute in class jdbcStatementsql - ignored
java.sql.SQLException - alwaysjdbcStatement.getResultSet(),
jdbcStatement.getUpdateCount(),
jdbcStatement.getMoreResults()
public int executeUpdate(java.lang.String sql)
throws java.sql.SQLException
executeUpdate in interface java.sql.StatementexecuteUpdate in class jdbcStatementsql - ignored
java.sql.SQLException - always
public void close()
throws java.sql.SQLException
close in interface java.sql.Statementclose in class jdbcStatementjava.sql.SQLException - if a database access error occurspublic java.lang.String toString()
The representation is of the form:
class-name@hash[sql=[char-sequence], parameters=[p1, ...pi, ...pn]]
p1, ...pi, ...pn are the String representations of the currently set parameter values that will be used with the non-batch execution methods.
|
|||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||