| Prev Class | Next Class | Frames | No Frames |
| Summary: Nested | Field | Method | Constr | Detail: Nested | Field | Method | Constr |
java.lang.Objectorg.hsqldb.jdbc.jdbcStatementorg.hsqldb.jdbc.jdbcPreparedStatementorg.hsqldb.jdbc.jdbcCallableStatement
{?= call <procedure-name>[<arg1>,<arg2>, ...]}
{call <procedure-name>[<arg1>,<arg2>, ...]}
IN parameter values are set using the set methods inherited from
PreparedStatement. The type of all OUT parameters must be
registered prior to executing the stored procedure; their values
are retrieved after execution via the get methods provided here.
A CallableStatement can return one ResultSet object or
multiple ResultSet objects. Multiple
ResultSet objects are handled using operations
inherited from Statement.
For maximum portability, a call's ResultSet objects and
update counts should be processed prior to getting the values of output
parameters.
<!-- end generic documentation -->
<!-- start Release-specific documentation -->
jdbcPreparedStatment.
GRANT ALL ON CLASS "package.class" TO [<user-name> | PUBLIC] CREATE ALIAS <call-alias> FOR "package.class.method" -- optionalThis has the effect of allowing the specified user(s) to access the set of uniquely named public static methods of the specified class, in either the role of SQL functions or stored procedures. For example:
CONNECT <admin-user> PASSWORD <admin-user-password>; GRANT ALL ON CLASS "org.myorg.MyClass" TO PUBLIC; CREATE ALIAS sp_my_method FOR "org.myorg.MyClass.myMethod" CONNECT <any-user> PASSWORD <any-user-password>; SELECT "org.myorg.MyClass.myMethod"(column_1) FROM table_1; SELECT sp_my_method(column_1) FROM table_1; CALL 2 + "org.myorg.MyClass.myMethod"(-5); CALL 2 + sp_my_method(-5);Please note the use of the term "uniquely named" above. Including 1.7.2, no support is provided to deterministically resolve overloaded method names, and there can be issues with inherited methods as well; currently, it is strongly recommended that developers creating stored procedure library classes for HSQLDB simply avoid designs such that SQL stored procedure calls attempt to resolve to:
OUT and IN OUT parameters
are not yet supported due to some unresolved low level support issues.
Including 1.7.2, the HSQLDB stored procedure call mechanism is essentially a
thin wrap of the HSQLDB SQL function call mechanism, extended to include the
more general HSQLDB SQL expression evaluation mechanism. In addition to
stored procedure calls that resolve directly to Java method invocations, the
extention provides the ability to evaluate simple SQL expressions, possibly
containing Java method invocations, outside any INSERT,
UPDATE, DELETE or SELECT statement
context.
With HSQLDB, executing a CALL statement that produces an opaque
(OTHER) or known scalar object reference has virtually the same effect as:
CREATE TABLE DUAL (dummy VARCHAR); INSERT INTO DUAL VALUES(NULL); SELECT <simple-expression> FROM DUAL;As a transitional measure, HSQLDB provides the ability to materialize a general result set in response to stored procedure execution. In this case, the stored procedure's Java method descriptor must specify a return type of java.lang.Object for external use (although at any point in the devlopment cycle, other, proprietary return types may accepted internally for engine development purposes). When HSQLDB detects that the runtime class of the resulting Object is elligible, an automatic internal unwrapping is performed to correctly expose the underlying result set to the client, whether local or remote. Additionally, HSQLDB automatically detects if java.sql.Connection is the class of the first argument of any underlying Java method(s). If so, then the engine transparently supplies the internal Connection object corresponding to the Session executing the call, adjusting the positions of other arguments to suite the SQL context. The features above are not intended to be permanent. Rather, the intention is to offer more general and powerful mechanisms in a future release; it is recommend to use them only as a temporary convenience. For instance, one might be well advised to future-proof by writing HSQLDB-specific adapter methods that in turn call the real logic of an underlying generalized JDBC stored procedure library. Here is a very simple example of an HSQLDB stored procedure generating a user-defined result set:
package mypackage; class MyClass { public static Object mySp(Connection conn) throws SQLException { return conn.createStatement().executeQuery("select * from my_table"); } }Here is a refinement demonstrating no more than the bare essence of the idea behind a more portable style:
package mypackage; import java.sql.ResultSet; import java.sql.SQLException; class MyLibraryClass { public static ResultSet mySp() throws SQLException { return ctx.getConnection().createStatement().executeQuery("select * from my_table"); } } //-- package myadaptorpackage; import java.sql.Connection; import java.sql.SQLException; class MyAdaptorClass { public static Object mySp(Connection conn) throws SQLException { MyLibraryClass.getCtx().setConnection(conn); return MyLibraryClass.mySp(); } }In a future release, it is intended to provided some new features that will support writing fairly portable JDBC-based stored procedure code:
jdbcConnection.prepareCall, jdbcResultSetConstructor Summary | |
| |
Method Summary | |
void |
|
Array |
|
Array |
|
BigDecimal |
|
BigDecimal |
|
BigDecimal |
|
Blob |
|
Blob |
|
boolean |
|
boolean |
|
byte |
|
byte |
|
byte[] |
|
byte[] |
|
Clob |
|
Clob |
|
Date |
|
Date |
|
Date |
|
Date |
|
double |
|
double |
|
float |
|
float |
|
int |
|
int |
|
long |
|
long |
|
Object |
|
Object |
|
Object |
|
Object |
|
Ref |
|
Ref |
|
short |
|
short |
|
String |
|
String |
|
Time |
|
Time |
|
Time |
|
Time |
|
Timestamp |
|
Timestamp |
|
Timestamp |
|
Timestamp |
|
java.net.URL |
|
java.net.URL |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
boolean |
|
Methods inherited from class org.hsqldb.jdbc.jdbcPreparedStatement | |
addBatch, addBatch, clearParameters, close, execute, execute, executeBatch, executeQuery, executeQuery, executeUpdate, executeUpdate, getMetaData, getParameterMetaData, setArray, setAsciiStream, setBigDecimal, setBinaryStream, setBlob, setBoolean, setByte, setBytes, setCharacterStream, setClob, setDate, setDate, setDouble, setEscapeProcessing, setFloat, setInt, setLong, setNull, setNull, setObject, setObject, setObject, setRef, setShort, setString, setTime, setTime, setTimestamp, setTimestamp, setURL, setUnicodeStream, toString | |
public jdbcCallableStatement(jdbcConnection c, String sql, int type) throws org.hsqldb.HsqlException, SQLException
Constructs a new jdbcCallableStatement with the specified connection and result type.
- Parameters:
c- the connection on which this statement will executesql- the SQL statement this object representstype- the type of result this statement will produce
- Throws:
org.hsqldb.HsqlException- if the statement is not accepted by the database
public void close()
throws SQLExceptionDoes the specialized work required to free this object's resources and that of it's parent classes.
- Overrides:
- close in interface jdbcPreparedStatement
public Array getArray(String parameterName)
throws SQLException<!-- start generic documentation --> Retrieves the value of a JDBCARRAYparameter as anArrayobject in the Java programming language. <!-- end generic documentation --> <!-- start release-specific documentation --><!-- end release-specific documentation -->HSQLDB-Specific Information:
HSQLDB 1.7.2 does not support this feature. Calling this method always throws anSQLException.
- Parameters:
parameterName- the name of the parameter
- Returns:
- the parameter value as an
Arrayobject in Java programming language. If the value was SQLNULL, the valuenullis returned.
- Since:
- JDK 1.4, HSQLDB 1.7.0
public Array getArray(int parameterIndex)
throws SQLException<!-- start generic documentation --> Retrieves the value of the designated JDBCARRAYparameter as anjava.sql.Arrayobject in the Java programming language. <!-- end generic documentation --> <!-- start release-specific documentation --><!-- end release-specific documentation -->HSQLDB-Specific Information:
HSQLDB 1.7.2 does not support this feature. Calling this method always throws anSQLException.
- Parameters:
parameterIndex- the first parameter is 1, the second is 2, and so on
- Returns:
- the parameter value as an
Arrayobject in the Java programming language. If the value was SQLNULL, the valuenullis returned.
- Since:
- JDK 1.2 (JDK 1.1.x developers: read the new overview for jdbcPreparedStatement)
public BigDecimal getBigDecimal(String parameterName)
throws SQLException<!-- start generic documentation --> Retrieves the value of a JDBCNUMERICparameter as ajava.math.BigDecimalobject with as many digits to the right of the decimal point as the value contains. <!-- end generic documentation --> <!-- start release-specific documentation --><!-- end release-specific documentation -->HSQLDB-Specific Information:
HSQLDB 1.7.2 does not support this feature. Calling this method always throws anSQLException.
- Parameters:
parameterName- the name of the parameter
- Returns:
- the parameter value in full precision. If the value is SQL
NULL, the result isnull.
- Since:
- JDK 1.4, HSQLDB 1.7.0
- See Also:
setBigDecimal(String,BigDecimal)
public BigDecimal getBigDecimal(int parameterIndex)
throws SQLException<!-- start generic documentation --> Retrieves the value of the designated JDBCNUMERICparameter as ajava.math.BigDecimalobject with as many digits to the right of the decimal point as the value contains. <!-- end generic documentation --> <!-- start release-specific documentation --><!-- end release-specific documentation -->HSQLDB-Specific Information:
HSQLDB 1.7.2 does not support this feature. Calling this method always throws anSQLException.
- Parameters:
parameterIndex- the first parameter is 1, the second is 2, and so on
- Returns:
- the parameter value in full precision. If the value is SQL
NULL, the result isnull.
- Since:
- JDK 1.2 (JDK 1.1.x developers: read the new overview for jdbcPreparedStatement)
- See Also:
setBigDecimal(String,BigDecimal)
public BigDecimal getBigDecimal(int parameterIndex,
int scale)
throws SQLExceptionDeprecated. use
getBigDecimal(int parameterIndex)orgetBigDecimal(String parameterName)<!-- start generic documentation --> Retrieves the value of the designated JDBCNUMERICparameter as ajava.math.BigDecimalobject with scale digits to the right of the decimal point. <!-- end generic documentation --> <!-- start release-specific documentation --><!-- end release-specific documentation -->HSQLDB-Specific Information:
HSQLDB 1.7.2 does not support this feature. Calling this method always throws anSQLException.
- Parameters:
parameterIndex- the first parameter is 1, the second is 2, and so onscale- the number of digits to the right of the decimal point
- Returns:
- the parameter value. If the value is SQL
NULL, the result isnull.
- See Also:
setBigDecimal(String,BigDecimal)
public Blob getBlob(String parameterName)
throws SQLException<!-- start generic documentation --> Retrieves the value of a JDBCBLOBparameter as ajava.sql.Blobobject in the Java programming language. <!-- end generic documentation --> <!-- start release-specific documentation --><!-- end release-specific documentation -->HSQLDB-Specific Information:
HSQLDB 1.7.2 does not support this feature. Calling this method always throws anSQLException.
- Parameters:
parameterName- the name of the parameter
- Returns:
- the parameter value as a
Blobobject in the Java programming language. If the value was SQLNULL, the valuenullis returned.
- Since:
- JDK 1.4, HSQLDB 1.7.0
public Blob getBlob(int parameterIndex)
throws SQLException<!-- start generic documentation --> Retrieves the value of the designated JDBCBLOBparameter as ajava.sql.Blobobject in the Java programming language. <!-- end generic documentation --> <!-- start release-specific documentation --><!-- end release-specific documentation -->HSQLDB-Specific Information:
HSQLDB 1.7.2 does not support this feature. Calling this method always throws anSQLException.
- Parameters:
parameterIndex- the first parameter is 1, the second is 2, and so on
- Returns:
- the parameter value as a
Blobobject in the Java programming language. If the value was SQLNULL, the valuenullis returned.
- Since:
- JDK 1.2 (JDK 1.1.x developers: read the new overview for jdbcPreparedStatement)
public boolean getBoolean(String parameterName)
throws SQLException<!-- start generic documentation --> (JDBC4 modified:) Retrieves the value of a JDBCBITorBOOLEANparameter as abooleanin the Java programming language. <!-- end generic documentation --> <!-- start release-specific documentation --><!-- end release-specific documentation -->HSQLDB-Specific Information:
HSQLDB 1.7.2 does not support this feature. Calling this method always throws anSQLException.
- Parameters:
parameterName- the name of the parameter
- Returns:
- the parameter value. If the value is SQL
NULL, the result isfalse.
- Since:
- JDK 1.4, HSQLDB 1.7.0
- See Also:
setBoolean(String,boolean)
public boolean getBoolean(int parameterIndex)
throws SQLException<!-- start generic documentation --> Retrieves the value of the designated JDBCBITparameter as abooleanin the Java programming language. <!-- end generic documentation --> <!-- start release-specific documentation --><!-- end release-specific documentation -->HSQLDB-Specific Information:
HSQLDB 1.7.2 does not support this feature. Calling this method always throws anSQLException.
- Parameters:
parameterIndex- the first parameter is 1, the second is 2, and so on
- Returns:
- the parameter value. If the value is SQL
NULL, the result isfalse.
- See Also:
setBoolean(String,boolean)
public byte getByte(String parameterName)
throws SQLException<!-- start generic documentation --> Retrieves the value of a JDBCTINYINTparameter as abytein the Java programming language. <!-- end generic documentation --> <!-- start release-specific documentation --><!-- end release-specific documentation -->HSQLDB-Specific Information:
HSQLDB 1.7.2 does not support this feature. Calling this method always throws anSQLException.
- Parameters:
parameterName- the name of the parameter
- Returns:
- the parameter value. If the value is SQL
NULL, the result is0.
- Since:
- JDK 1.4, HSQLDB 1.7.0
- See Also:
setByte(String,byte)
public byte getByte(int parameterIndex)
throws SQLException<!-- start generic documentation --> Retrieves the value of the designated JDBCTINYINTparameter as abytein the Java programming language. <!-- end generic documentation --> <!-- start release-specific documentation --><!-- end release-specific documentation -->HSQLDB-Specific Information:
HSQLDB 1.7.2 does not support this feature. Calling this method always throws anSQLException.
- Parameters:
parameterIndex- the first parameter is 1, the second is 2, and so on
- Returns:
- the parameter value. If the value is SQL
NULL, the result is0.
- See Also:
setByte(String,byte)
public byte[] getBytes(String parameterName)
throws SQLException<!-- start generic documentation --> Retrieves the value of a JDBCBINARYorVARBINARYparameter as an array ofbytevalues in the Java programming language. <!-- end generic documentation --> <!-- start release-specific documentation --><!-- end release-specific documentation -->HSQLDB-Specific Information:
HSQLDB 1.7.2 does not support this feature. Calling this method always throws anSQLException.
- Parameters:
parameterName- the name of the parameter
- Returns:
- the parameter value. If the value is SQL
NULL, the result isnull.
- Since:
- JDK 1.4, HSQLDB 1.7.0
- See Also:
setBytes(String,byte[])
public byte[] getBytes(int parameterIndex)
throws SQLException<!-- start generic documentation --> Retrieves the value of the designated JDBCBINARYorVARBINARYparameter as an array ofbytevalues in the Java programming language. <!-- end generic documentation --> <!-- start release-specific documentation --><!-- end release-specific documentation -->HSQLDB-Specific Information:
HSQLDB 1.7.2 does not support this feature. Calling this method always throws anSQLException.
- Parameters:
parameterIndex- the first parameter is 1, the second is 2, and so on
- Returns:
- the parameter value. If the value is SQL
NULL, the result isnull.
- See Also:
setBytes(String,byte[])
public Clob getClob(String parameterName)
throws SQLException<!-- start generic documentation --> Retrieves the value of a JDBCCLOBparameter as ajava.sql.Clobobject in the Java programming language. <!-- end generic documentation --> <!-- start release-specific documentation --><!-- end release-specific documentation -->HSQLDB-Specific Information:
HSQLDB 1.7.2 does not support this feature. Calling this method always throws anSQLException.
- Parameters:
parameterName- the name of the parameter
- Returns:
- the parameter value as a
Clobobject in the Java programming language. If the value was SQLNULL, the valuenullis returned.
- Since:
- JDK 1.4, HSQLDB 1.7.0
public Clob getClob(int parameterIndex)
throws SQLException<!-- start generic documentation --> Retrieves the value of the designated JDBCCLOBparameter as ajava.sql.Clobobject in the Java programming language. <!-- end generic documentation --> <!-- start release-specific documentation --><!-- end release-specific documentation -->HSQLDB-Specific Information:
HSQLDB 1.7.2 does not support this feature. Calling this method always throws anSQLException.
- Parameters:
parameterIndex- the first parameter is 1, the second is 2, and so on
- Returns:
- the parameter value as a
Clobobject in the Java programming language. If the value was SQLNULL, the valuenullis returned.
- Since:
- JDK 1.2 (JDK 1.1.x developers: read the new overview for jdbcPreparedStatement)
public Date getDate(String parameterName)
throws SQLException<!-- start generic documentation --> Retrieves the value of a JDBCDATEparameter as ajava.sql.Dateobject. <!-- end generic documentation --> <!-- start release-specific documentation --><!-- end release-specific documentation -->HSQLDB-Specific Information:
HSQLDB 1.7.2 does not support this feature. Calling this method always throws anSQLException.
- Parameters:
parameterName- the name of the parameter
- Returns:
- the parameter value. If the value is SQL
NULL, the result isnull.
- Since:
- JDK 1.4, HSQLDB 1.7.0
- See Also:
setDate
public Date getDate(String parameterName,
Calendar cal)
throws SQLException<!-- start generic documentation --> Retrieves the value of a JDBCDATEparameter as ajava.sql.Dateobject, using the givenCalendarobject to construct the date. With aCalendarobject, the driver can calculate the date taking into account a custom timezone and locale. If noCalendarobject is specified, the d river uses the default timezone and locale. <!-- end generic documentation --> <!-- start release-specific documentation --><!-- end release-specific documentation -->HSQLDB-Specific Information:
HSQLDB 1.7.2 does not support this feature. Calling this method always throws anSQLException.
- Parameters:
parameterName- the name of the parametercal- theCalendarobject the driver will use to construct the date
- Returns:
- the parameter value. If the value is SQL
NULL, the result isnull.
- Since:
- JDK 1.4, HSQLDB 1.7.0
- See Also:
setDate
public Date getDate(int parameterIndex)
throws SQLException<!-- start generic documentation --> Retrieves the value of the designated JDBCDATEparameter as ajava.sql.Dateobject. <!-- end generic documentation --> <!-- start release-specific documentation --><!-- end release-specific documentation -->HSQLDB-Specific Information:
HSQLDB 1.7.2 does not support this feature. Calling this method always throws anSQLException.
- Parameters:
parameterIndex- the first parameter is 1, the second is 2, and so on
- Returns:
- the parameter value. If the value is SQL
NULL, the result isnull.
- See Also:
setDate
public Date getDate(int parameterIndex,
Calendar cal)
throws SQLException<!-- start generic documentation --> Retrieves the value of the designated JDBCDATEparameter as ajava.sql.Dateobject, using the givenCalendarobject to construct the date. With aCalendarobject, the driver can calculate the date taking into account a custom timezone and locale. If noCalendarobject is specified, the driver uses the default timezone and locale. <!-- end generic documentation --> <!-- start release-specific documentation --><!-- end release-specific documentation -->HSQLDB-Specific Information:
HSQLDB 1.7.2 does not support this feature. Calling this method always throws anSQLException.
- Parameters:
parameterIndex- the first parameter is 1, the second is 2, and so oncal- theCalendarobject the driver will use to construct the date
- Returns:
- the parameter value. If the value is SQL
NULL, the result isnull.
- Since:
- JDK 1.2 (JDK 1.1.x developers: read the new overview for jdbcPreparedStatement)
- See Also:
setDate
public double getDouble(String parameterName)
throws SQLException<!-- start generic documentation --> Retrieves the value of a JDBCDOUBLEparameter as adoublein the Java programming language. <!-- end generic documentation --> <!-- start release-specific documentation --><!-- end release-specific documentation -->HSQLDB-Specific Information:
HSQLDB 1.7.2 does not support this feature. Calling this method always throws anSQLException.
- Parameters:
parameterName- the name of the parameter
- Returns:
- the parameter value. If the value is SQL
NULL, the result is0.
- Since:
- JDK 1.4, HSQLDB 1.7.0
- See Also:
setDouble(String,double)
public double getDouble(int parameterIndex)
throws SQLException<!-- start generic documentation --> Retrieves the value of the designated JDBCDOUBLEparameter as adoublein the Java programming language. <!-- end generic documentation --> <!-- start release-specific documentation --><!-- end release-specific documentation -->HSQLDB-Specific Information:
HSQLDB 1.7.2 does not support this feature. Calling this method always throws anSQLException.
- Parameters:
parameterIndex- the first parameter is 1, the second is 2, and so on
- Returns:
- the parameter value. If the value is SQL
NULL, the result is0.
- See Also:
setDouble(String,double)
public float getFloat(String parameterName)
throws SQLException<!-- start generic documentation --> Retrieves the value of a JDBCFLOATparameter as afloatin the Java programming language. <!-- end generic documentation --> <!-- start release-specific documentation --><!-- end release-specific documentation -->HSQLDB-Specific Information:
HSQLDB 1.7.2 does not support this feature. Calling this method always throws anSQLException.
- Parameters:
parameterName- the name of the parameter
- Returns:
- the parameter value. If the value is SQL
NULL, the result is0.
- Since:
- JDK 1.4, HSQLDB 1.7.0
- See Also:
setFloat(String,float)
public float getFloat(int parameterIndex)
throws SQLException<!-- start generic documentation --> Retrieves the value of the designated JDBCFLOATparameter as afloatin the Java programming language. <!-- end generic documentation --> <!-- start release-specific documentation --><!-- end release-specific documentation -->HSQLDB-Specific Information:
HSQLDB 1.7.2 does not support this feature. Calling this method always throws anSQLException.
- Parameters:
parameterIndex- the first parameter is 1, the second is 2, and so on
- Returns:
- the parameter value. If the value is SQL
NULL, the result is0.
- See Also:
setFloat(String,float)
public int getInt(String parameterName)
throws SQLException<!-- start generic documentation --> Retrieves the value of a JDBCINTEGERparameter as anintin the Java programming language. <!-- end generic documentation --> <!-- start release-specific documentation --><!-- end release-specific documentation -->HSQLDB-Specific Information:
HSQLDB 1.7.2 does not support this feature. Calling this method always throws anSQLException.
- Parameters:
parameterName- the name of the parameter
- Returns:
- the parameter value. If the value is SQL
NULL, the result is0.
- Since:
- JDK 1.4, HSQLDB 1.7.0
- See Also:
setInt(String,int)
public int getInt(int parameterIndex)
throws SQLException<!-- start generic documentation --> Retrieves the value of the designated JDBCINTEGERparameter as anintin the Java programming language. <!-- end generic documentation --> <!-- start release-specific documentation --><!-- end release-specific documentation -->HSQLDB-Specific Information:
HSQLDB 1.7.2 does not support this feature. Calling this method always throws anSQLException.
- Parameters:
parameterIndex- the first parameter is 1, the second is 2, and so on
- Returns:
- the parameter value. If the value is SQL
NULL, the result is0.
- See Also:
setInt(String,int)
public long getLong(String parameterName)
throws SQLException<!-- start generic documentation --> Retrieves the value of a JDBCBIGINTparameter as alongin the Java programming language. <!-- end generic documentation --> <!-- start release-specific documentation --><!-- end release-specific documentation -->HSQLDB-Specific Information:
HSQLDB 1.7.2 does not support this feature. Calling this method always throws anSQLException.
- Parameters:
parameterName- the name of the parameter
- Returns:
- the parameter value. If the value is SQL
NULL, the result is0.
- Since:
- JDK 1.4, HSQLDB 1.7.0
- See Also:
setLong(String,long)
public long getLong(int parameterIndex)
throws SQLException<!-- start generic documentation --> Retrieves the value of the designated JDBCBIGINTparameter as alongin the Java programming language. <!-- end generic documentation --> <!-- start release-specific documentation --><!-- end release-specific documentation -->HSQLDB-Specific Information:
HSQLDB 1.7.2 does not support this feature. Calling this method always throws anSQLException.
- Parameters:
parameterIndex- the first parameter is 1, the second is 2, and so on
- Returns:
- the parameter value. If the value is SQL
NULL, the result is0.
- See Also:
setLong(String,long)
public Object getObject(String parameterName)
throws SQLException<!-- start generic documentation --> Retrieves the value of a parameter as anObjectin the Java programming language. If the value is an SQLNULL, the driver returns a Javanull. This method returns a Java object whose type corresponds to the JDBC type that was registered for this parameter using the methodregisterOutParameter. By registering the target JDBC type asjava.sql.Types.OTHER, this method can be used to read database-specific abstract data types. <!-- end generic documentation --> <!-- start release-specific documentation --><!-- end release-specific documentation -->HSQLDB-Specific Information:
HSQLDB 1.7.2 does not support this feature. Calling this method always throws anSQLException.
- Parameters:
parameterName- the name of the parameter
- Returns:
- A
java.lang.Objectholding the OUT parameter value.
- Since:
- JDK 1.4, HSQLDB 1.7.0
- See Also:
java.sql.Types,setObject
public Object getObject(String parameterName,
Map map)
throws SQLException<!-- start generic documentation --> Returns an object representing the value of OUT parameterparameterNameand usesmapfor the custom mapping of the parameter value. This method returns a Java object whose type corresponds to the JDBC type that was registered for this parameter using the methodregisterOutParameter. By registering the target JDBC type asjava.sql.Types.OTHER, this method can be used to read database-specific abstract data types. <!-- end generic documentation --> <!-- start release-specific documentation --><!-- end release-specific documentation -->HSQLDB-Specific Information:
HSQLDB 1.7.2 does not support this feature. Calling this method always throws anSQLException.
- Parameters:
parameterName- the name of the parametermap- the mapping from SQL type names to Java classes
- Returns:
- a
java.lang.Objectholding the OUT parameter value
- Since:
- JDK 1.4, HSQLDB 1.7.0
- See Also:
setObject
public Object getObject(int parameterIndex)
throws SQLException<!-- start generic documentation --> Retrieves the value of the designated parameter as anObjectin the Java programming language. If the value is an SQLNULL, the driver returns a Javanull. This method returns a Java object whose type corresponds to the JDBC type that was registered for this parameter using the methodregisterOutParameter. By registering the target JDBC type asjava.sql.Types.OTHER, this method can be used to read database-specific abstract data types. <!-- end generic documentation --> <!-- start release-specific documentation --><!-- end release-specific documentation -->HSQLDB-Specific Information:
HSQLDB 1.7.2 does not support this feature. Calling this method always throws anSQLException.
- Parameters:
parameterIndex- the first parameter is 1, the second is 2, and so on
- Returns:
- A
java.lang.Objectholding the OUT parameter value
- See Also:
java.sql.Types,setObject
public Object getObject(int parameterIndex,
Map map)
throws SQLException<!-- start generic documentation --> Returns an object representing the value of OUT parameterparameterIndexand usesmapfor the custom mapping of the parameter value. This method returns a Java object whose type corresponds to the JDBC type that was registered for this parameter using the methodregisterOutParameter. By registering the target JDBC type asjava.sql.Types.OTHER, this method can be used to read database-specific abstract data types. <!-- end generic documentation --> <!-- start release-specific documentation --><!-- end release-specific documentation -->HSQLDB-Specific Information:
HSQLDB 1.7.2 does not support this feature. Calling this method always throws anSQLException.
- Parameters:
parameterIndex- the first parameter is 1, the second is 2, and so onmap- the mapping from SQL type names to Java classes
- Returns:
- a
java.lang.Objectholding the OUT parameter value
- Since:
- JDK 1.2 (JDK 1.1.x developers: read the new overview for jdbcPreparedStatement)
- See Also:
setObject
public Ref getRef(String parameterName)
throws SQLException<!-- start generic documentation --> Retrieves the value of a JDBCREF(<structured-type>)parameter as aRefobject in the Java programming language. <!-- end generic documentation --> <!-- start release-specific documentation --><!-- end release-specific documentation -->HSQLDB-Specific Information:
HSQLDB 1.7.2 does not support this feature. Calling this method always throws anSQLException.
- Parameters:
parameterName- the name of the parameter
- Returns:
- the parameter value as a
Refobject in the Java programming language. If the value was SQLNULL, the valuenullis returned.
- Since:
- JDK 1.4, HSQLDB 1.7.0
public Ref getRef(int parameterIndex)
throws SQLException<!-- start generic documentation --> Retrieves the value of the designated JDBCREF(<structured-type>)parameter as ajava.sql.Refobject in the Java programming language. <!-- end generic documentation --> <!-- start release-specific documentation --><!-- end release-specific documentation -->HSQLDB-Specific Information:
HSQLDB 1.7.2 does not support this feature. Calling this method always throws anSQLException.
- Parameters:
parameterIndex- the first parameter is 1, the second is 2, and so on
- Returns:
- the parameter value as a
Refobject in the Java programming language. If the value was SQLNULL, the valuenullis returned.
- Since:
- JDK 1.2 (JDK 1.1.x developers: read the new overview for jdbcPreparedStatement)
public short getShort(String parameterName)
throws SQLException<!-- start generic documentation --> Retrieves the value of a JDBCSMALLINTparameter as ashortin the Java programming language. <!-- end generic documentation --> <!-- start release-specific documentation --><!-- end release-specific documentation -->HSQLDB-Specific Information:
HSQLDB 1.7.2 does not support this feature. Calling this method always throws anSQLException.
- Parameters:
parameterName- the name of the parameter
- Returns:
- the parameter value. If the value is SQL
NULL, the result is0.
- Since:
- JDK 1.4, HSQLDB 1.7.0
- See Also:
setShort(String,short)
public short getShort(int parameterIndex)
throws SQLException<!-- start generic documentation --> Retrieves the value of the designated JDBCSMALLINTparameter as ashortin the Java programming language. <!-- end generic documentation --> <!-- start release-specific documentation --><!-- end release-specific documentation -->HSQLDB-Specific Information:
HSQLDB 1.7.2 does not support this feature. Calling this method always throws anSQLException.
- Parameters:
parameterIndex- the first parameter is 1, the second is 2, and so on
- Returns:
- the parameter value. If the value is SQL
NULL, the result is0.
- See Also:
setShort(String,short)
public String getString(String parameterName)
throws SQLException<!-- start generic documentation --> Retrieves the value of a JDBCCHAR,VARCHAR, orLONGVARCHARparameter as aStringin the Java programming language. For the fixed-length type JDBCCHAR, theStringobject returned has exactly the same value the (JDBC4 clarification:) SQLCHARvalue had in the database, including any padding added by the database. <!-- end generic documentation --> <!-- start release-specific documentation --><!-- end release-specific documentation -->HSQLDB-Specific Information:
HSQLDB 1.7.2 does not support this feature. Calling this method always throws anSQLException.
- Parameters:
parameterName- the name of the parameter
- Returns:
- the parameter value. If the value is SQL
NULL, the result isnull.
- Since:
- JDK 1.4, HSQLDB 1.7.0
- See Also:
setString(String,String)
public String getString(int parameterIndex)
throws SQLException<!-- start generic documentation --> Retrieves the value of the designated JDBCCHAR,VARCHAR, orLONGVARCHARparameter as aStringin the Java programming language. For the fixed-length type JDBCCHAR, theStringobject returned has exactly the same value the (JDBC4 clarification:) SQLCHARvalue had in the database, including any padding added by the database. <!-- end generic documentation --> <!-- start release-specific documentation --><!-- end release-specific documentation -->HSQLDB-Specific Information:
HSQLDB 1.7.2 does not support this feature. Calling this method always throws anSQLException.
- Parameters:
parameterIndex- the first parameter is 1, the second is 2, and so on
- Returns:
- the parameter value. If the value is SQL
NULL, the result isnull.
- See Also:
setString(String,String)
public Time getTime(String parameterName)
throws SQLException<!-- start generic documentation --> Retrieves the value of a JDBCTIMEparameter as ajava.sql.Timeobject. <!-- end generic documentation --> <!-- start release-specific documentation --><!-- end release-specific documentation -->HSQLDB-Specific Information:
HSQLDB 1.7.2 does not support this feature. Calling this method always throws anSQLException.
- Parameters:
parameterName- the name of the parameter
- Returns:
- the parameter value. If the value is SQL
NULL, the result isnull.
- Since:
- JDK 1.4, HSQLDB 1.7.0
- See Also:
setTime
public Time getTime(String parameterName,
Calendar cal)
throws SQLException<!-- start generic documentation --> Retrieves the value of a JDBCTIMEparameter as ajava.sql.Timeobject, using the givenCalendarobject to construct the time. With aCalendarobject, the driver can calculate the time taking into account a custom timezone and locale. If noCalendarobject is specified, the driver uses the default timezone and locale. <!-- end generic documentation --> <!-- start release-specific documentation --><!-- end release-specific documentation -->HSQLDB-Specific Information:
HSQLDB 1.7.2 does not support this feature. Calling this method always throws anSQLException.
- Parameters:
parameterName- the name of the parametercal- theCalendarobject the driver will use to construct the time
- Returns:
- the parameter value; if the value is SQL
NULL, the result isnull.
- Since:
- JDK 1.4, HSQLDB 1.7.0
- See Also:
setTime
public Time getTime(int parameterIndex)
throws SQLException<!-- start generic documentation --> Retrieves the value of the designated JDBCTIMEparameter as ajava.sql.Timeobject. <!-- end generic documentation --> <!-- start release-specific documentation --><!-- end release-specific documentation -->HSQLDB-Specific Information:
HSQLDB 1.7.2 does not support this feature. Calling this method always throws anSQLException.
- Parameters:
parameterIndex- the first parameter is 1, the second is 2, and so on
- Returns:
- the parameter value. If the value is SQL
NULL, the result isnull.
- See Also:
setTime
public Time getTime(int parameterIndex,
Calendar cal)
throws SQLException<!-- start generic documentation --> Retrieves the value of the designated JDBCTIMEparameter as ajava.sql.Timeobject, using the givenCalendarobject to construct the time. With aCalendarobject, the driver can calculate the time taking into account a custom timezone and locale. If noCalendarobject is specified, the driver uses the default timezone and locale. <!-- end generic documentation --> <!-- start release-specific documentation --><!-- end release-specific documentation -->HSQLDB-Specific Information:
HSQLDB 1.7.2 does not support this feature. Calling this method always throws anSQLException.
- Parameters:
parameterIndex- the first parameter is 1, the second is 2, and so oncal- theCalendarobject the driver will use to construct the time
- Returns:
- the parameter value; if the value is SQL
NULL, the result isnull.
- Since:
- JDK 1.2 (JDK 1.1.x developers: read the new overview for jdbcPreparedStatement)
- See Also:
setTime
public Timestamp getTimestamp(String parameterName)
throws SQLException<!-- start generic documentation --> Retrieves the value of a JDBCTIMESTAMPparameter as ajava.sql.Timestampobject. <!-- end generic documentation --> <!-- start release-specific documentation --><!-- end release-specific documentation -->HSQLDB-Specific Information:
HSQLDB 1.7.2 does not support this feature. Calling this method always throws anSQLException.
- Parameters:
parameterName- the name of the parameter
- Returns:
- the parameter value. If the value is SQL
NULL, the result isnull.
- Since:
- JDK 1.4, HSQLDB 1.7.0
- See Also:
setTimestamp
public Timestamp getTimestamp(String parameterName,
Calendar cal)
throws SQLException<!-- start generic documentation --> Retrieves the value of a JDBCTIMESTAMPparameter as ajava.sql.Timestampobject, using the givenCalendarobject to construct theTimestampobject. With aCalendarobject, the driver can calculate the timestamp taking into account a custom timezone and locale. If noCalendarobject is specified, the driver uses the default timezone and locale. <!-- end generic documentation --> <!-- start release-specific documentation --><!-- end release-specific documentation -->HSQLDB-Specific Information:
HSQLDB 1.7.2 does not support this feature. Calling this method always throws anSQLException.
- Parameters:
parameterName- the name of the parametercal- theCalendarobject the driver will use to construct the timestamp
- Returns:
- the parameter value. If the value is SQL
NULL, the result isnull.
- Since:
- JDK 1.4, HSQLDB 1.7.0
- See Also:
setTimestamp
public Timestamp getTimestamp(int parameterIndex)
throws SQLException<!-- start generic documentation --> Retrieves the value of the designated JDBCTIMESTAMPparameter as ajava.sql.Timestampobject. <!-- end generic documentation --> <!-- start release-specific documentation --><!-- end release-specific documentation -->HSQLDB-Specific Information:
HSQLDB 1.7.2 does not support this feature. Calling this method always throws anSQLException.
- Parameters:
parameterIndex- the first parameter is 1, the second is 2, and so on
- Returns:
- the parameter value. If the value is SQL
NULL, the result isnull.
- See Also:
setTimestamp
public Timestamp getTimestamp(int parameterIndex,
Calendar cal)
throws SQLException<!-- start generic documentation --> Retrieves the value of the designated JDBCTIMESTAMPparameter as ajava.sql.Timestampobject, using the givenCalendarobject to construct theTimestampobject. With aCalendarobject, the driver can calculate the timestamp taking into account a custom timezone and locale. If noCalendarobject is specified, the driver uses the default timezone and locale. <!-- end generic documentation --> <!-- start release-specific documentation --><!-- end release-specific documentation -->HSQLDB-Specific Information:
HSQLDB 1.7.2 does not support this feature. Calling this method always throws anSQLException.
- Parameters:
parameterIndex- the first parameter is 1, the second is 2, and so oncal- theCalendarobject the driver will use to construct the timestamp
- Returns:
- the parameter value. If the value is SQL
NULL, the result isnull.
- Since:
- JDK 1.2 (JDK 1.1.x developers: read the new overview for jdbcPreparedStatement)
- See Also:
setTimestamp
public java.net.URL getURL(String parameterName)
throws SQLException<!-- start generic documentation --> Retrieves the value of a JDBCDATALINKparameter as ajava.net.URLobject. <!-- end generic documentation --> <!-- start release-specific documentation --><!-- end release-specific documentation -->HSQLDB-Specific Information:
HSQLDB 1.7.2 does not support this feature. Calling this method always throws anSQLException.
- Parameters:
parameterName- the name of the parameter
- Returns:
- the parameter value as a
java.net.URLobject in the Java programming language. If the value was SQLNULL, the valuenullis returned.
- Since:
- JDK 1.4, HSQLDB 1.7.0
- See Also:
setURL(String,URL)
public java.net.URL getURL(int parameterIndex)
throws SQLException<!-- start generic documentation --> Retrieves the value of the designated JDBCDATALINKparameter as ajava.net.URLobject. <!-- end generic documentation --> <!-- start release-specific documentation --><!-- end release-specific documentation -->HSQLDB-Specific Information:
HSQLDB 1.7.2 does not support this feature. Calling this method always throws anSQLException.
- Parameters:
parameterIndex- the first parameter is 1, the second is 2,...
- Returns:
- a
java.net.URLobject that represents the JDBCDATALINKvalue used as the designated parameter
- Since:
- JDK 1.4, HSQLDB 1.7.0
- See Also:
setURL(String,URL)
public void registerOutParameter(String parameterName,
int sqlType)
throws SQLException<!-- start generic documentation --> Registers the OUT parameter namedparameterNameto the JDBC typesqlType. All OUT parameters must be registered before a stored procedure is executed. The JDBC type specified bysqlTypefor an OUT parameter determines the Java type that must be used in thegetmethod to read the value of that parameter. If the JDBC type expected to be returned to this output parameter is specific to this particular database,sqlTypeshould bejava.sql.Types.OTHER. The methodgetObjectretrieves the value. <!-- end generic documentation --> <!-- start release-specific documentation --><!-- end release-specific documentation -->HSQLDB-Specific Information:
HSQLDB 1.7.2 does not support this feature. Calling this method always throws anSQLException.
- Parameters:
parameterName- the name of the parametersqlType- the JDBC type code defined byjava.sql.Types. If the parameter is of JDBC typeNUMERICorDECIMAL, the version ofregisterOutParameterthat accepts a scale value should be used.
- Since:
- JDK 1.4, HSQL 1.7.0
- See Also:
java.sql.Types
public void registerOutParameter(String parameterName,
int sqlType,
String typeName)
throws SQLException<!-- start generic documentation --> Registers the designated output parameter. This version of the methodregisterOutParametershould be used for a user-named or REF output parameter. Examples of user-named types include: STRUCT, DISTINCT, JAVA_OBJECT, and named array types. (JDBC4 clarification:) All OUT parameters must be registered before a stored procedure is executed. For a user-named parameter the fully-qualified SQL type name of the parameter should also be given, while a REF parameter requires that the fully-qualified type name of the referenced type be given. A JDBC driver that does not need the type code and type name information may ignore it. To be portable, however, applications should always provide these values for user-named and REF parameters. Although it is intended for user-named and REF parameters, this method may be used to register a parameter of any JDBC type. If the parameter does not have a user-named or REF type, the typeName parameter is ignored. Note: When reading the value of an out parameter, you must use thegetXXXmethod whose Java type XXX corresponds to the parameter's registered SQL type. <!-- end generic documentation --> <!-- start release-specific documentation --><!-- end release-specific documentation -->HSQLDB-Specific Information:
HSQLDB 1.7.2 does not support this feature. Calling this method always throws anSQLException.
- Parameters:
parameterName- the name of the parametersqlType- a value fromjava.sql.TypestypeName- the fully-qualified name of an SQL structured type
- Since:
- JDK 1.4, HSQL 1.7.0
- See Also:
java.sql.Types
public void registerOutParameter(String parameterName,
int sqlType,
int scale)
throws SQLException<!-- start generic documentation --> Registers the parameter namedparameterNameto be of JDBC typesqlType. (JDBC4 clarification:) All OUT parameters must be registered before a stored procedure is executed. The JDBC type specified bysqlTypefor an OUT parameter determines the Java type that must be used in thegetmethod to read the value of that parameter. This version ofregisterOutParametershould be used when the parameter is of JDBC typeNUMERICorDECIMAL. <!-- end generic documentation --> <!-- start release-specific documentation --><!-- end release-specific documentation -->HSQLDB-Specific Information:
HSQLDB 1.7.2 does not support this feature. Calling this method always throws anSQLException.
- Parameters:
parameterName- the name of the parametersqlType- SQL type code defined byjava.sql.Types.scale- the desired number of digits to the right of the decimal point. It must be greater than or equal to zero.
- Since:
- JDK 1.4, HSQLDB 1.7.0
- See Also:
java.sql.Types
public void registerOutParameter(int parameterIndex,
int sqlType)
throws SQLException<!-- start generic documentation --> Registers the OUT parameter in ordinal positionparameterIndexto the JDBC typesqlType. All OUT parameters must be registered before a stored procedure is executed. The JDBC type specified bysqlTypefor an OUT parameter determines the Java type that must be used in thegetmethod to read the value of that parameter. If the JDBC type expected to be returned to this output parameter is specific to this particular database,sqlTypeshould bejava.sql.Types.OTHER. The methodgetObjectretrieves the value. <!-- end generic documentation --> <!-- start release-specific documentation --><!-- end release-specific documentation -->HSQLDB-Specific Information:
HSQLDB 1.7.2 does not support this feature. Calling this method always throws anSQLException.
- Parameters:
parameterIndex- the first parameter is 1, the second is 2, and so onsqlType- the JDBC type code defined byjava.sql.Types. If the parameter is of JDBC typeNUMERICorDECIMAL, the version ofregisterOutParameterthat accepts a scale value should be used.
- See Also:
java.sql.Types
public void registerOutParameter(int parameterIndex,
int sqlType,
String typeName)
throws SQLException<!-- start generic documentation --> Registers the designated output parameter. This version of the methodregisterOutParametershould be used for a user-defined orREFoutput parameter. Examples of user-defined types include:STRUCT,DISTINCT,JAVA_OBJECT, and named array types. (JDBC4 claraification:) All OUT parameters must be registered before a stored procedure is executed. For a user-defined parameter, the fully-qualified SQL type name of the parameter should also be given, while aREFparameter requires that the fully-qualified type name of the referenced type be given. A JDBC driver that does not need the type code and type name information may ignore it. To be portable, however, applications should always provide these values for user-defined andREFparameters. Although it is intended for user-defined andREFparameters, this method may be used to register a parameter of any JDBC type. If the parameter does not have a user-defined orREFtype, the typeName parameter is ignored. Note: When reading the value of an out parameter, you must use the getter method whose Java type corresponds to the parameter's registered SQL type. <!-- end generic documentation --> <!-- start release-specific documentation --><!-- end release-specific documentation -->HSQLDB-Specific Information:
HSQLDB 1.7.2 does not support this feature. Calling this method always throws anSQLException.
- Parameters:
parameterIndex- the first parameter is 1, the second is 2,...sqlType- a value fromjava.sql.TypestypeName- the fully-qualified name of an SQL structured type
- Since:
- JDK 1.2 (JDK 1.1.x developers: read the new overview for jdbcPreparedStatement)
- See Also:
java.sql.Types
public void registerOutParameter(int parameterIndex,
int sqlType,
int scale)
throws SQLException<!-- start generic documentation --> Registers the parameter in ordinal positionparameterIndexto be of JDBC typesqlType. This method must be called before a stored procedure is executed. The JDBC type specified bysqlTypefor an OUT parameter determines the Java type that must be used in thegetmethod to read the value of that parameter. This version ofregisterOutParametershould be used when the parameter is of JDBC typeNUMERICorDECIMAL. <!-- end generic documentation --> <!-- start release-specific documentation --><!-- end release-specific documentation -->HSQLDB-Specific Information:
HSQLDB 1.7.2 does not support this feature. Calling this method always throws anSQLException.
- Parameters:
parameterIndex- the first parameter is 1, the second is 2, and so onsqlType- the SQL type code defined byjava.sql.Types.scale- the desired number of digits to the right of the decimal point. It must be greater than or equal to zero.
- See Also:
java.sql.Types
public void setAsciiStream(String parameterName,
java.io.InputStream x,
int length)
throws SQLException<!-- start generic documentation --> 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. <!-- end generic documentation --> <!-- start release-specific documentation --><!-- end release-specific documentation -->HSQLDB-Specific Information:
Starting with 1.7.2, HSLQDB supports this.
- Parameters:
parameterName- the name of the parameterx- the Java input stream that contains the ASCII parameter valuelength- the number of bytes in the stream
- Since:
- JDK 1.4, HSQLDB 1.7.0
public void setBigDecimal(String parameterName,
BigDecimal x)
throws SQLException<!-- start generic documentation --> Sets the designated parameter to the givenjava.math.BigDecimalvalue. The driver converts this to an SQLNUMERICvalue when it sends it to the database. <!-- end generic documentation --> <!-- start release-specific documentation --><!-- end release-specific documentation -->HSQLDB-Specific Information:
Starting with 1.7.2, HSLQDB supports this.
- Parameters:
parameterName- the name of the parameterx- the parameter value
- Since:
- JDK 1.4, HSQLDB 1.7.0
- See Also:
getBigDecimal
public void setBinaryStream(String parameterName,
java.io.InputStream x,
int length)
throws SQLException<!-- start generic documentation --> 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. <!-- end generic documentation --> <!-- start release-specific documentation --><!-- end release-specific documentation -->HSQLDB-Specific Information:
Starting with 1.7.2, HSLQDB supports this.
- Parameters:
parameterName- the name of the parameterx- the java input stream which contains the binary parameter valuelength- the number of bytes in the stream
- Since:
- JDK 1.4, HSQLDB 1.7.0
public void setBoolean(String parameterName,
boolean x)
throws SQLException<!-- start generic documentation --> Sets the designated parameter to the given Javabooleanvalue. (JDBC4 clarification:) The driver converts this to an SQLBITorBOOLEANvalue when it sends it to the database. <!-- end generic documentation --> <!-- start release-specific documentation --><!-- end release-specific documentation -->HSQLDB-Specific Information:
Starting with 1.7.2, HSLQDB supports this.
- Parameters:
parameterName- the name of the parameterx- the parameter value
- Since:
- JDK 1.4, HSQLDB 1.7.0
- See Also:
getBoolean
public void setByte(String parameterName,
byte x)
throws SQLException<!-- start generic documentation --> Sets the designated parameter to the given Javabytevalue. The driver converts this to an SQLTINYINTvalue when it sends it to the database. <!-- end generic documentation --> <!-- start release-specific documentation --><!-- end release-specific documentation -->HSQLDB-Specific Information:
Starting with 1.7.2, HSLQDB supports this.
- Parameters:
parameterName- the name of the parameterx- the parameter value
- Since:
- JDK 1.4, HSQLDB 1.7.0
- See Also:
getByte
public void setBytes(String parameterName,
byte[] x)
throws SQLException<!-- start generic documentation --> 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. <!-- end generic documentation --> <!-- start release-specific documentation --><!-- end release-specific documentation -->HSQLDB-Specific Information:
Starting with 1.7.2, HSLQDB supports this.
- Parameters:
parameterName- the name of the parameterx- the parameter value
- Since:
- JDK 1.4, HSQLDB 1.7.0
- See Also:
getBytes
public void setCharacterStream(String parameterName,
java.io.Reader reader,
int length)
throws SQLException<!-- start generic documentation --> 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. <!-- end generic documentation --> <!-- start release-specific documentation --><!-- end release-specific documentation -->HSQLDB-Specific Information:
Starting with 1.7.2, HSLQDB supports this.
- Parameters:
parameterName- the name of the parameterreader- thejava.io.Readerobject that contains the UNICODE data used as the designated parameterlength- the number of characters in the stream
- Since:
- JDK 1.4, HSQLDB 1.7.0
public void setDate(String parameterName,
Date x)
throws SQLException<!-- start generic documentation --> (JDBC4 clarification:) Sets the designated parameter to the givenjava.sql.Datevalue using the default time zone of the virtual machine that is running the application. The driver converts this to an SQLDATEvalue when it sends it to the database. <!-- end generic documentation --> <!-- start release-specific documentation --><!-- end release-specific documentation -->HSQLDB-Specific Information:
Starting with 1.7.2, HSLQDB supports this.
- Parameters:
parameterName- the name of the parameterx- the parameter value
- Since:
- JDK 1.4, HSQLDB 1.7.0
- See Also:
getDate
public void setDate(String parameterName,
Date x,
Calendar cal)
throws SQLException<!-- start generic documentation --> 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. <!-- end generic documentation --> <!-- start release-specific documentation --><!-- end release-specific documentation -->HSQLDB-Specific Information:
Starting with 1.7.2, HSLQDB supports this.
- Parameters:
parameterName- the name of the parameterx- the parameter valuecal- theCalendarobject the driver will use to construct the date
- Since:
- JDK 1.4, HSQLDB 1.7.0
- See Also:
getDate
public void setDouble(String parameterName,
double x)
throws SQLException<!-- start generic documentation --> Sets the designated parameter to the given Javadoublevalue. The driver converts this to an SQLDOUBLEvalue when it sends it to the database. <!-- end generic documentation --> <!-- start release-specific documentation --><!-- end release-specific documentation -->HSQLDB-Specific Information:
Starting with 1.7.2, HSLQDB supports this.
- Parameters:
parameterName- the name of the parameterx- the parameter value
- Since:
- JDK 1.4, HSQLDB 1.7.0
- See Also:
getDouble
public void setFloat(String parameterName,
float x)
throws SQLException<!-- start generic documentation --> Sets the designated parameter to the given Javafloatvalue. The driver converts this to an SQLFLOATvalue when it sends it to the database. <!-- end generic documentation --> <!-- start release-specific documentation --><!-- end release-specific documentation -->HSQLDB-Specific Information:
Starting with 1.7.2, HSLQDB supports this.
- Parameters:
parameterName- the name of the parameterx- the parameter value
- Since:
- JDK 1.4, HSQLDB 1.7.0
- See Also:
getFloat
public void setInt(String parameterName,
int x)
throws SQLException<!-- start generic documentation --> Sets the designated parameter to the given Javaintvalue. The driver converts this to an SQLINTEGERvalue when it sends it to the database. <!-- end generic documentation --> <!-- start release-specific documentation --><!-- end release-specific documentation -->HSQLDB-Specific Information:
Starting with 1.7.2, HSLQDB supports this.
- Parameters:
parameterName- the name of the parameterx- the parameter value
- Since:
- JDK 1.4, HSQLDB 1.7.0
- See Also:
getInt
public void setLong(String parameterName,
long x)
throws SQLException<!-- start generic documentation --> Sets the designated parameter to the given Javalongvalue. The driver converts this to an SQLBIGINTvalue when it sends it to the database. <!-- end generic documentation --> <!-- start release-specific documentation --><!-- end release-specific documentation -->HSQLDB-Specific Information:
Starting with 1.7.2, HSLQDB supports this.
- Parameters:
parameterName- the name of the parameterx- the parameter value
- Since:
- JDK 1.4, HSQLDB 1.7.0
- See Also:
getLong
public void setNull(String parameterName,
int sqlType)
throws SQLException<!-- start generic documentation --> Sets the designated parameter to SQLNULL. Note: You must specify the parameter's SQL type. <!-- end generic documentation --> <!-- start release-specific documentation --><!-- end release-specific documentation -->HSQLDB-Specific Information:
Starting with 1.7.2, HSLQDB supports this.
- Parameters:
parameterName- the name of the parametersqlType- the SQL type code defined injava.sql.Types
- Since:
- JDK 1.4, HSQLDB 1.7.0
public void setNull(String parameterName,
int sqlType,
String typeName)
throws SQLException<!-- start generic documentation --> Sets the designated parameter to SQLNULL. This version of the methodsetNullshould be used for user-defined types andREFtype 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 aNULLuser-defined orREFparameter. In the case of a user-defined type the name is the type name of the parameter itself. For aREFparameter, 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 andRefparameters, this method may be used to set a null parameter of any JDBC type. If the parameter does not have a user-defined orREFtype, the giventypeNameis ignored. <!-- end generic documentation --> <!-- start release-specific documentation --><!-- end release-specific documentation -->HSQLDB-Specific Information:
Starting with 1.7.2, HSLQDB supports this.
- Parameters:
parameterName- the name of the parametersqlType- 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 SQLREFvalue
- Since:
- JDK 1.4, HSQLDB 1.7.0
public void setObject(String parameterName,
Object x)
throws SQLException<!-- start generic documentation --> Sets the value of the designated parameter with the given object. The second parameter must be of typeObject; therefore, thejava.langequivalent objects should be used for built-in types. The JDBC specification specifies a standard mapping from JavaObjecttypes 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 interfaceSQLData, 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. <!-- end generic documentation --> <!-- start release-specific documentation --><!-- end release-specific documentation -->HSQLDB-Specific Information:
Starting with 1.7.2, HSLQDB supports this.
- Parameters:
parameterName- the name of the parameterx- the object containing the input parameter value
- Since:
- JDK 1.4, HSQLDB 1.7.0
- See Also:
getObject
public void setObject(String parameterName,
Object x,
int targetSqlType)
throws SQLException<!-- start generic documentation --> 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. <!-- end generic documentation --> <!-- start release-specific documentation --><!-- end release-specific documentation -->HSQLDB-Specific Information:
Starting with 1.7.2, HSLQDB supports this.
- Parameters:
parameterName- the name of the parameterx- the object containing the input parameter valuetargetSqlType- the SQL type (as defined in java.sql.Types) to be sent to the database
- Since:
- JDK 1.4, HSQLDB 1.7.0
- See Also:
getObject
public void setObject(String parameterName,
Object x,
int targetSqlType,
int scale)
throws SQLException<!-- start generic documentation --> Sets the value of the designated parameter with the given object. The second argument must be an object type; for integral values, thejava.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 interfaceSQLData), 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 datatabase- specific abstract data types. <!-- end generic documentation --> <!-- start release-specific documentation --><!-- end release-specific documentation -->HSQLDB-Specific Information:
Starting with 1.7.2, HSLQDB supports this.
- Parameters:
parameterName- the name of the parameterx- 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.
- Since:
- JDK 1.4, HSQLDB 1.7.0
- See Also:
java.sql.Types,getObject
public void setShort(String parameterName,
short x)
throws SQLException<!-- start generic documentation --> Sets the designated parameter to the given Javashortvalue. The driver converts this to an SQLSMALLINTvalue when it sends it to the database. <!-- end generic documentation --> <!-- start release-specific documentation --><!-- end release-specific documentation -->HSQLDB-Specific Information:
Starting with 1.7.2, HSLQDB supports this.
- Parameters:
parameterName- the name of the parameterx- the parameter value
- Since:
- JDK 1.4, HSQLDB 1.7.0
- See Also:
getShort
public void setString(String parameterName,
String x)
throws SQLException<!-- start generic documentation --> 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. <!-- end generic documentation --> <!-- start release-specific documentation --><!-- end release-specific documentation -->HSQLDB-Specific Information:
Starting with 1.7.2, HSLQDB supports this.
- Parameters:
parameterName- the name of the parameterx- the parameter value
- Since:
- JDK 1.4, HSQLDB 1.7.0
- See Also:
getString
public void setTime(String parameterName,
Time x)
throws SQLException<!-- start generic documentation --> Sets the designated parameter to the givenjava.sql.Timevalue. The driver converts this to an SQLTIMEvalue when it sends it to the database. <!-- end generic documentation --> <!-- start release-specific documentation --><!-- end release-specific documentation -->HSQLDB-Specific Information:
Starting with 1.7.2, HSLQDB supports this.
- Parameters:
parameterName- the name of the parameterx- the parameter value
- Since:
- JDK 1.4, HSQLDB 1.7.0
- See Also:
getTime
public void setTime(String parameterName,
Time x,
Calendar cal)
throws SQLException<!-- start generic documentation --> 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. <!-- end generic documentation --> <!-- start release-specific documentation --><!-- end release-specific documentation -->HSQLDB-Specific Information:
Starting with 1.7.2, HSLQDB supports this.
- Parameters:
parameterName- the name of the parameterx- the parameter valuecal- theCalendarobject the driver will use to construct the time
- Since:
- JDK 1.4, HSQLDB 1.7.0
- See Also:
getTime
public void setTimestamp(String parameterName,
Timestamp x)
throws SQLException<!-- start generic documentation --> Sets the designated parameter to the givenjava.sql.Timestampvalue. The driver converts this to an SQLTIMESTAMPvalue when it sends it to the database. <!-- end generic documentation --> <!-- start release-specific documentation --><!-- end release-specific documentation -->HSQLDB-Specific Information:
Starting with 1.7.2, HSLQDB supports this.
- Parameters:
parameterName- the name of the parameterx- the parameter value
- Since:
- JDK 1.4, HSQLDB 1.7.0
- See Also:
getTimestamp
public void setTimestamp(String parameterName,
Timestamp x,
Calendar cal)
throws SQLException<!-- start generic documentation --> 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. <!-- end generic documentation --> <!-- start release-specific documentation --><!-- end release-specific documentation -->HSQLDB-Specific Information:
Starting with 1.7.2, HSLQDB supports this.
- Parameters:
parameterName- the name of the parameterx- the parameter valuecal- theCalendarobject the driver will use to construct the timestamp
- Since:
- JDK 1.4, HSQLDB 1.7.0
- See Also:
getTimestamp
public void setURL(String parameterName,
java.net.URL val)
throws SQLException<!-- start generic documentation --> Sets the designated parameter to the givenjava.net.URLobject. The driver converts this to an SQLDATALINKvalue when it sends it to the database. <!-- end generic documentation --> <!-- start release-specific documentation --><!-- end release-specific documentation -->HSQLDB-Specific Information:
HSQLDB 1.7.2 does not support this feature. Calling this method always throws anSQLException.
- Parameters:
parameterName- the name of the parameterval- the parameter value
- Since:
- JDK 1.4, HSQLDB 1.7.0
- See Also:
getURL
public boolean wasNull()
throws SQLException<!-- start generic documentation --> Retrieves whether the last OUT parameter read had the value of SQLNULL. Note that this method should be called only after calling a getter method; otherwise, there is no value to use in determining whether it isnullor not. <!-- end generic documentation --> <!-- start release-specific documentation --><!-- end release-specific documentation -->HSQLDB-Specific Information:
HSQLDB 1.7.2 does not support this feature. Calling this method always throws anSQLException.
- Returns:
trueif the last parameter read was SQLNULL;falseotherwise