org.hsqldb.jdbc.jdbcStatement
org.hsqldb.jdbc.jdbcPreparedStatement
org.hsqldb.jdbc.jdbcCallableStatement
|
|||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||
java.lang.Object
The interface used to execute SQL stored procedures. The JDBC API provides a stored procedure SQL escape syntax that allows stored procedures to be called in a standard way for all RDBMSs. This escape syntax has one form that includes a result parameter and one that does not. If used, the result parameter must be registered as an OUT parameter. The other parameters can be used for input, output or both. Parameters are referred to sequentially, by number, with the first parameter being 1.
{?= 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.
HSQLDB-Specific Information:
Starting with HSQLDB 1.7.2, the JDBC CallableStatement interface
implementation has been broken out of the jdbcPreparedStatement class
into this one. Some of the previously unsupported features of this
interface are now supported, such as the parameterName-based setter
methods. More importantly, however, JDBC CallableStatement objects are now
backed in the engine core using an underlying true precompiled parameteric
representation. As such, there are significant performance gains to
be had by using CallableStatement over Statement objects if a CALL statement
is to be executed more than a small number of times. Moreover, although not
yet supported, the internal work has opened the door for support of
OUT parameters for retrieving Java method return values, as well the
generation and retrieval of multiple results in response to the execution
of a CallableStatement object. Indeed, the getter methods of this class,
although not fully supported yet, report more accurate exceptions, stating
that index values are out of range, parameter names are not found or
that the indicated parameters have not been registered. Similarly,
the registerOutParameter methods report more accurately, throwing
exceptions indicating range violation or incompatible parameter mode,
rather than simply indicating the operation is totally
unsupported. This lays the foundation for work in 1.7.3 to implement
greater support for OUT (and possibly IN OUT) parameters, as well as
multiple results, under CallableStatement execution.
As with many DBMS, support for stored procedures is not provided in
a completely standard fashion.
Beyond the XOpen/ODBC extended scalar functions, stored procedures are
typically supported in ways that vary greatly from one DBMS implementation
to the next. So, it is almost guaranteed that the code for a stored
procedure written under a specific DBMS product will not work without
at least some modification in the context of another vendor's product
or even across a single vendor's product lines. Moving stored procedures
from one DBMS product line to another almost invariably involves complex
porting issues and often may not be possible at all. Be warned.
At present, HSQLDB stored procedures map directly onto the methods of
compiled Java classes found on the classpath of the engine. This is done
in a non-standard but fairly efficient way by issuing a class
grant (and possibly method aliases) of the form:
These features definitely are not permanent, as more general and powerful
mechanisms will be offered in a future release. As such, it is recommended
to use them only as a temporary convenience, for instance by writing
HSQLDB-specific adapter methods that in turn call the real logic
of an underlying generalized SQL stored procedure libarary.
Here is a very simple example of an HSQLDB stored procedure returning a
custom built result set:
(boucherb@users)
GRANT ALL ON CLASS "package.class" TO [<user-name> | PUBLIC]
CREATE ALIAS <call-alias> FOR "package.class.method" -- optional
This 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. Up to
and including HSQLDB 1.7.2, no support is provided to deterministically
resolve overloaded method names, and there can be issues with inherited
methods as well, so it is strongly recommended that developers creating
stored procedure library classes for HSQLDB simply avoid designs such
that the SQL stored procedure call interface includes:
Also, please recall that, as stated above, OUT and
IN OUT parameters are not yet supported due to lack of
low level support for this in the engine. In fact, the HSQLDB stored
procedure call mechanism is essentially a thin wrap of the HSQLDB SQL
function call mechanism, in combination with the more general HSQLDB
SQL expression evaluation mechanism, allowing simple SQL expressions,
possibly containing Java method invocations, to be evaluated outside of
an INSERT, UPDATE, DELETE or
SELECT statement context. That is, issuing a
CALL statement returning an opaque (OTHER type) or known
scalar object reference (an instance of a Java class automatically mapped
to a supported HSQLDB data type) 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, 1.7.2 further provides the ability to materialize
a custom-built result of arbitrary arity in response to a stored procedure
execution. In this case, the stored procedure's Java method descriptor
must specify a return type of java.lang.Object or, preferably for
metadata reporting, org.hsqldb.jdbcResultSet. When HSQLDB detects that
the class of the Object returned by evaluating a CALL expression is
an instance of jdbcResultSet, an automatic internal unwrapping is performed,
such that the arity of the underlying result is exposed to the client.
Also, the stored procedure and SQL function call mechanisms automatically
detect if Connection is the class of the first argument of any underlying
Java method(s). If it is, then the engine transparently supplies a
Connection object that is equivalent to the Connection executing the call,
adjusting the positions of other arguments to suit the SQL context.
package mypackage;
import org.hsqldb.jdbcResultSet;
class MyClass {
public static jdbcResultSet mySp(Connection conn) throws SQLException {
return conn.createStatement().executeQuery("select * from names");
}
}
Here is a slightly more complex example demonstrating the essence of the
idea behind a more portable style:
package mylibrarypackage;
import java.sql.Connection;
import java.sql.SQLException;
class MyLibraryClass {
public static ResultSet mySp() throws SQLException {
Connection conn = ctx.getConnection();
return conn.createStatement().executeQuery("select * from names");
}
...
}
//--
package myadaptorpackage;
import java.sql.Connection;
import java.sql.SQLException;
import org.hsqldb.jdbcResultSet;
class MyAdaptorClass {
public static jdbcResultSet mySp(Connection conn) throws SQLException {
MyLibraryClass.getCtx().setConnection(conn);
return (jdbcResultSet) MyLibraryClass.mySp();
}
}
In a future release, it is intended to allow writing fairly portable
stored procedure code by supporting the special "jdbc:default:connection"
database connection url and a well-defined specification of the behaviour
of the execution stack under stored procedure calls.
jdbcConnection.prepareCall(java.lang.String),
jdbcResultSet| Field Summary |
| Fields inherited from class org.hsqldb.jdbc.jdbcPreparedStatement |
isRowCount, parameterModes, parameterTypes, parameterValues, pmd, pmdDescriptor, rsmd, rsmdDescriptor, sql, statementID |
| Fields inherited from class org.hsqldb.jdbc.jdbcStatement |
batchResultOut, connection, maxRows, resultIn, resultOut, rsType |
| 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 |
| Constructor Summary | |
jdbcCallableStatement(jdbcConnection c,
String sql,
int type)
Creates a new instance of jdbcCallableStatement |
|
| Method Summary | |
Array |
getArray(int i)
Retrieves the value of the designated JDBC ARRAY
parameter as an Array object in the Java programming
language. |
Array |
getArray(String parameterName)
Retrieves the value of a JDBC ARRAY parameter as an
Array object in the Java programming language. |
BigDecimal |
getBigDecimal(int parameterIndex)
Retrieves the value of the designated JDBC NUMERIC
parameter as a java.math.BigDecimal object with as many
digits to the right of the decimal point as the value contains. |
BigDecimal |
getBigDecimal(int parameterIndex,
int scale)
Deprecated. use getBigDecimal(int parameterIndex)
or getBigDecimal(String parameterName) |
BigDecimal |
getBigDecimal(String parameterName)
Retrieves the value of a JDBC NUMERIC parameter as a
java.math.BigDecimal object with as many digits to the
right of the decimal point as the value contains. |
Blob |
getBlob(int i)
Retrieves the value of the designated JDBC BLOB
parameter as a Blob object in the Java
programming language. |
Blob |
getBlob(String parameterName)
Retrieves the value of a JDBC BLOB parameter as a
Blob object in the Java programming language. |
boolean |
getBoolean(int parameterIndex)
Retrieves the value of the designated JDBC BIT parameter
as a boolean in the Java programming language. |
boolean |
getBoolean(String parameterName)
Retrieves the value of a JDBC BIT parameter as a
boolean in the Java programming language. |
byte |
getByte(int parameterIndex)
Retrieves the value of the designated JDBC TINYINT
parameter as a byte in the Java programming language. |
byte |
getByte(String parameterName)
Retrieves the value of a JDBC TINYINT parameter as a
byte in the Java programming language. |
byte[] |
getBytes(int parameterIndex)
Retrieves the value of the designated JDBC BINARY or
VARBINARY parameter as an array of byte
values in the Java programming language. |
byte[] |
getBytes(String parameterName)
Retrieves the value of a JDBC BINARY or
VARBINARY parameter as an array of byte
values in the Java programming language. |
Clob |
getClob(int i)
Retrieves the value of the designated JDBC CLOB
parameter as a Clob object in the Java programming l
anguage. |
Clob |
getClob(String parameterName)
Retrieves the value of a JDBC CLOB parameter as a
Clob object in the Java programming language. |
Date |
getDate(int parameterIndex)
Retrieves the value of the designated JDBC DATE parameter
as a java.sql.Date object. |
Date |
getDate(int parameterIndex,
Calendar cal)
Retrieves the value of the designated JDBC DATE
parameter as a java.sql.Date object, using
the given Calendar object
to construct the date.
|
Date |
getDate(String parameterName)
Retrieves the value of a JDBC DATE parameter as a
java.sql.Date object. |
Date |
getDate(String parameterName,
Calendar cal)
Retrieves the value of a JDBC DATE parameter as a
java.sql.Date object, using
the given Calendar object
to construct the date.
|
double |
getDouble(int parameterIndex)
Retrieves the value of the designated JDBC DOUBLE
parameter as a double in the Java programming language. |
double |
getDouble(String parameterName)
Retrieves the value of a JDBC DOUBLE parameter as
a double in the Java programming language. |
float |
getFloat(int parameterIndex)
Retrieves the value of the designated JDBC FLOAT
parameter as a float in the Java programming language. |
float |
getFloat(String parameterName)
Retrieves the value of a JDBC FLOAT parameter as
a float in the Java programming language. |
int |
getInt(int parameterIndex)
Retrieves the value of the designated JDBC INTEGER
parameter as an int in the Java programming language. |
int |
getInt(String parameterName)
Retrieves the value of a JDBC INTEGER parameter as
an int in the Java programming language. |
long |
getLong(int parameterIndex)
Retrieves the value of the designated JDBC BIGINT
parameter as a long in the Java programming language. |
long |
getLong(String parameterName)
Retrieves the value of a JDBC BIGINT parameter as
a long in the Java programming language. |
Object |
getObject(int parameterIndex)
Retrieves the value of the designated parameter as an Object
in the Java programming language. |
Object |
getObject(int i,
Map map)
Returns an object representing the value of OUT parameter i and uses map for the custom
mapping of the parameter value.
|
Object |
getObject(String parameterName)
Retrieves the value of a parameter as an Object in the Java
programming language. |
Object |
getObject(String parameterName,
Map map)
Returns an object representing the value of OUT parameter i and uses map for the custom
mapping of the parameter value.
|
Ref |
getRef(int i)
Retrieves the value of the designated JDBC REF(<structured-type>) parameter as a
Ref object in the Java programming language. |
Ref |
getRef(String parameterName)
Retrieves the value of a JDBC REF(<structured-type>)
parameter as a Ref object in the Java programming language. |
short |
getShort(int parameterIndex)
Retrieves the value of the designated JDBC SMALLINT
parameter as a short in the Java programming language. |
short |
getShort(String parameterName)
Retrieves the value of a JDBC SMALLINT parameter as
a short in the Java programming language. |
String |
getString(int parameterIndex)
Retrieves the value of the designated JDBC CHAR,
VARCHAR, or LONGVARCHAR parameter as a
String in the Java programming language.
|
String |
getString(String parameterName)
Retrieves the value of a JDBC CHAR, VARCHAR,
or LONGVARCHAR parameter as a String in
the Java programming language.
|
Time |
getTime(int parameterIndex)
Retrieves the value of the designated JDBC TIME parameter
as a java.sql.Time object. |
Time |
getTime(int parameterIndex,
Calendar cal)
Retrieves the value of the designated JDBC TIME
parameter as a java.sql.Time object, using
the given Calendar object
to construct the time.
|
Time |
getTime(String parameterName)
Retrieves the value of a JDBC TIME parameter as a
java.sql.Time object. |
Time |
getTime(String parameterName,
Calendar cal)
Retrieves the value of a JDBC TIME parameter as a
java.sql.Time object, using
the given Calendar object
to construct the time.
|
Timestamp |
getTimestamp(int parameterIndex)
Retrieves the value of the designated JDBC TIMESTAMP
parameter as a java.sql.Timestamp object. |
Timestamp |
getTimestamp(int parameterIndex,
Calendar cal)
Retrieves the value of the designated JDBC TIMESTAMP
parameter as a java.sql.Timestamp object, using
the given Calendar object to construct
the Timestamp object.
|
Timestamp |
getTimestamp(String parameterName)
Retrieves the value of a JDBC TIMESTAMP parameter as a
java.sql.Timestamp object. |
Timestamp |
getTimestamp(String parameterName,
Calendar cal)
Retrieves the value of a JDBC TIMESTAMP parameter as a
java.sql.Timestamp object, using
the given Calendar object to construct
the Timestamp object.
|
URL |
getURL(int parameterIndex)
Retrieves the value of the designated JDBC DATALINK
parameter as a java.net.URL object. |
URL |
getURL(String parameterName)
Retrieves the value of a JDBC DATALINK parameter as a
java.net.URL object. |
void |
registerOutParameter(int parameterIndex,
int sqlType)
Registers the OUT parameter in ordinal position parameterIndex to the JDBC type
sqlType. |
void |
registerOutParameter(int parameterIndex,
int sqlType,
int scale)
Registers the parameter in ordinal position parameterIndex to be of JDBC type
sqlType. |
void |
registerOutParameter(int paramIndex,
int sqlType,
String typeName)
Registers the designated output parameter. |
void |
registerOutParameter(String parameterName,
int sqlType)
Registers the OUT parameter named parameterName to the JDBC type
sqlType. |
void |
registerOutParameter(String parameterName,
int sqlType,
int scale)
Registers the parameter named parameterName to be of JDBC type
sqlType. |
void |
registerOutParameter(String parameterName,
int sqlType,
String typeName)
Registers the designated output parameter. |
void |
setAsciiStream(String parameterName,
InputStream x,
int length)
Sets the designated parameter to the given input stream, which will have the specified number of bytes. |
void |
setBigDecimal(String parameterName,
BigDecimal x)
Sets the designated parameter to the given java.math.BigDecimal value.
|
void |
setBinaryStream(String parameterName,
InputStream x,
int length)
Sets the designated parameter to the given input stream, which will have the specified number of bytes. |
void |
setBoolean(String parameterName,
boolean x)
Sets the designated parameter to the given Java boolean
value. |
void |
setByte(String parameterName,
byte x)
Sets the designated parameter to the given Java byte value.
|
void |
setBytes(String parameterName,
byte[] x)
Sets the designated parameter to the given Java array of bytes. |
void |
setCharacterStream(String parameterName,
Reader reader,
int length)
Sets the designated parameter to the given Reader
object, which is the given number of characters long.
|
void |
setDate(String parameterName,
Date x)
Sets the designated parameter to the given java.sql.Date
value. |
void |
setDate(String parameterName,
Date x,
Calendar cal)
Sets the designated parameter to the given java.sql.Date
value, using the given Calendar object. |
void |
setDouble(String parameterName,
double x)
Sets the designated parameter to the given Java double value.
|
void |
setFloat(String parameterName,
float x)
Sets the designated parameter to the given Java float value.
|
void |
setInt(String parameterName,
int x)
Sets the designated parameter to the given Java int value.
|
void |
setLong(String parameterName,
long x)
Sets the designated parameter to the given Java long value.
|
void |
setNull(String parameterName,
int sqlType)
Sets the designated parameter to SQL NULL.
|
void |
setNull(String parameterName,
int sqlType,
String typeName)
Sets the designated parameter to SQL NULL.
|
void |
setObject(String parameterName,
Object x)
Sets the value of the designated parameter with the given object. |
void |
setObject(String parameterName,
Object x,
int targetSqlType)
Sets the value of the designated parameter with the given object. |
void |
setObject(String parameterName,
Object x,
int targetSqlType,
int scale)
Sets the value of the designated parameter with the given object. |
void |
setShort(String parameterName,
short x)
Sets the designated parameter to the given Java short value.
|
void |
setString(String parameterName,
String x)
Sets the designated parameter to the given Java String
value. |
void |
setTime(String parameterName,
Time x)
Sets the designated parameter to the given java.sql.Time
value. |
void |
setTime(String parameterName,
Time x,
Calendar cal)
Sets the designated parameter to the given java.sql.Time
value, using the given Calendar object. |
void |
setTimestamp(String parameterName,
Timestamp x)
Sets the designated parameter to the given java.sql.Timestamp value. |
void |
setTimestamp(String parameterName,
Timestamp x,
Calendar cal)
Sets the designated parameter to the given java.sql.Timestamp value, using the given
Calendar object. |
void |
setURL(String parameterName,
URL val)
Sets the designated parameter to the given java.net.URL
object. |
boolean |
wasNull()
Retrieves whether the last OUT parameter read had the value of SQL NULL. |
| Methods inherited from class org.hsqldb.jdbc.jdbcPreparedStatement |
addBatch, addBatch, checkIsRowCount, checkSetParameterIndex, clearParameters, close, execute, execute, 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, setUnicodeStream, setURL, toString |
| Methods inherited from class org.hsqldb.jdbc.jdbcStatement |
cancel, clearBatch, clearWarnings, execute, execute, execute, executeBatch, 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 |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
| Methods inherited from interface java.sql.PreparedStatement |
addBatch, clearParameters, execute, executeQuery, executeUpdate, getMetaData, getParameterMetaData, setArray, setAsciiStream, setBigDecimal, setBinaryStream, setBlob, setBoolean, setByte, setBytes, setCharacterStream, setClob, setDate, setDate, setDouble, setFloat, setInt, setLong, setNull, setNull, setObject, setObject, setObject, setRef, setShort, setString, setTime, setTime, setTimestamp, setTimestamp, setUnicodeStream, setURL |
| Constructor Detail |
public jdbcCallableStatement(jdbcConnection c,
String sql,
int type)
throws HsqlException,
SQLException
| Method Detail |
public void registerOutParameter(int parameterIndex,
int sqlType)
throws SQLException
parameterIndex to the JDBC type
sqlType. All OUT parameters must be registered
before a stored procedure is executed.
The JDBC type specified by sqlType for an OUT
parameter determines the Java type that must be used
in the get method 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, sqlType
should be java.sql.Types.OTHER. The method
getObject(int) retrieves the value.
HSQLDB-Specific Information:
HSQLDB 1.7.2 does not support this feature.
Calling this method always throws an
SQLException.
registerOutParameter in interface CallableStatementparameterIndex - the first parameter is 1, the second is 2,
and so onsqlType - the JDBC type code defined by java.sql.Types.
If the parameter is of JDBC type NUMERIC
or DECIMAL, the version of
registerOutParameter that accepts a scale value
should be used.
SQLException - if a database access error occursTypes
public void registerOutParameter(int parameterIndex,
int sqlType,
int scale)
throws SQLException
parameterIndex to be of JDBC type
sqlType. This method must be called
before a stored procedure is executed.
The JDBC type specified by sqlType for an OUT
parameter determines the Java type that must be used
in the get method to read the value of that parameter.
This version of registerOutParameter should be
used when the parameter is of JDBC type NUMERIC
or DECIMAL.
HSQLDB-Specific Information:
HSQLDB 1.7.2 does not support this feature.
Calling this method always throws an
SQLException.
registerOutParameter in interface CallableStatementparameterIndex - the first parameter is 1, the second is 2,
and so onsqlType - the SQL type code defined by java.sql.Types.scale - the desired number of digits to the right of the
decimal point. It must be greater than or equal to zero.
SQLException - if a database access error occursTypes
public boolean wasNull()
throws SQLException
NULL. Note that this method should be called only
after calling a getter method; otherwise, there is no value to use in
determining whether it is null or not.
HSQLDB-Specific Information:
HSQLDB 1.7.2 does not support this feature.
Calling this method always throws an
SQLException.
wasNull in interface CallableStatementtrue if the last parameter read was SQL
NULL; false otherwise
SQLException - if a database access error occurs
public String getString(int parameterIndex)
throws SQLException
CHAR,
VARCHAR, or LONGVARCHAR parameter as a
String in the Java programming language.
For the fixed-length type JDBC CHAR,
the String object
returned has exactly the same value the JDBC
CHAR value had in the
database, including any padding added by the database.
HSQLDB-Specific Information:
HSQLDB 1.7.2 does not support this feature.
Calling this method always throws an
SQLException.
getString in interface CallableStatementparameterIndex - the first parameter is 1, the second is 2,
and so on
NULL,
the result
is null.
SQLException - if a database access error occurssetString(java.lang.String, java.lang.String)
public boolean getBoolean(int parameterIndex)
throws SQLException
BIT parameter
as a boolean in the Java programming language.
HSQLDB-Specific Information:
HSQLDB 1.7.2 does not support this feature.
Calling this method always throws an
SQLException.
getBoolean in interface CallableStatementparameterIndex - the first parameter is 1, the second is 2,
and so on
NULL,
the result is false.
SQLException - if a database access error occurssetBoolean(java.lang.String, boolean)
public byte getByte(int parameterIndex)
throws SQLException
TINYINT
parameter as a byte in the Java programming language.
HSQLDB-Specific Information:
HSQLDB 1.7.2 does not support this feature.
Calling this method always throws an
SQLException.
getByte in interface CallableStatementparameterIndex - the first parameter is 1, the second is 2,
and so on
NULL,
the result is 0.
SQLException - if a database access error occurssetByte(java.lang.String, byte)
public short getShort(int parameterIndex)
throws SQLException
SMALLINT
parameter as a short in the Java programming language.
HSQLDB-Specific Information:
HSQLDB 1.7.2 does not support this feature.
Calling this method always throws an
SQLException.
getShort in interface CallableStatementparameterIndex - the first parameter is 1, the second is 2,
and so on
NULL,
the result is 0.
SQLException - if a database access error occurssetShort(java.lang.String, short)
public int getInt(int parameterIndex)
throws SQLException
INTEGER
parameter as an int in the Java programming language.
HSQLDB-Specific Information:
HSQLDB 1.7.2 does not support this feature.
Calling this method always throws an
SQLException.
getInt in interface CallableStatementparameterIndex - the first parameter is 1, the second is 2,
and so on
NULL,
the result is 0.
SQLException - if a database access error occurssetInt(java.lang.String, int)
public long getLong(int parameterIndex)
throws SQLException
BIGINT
parameter as a long in the Java programming language.
HSQLDB-Specific Information:
HSQLDB 1.7.2 does not support this feature.
Calling this method always throws an
SQLException.
getLong in interface CallableStatementparameterIndex - the first parameter is 1, the second is 2,
and so on
NULL,
the result is 0.
SQLException - if a database access error occurssetLong(java.lang.String, long)
public float getFloat(int parameterIndex)
throws SQLException
FLOAT
parameter as a float in the Java programming language.
HSQLDB-Specific Information:
HSQLDB 1.7.2 does not support this feature.
Calling this method always throws an
SQLException.
getFloat in interface CallableStatementparameterIndex - the first parameter is 1, the second is 2,
and so on
NULL, the
result is 0.
SQLException - if a database access error occurssetFloat(java.lang.String, float)
public double getDouble(int parameterIndex)
throws SQLException
DOUBLE
parameter as a double in the Java programming language.
HSQLDB-Specific Information:
HSQLDB 1.7.2 does not support this feature.
Calling this method always throws an
SQLException.
getDouble in interface CallableStatementparameterIndex - the first parameter is 1, the second is 2,
and so on
NULL,
the result is 0.
SQLException - if a database access error occurssetDouble(java.lang.String, double)
public BigDecimal getBigDecimal(int parameterIndex,
int scale)
throws SQLException
getBigDecimal(int parameterIndex)
or getBigDecimal(String parameterName)
NUMERIC
parameter as a java.math.BigDecimal object with
scale digits to the right of the decimal point.
HSQLDB-Specific Information:
HSQLDB 1.7.2 does not support this feature.
Calling this method always throws an
SQLException.
getBigDecimal in interface CallableStatementparameterIndex - the first parameter is 1, the second is 2,
and so onscale - the number of digits to the right of the decimal point
NULL,
the result is null.
SQLException - if a database access error occurssetBigDecimal(java.lang.String, java.math.BigDecimal)
public byte[] getBytes(int parameterIndex)
throws SQLException
BINARY or
VARBINARY parameter as an array of byte
values in the Java programming language.
HSQLDB-Specific Information:
HSQLDB 1.7.2 does not support this feature.
Calling this method always throws an
SQLException.
getBytes in interface CallableStatementparameterIndex - the first parameter is 1, the second is 2,
and so on
NULL,
the result is null.
SQLException - if a database access error occurssetBytes(java.lang.String, byte[])
public Date getDate(int parameterIndex)
throws SQLException
DATE parameter
as a java.sql.Date object.
HSQLDB-Specific Information:
HSQLDB 1.7.2 does not support this feature.
Calling this method always throws an
SQLException.
getDate in interface CallableStatementparameterIndex - the first parameter is 1, the second is 2,
and so on
NULL, the
result is null.
SQLException - if a database access error occurssetDate(java.lang.String, java.sql.Date)
public Time getTime(int parameterIndex)
throws SQLException
TIME parameter
as a java.sql.Time object.
HSQLDB-Specific Information:
HSQLDB 1.7.2 does not support this feature.
Calling this method always throws an
SQLException.
getTime in interface CallableStatementparameterIndex - the first parameter is 1, the second is 2,
and so on
NULL,
the result is null.
SQLException - if a database access error occurssetTime(java.lang.String, java.sql.Time)
public Timestamp getTimestamp(int parameterIndex)
throws SQLException
TIMESTAMP
parameter as a java.sql.Timestamp object.
HSQLDB-Specific Information:
HSQLDB 1.7.2 does not support this feature.
Calling this method always throws an
SQLException.
getTimestamp in interface CallableStatementparameterIndex - the first parameter is 1, the second is 2,
and so on
NULL,
the result is null.
SQLException - if a database access error occurssetTimestamp(java.lang.String, java.sql.Timestamp)
public Object getObject(int parameterIndex)
throws SQLException
Object
in the Java programming language. If the value is an SQL NULL,
the driver returns a Java null.
This method returns a Java object whose type corresponds to the JDBC
type that was registered for this parameter using the method
registerOutParameter. By registering the target JDBC
type as java.sql.Types.OTHER, this method can be used
to read database-specific abstract data types.
HSQLDB-Specific Information:
HSQLDB 1.7.2 does not support this feature.
Calling this method always throws an
SQLException.
getObject in interface CallableStatementparameterIndex - the first parameter is 1, the second is 2,
and so on
java.lang.Object holding the OUT parameter value
SQLException - if a database access error occursTypes,
setObject(java.lang.String, java.lang.Object, int, int)
public BigDecimal getBigDecimal(int parameterIndex)
throws SQLException
NUMERIC
parameter as a java.math.BigDecimal object with as many
digits to the right of the decimal point as the value contains.
HSQLDB-Specific Information:
HSQLDB 1.7.2 does not support this feature.
Calling this method always throws an
SQLException.
getBigDecimal in interface CallableStatementparameterIndex - the first parameter is 1, the second is 2,
and so on
NULL, the result is null.
SQLException - if a database access error occurssetBigDecimal(java.lang.String, java.math.BigDecimal)
public Object getObject(int i,
Map map)
throws SQLException
i and uses map for 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 method
registerOutParameter. By registering the target
JDBC type as java.sql.Types.OTHER, this method can
be used to read database-specific abstract data types.
HSQLDB-Specific Information:
HSQLDB 1.7.2 does not support this feature.
Calling this method always throws an
SQLException.
getObject in interface CallableStatementi - the first parameter is 1, the second is 2, and so onmap - the mapping from SQL type names to Java classes
java.lang.Object holding the OUT parameter value
SQLException - if a database access error occurssetObject(java.lang.String, java.lang.Object, int, int)
public Ref getRef(int i)
throws SQLException
REF(<structured-type>) parameter as a
Ref object in the Java programming language.
HSQLDB-Specific Information:
HSQLDB 1.7.2 does not support this feature.
Calling this method always throws an
SQLException.
getRef in interface CallableStatementi - the first parameter is 1, the second is 2,
and so on
Ref object in the
Java programming language. If the value was SQL NULL,
the value null is returned.
SQLException - if a database access error occurs
public Blob getBlob(int i)
throws SQLException
BLOB
parameter as a Blob object in the Java
programming language.
HSQLDB-Specific Information:
HSQLDB 1.7.2 does not support this feature.
Calling this method always throws an
SQLException.
getBlob in interface CallableStatementi - the first parameter is 1, the second is 2,
and so on
Blob object in the
Java programming language. If the value was SQL NULL,
the value null is returned.
SQLException - if a database access error occurs
public Clob getClob(int i)
throws SQLException
CLOB
parameter as a Clob object in the Java programming l
anguage.
HSQLDB-Specific Information:
HSQLDB 1.7.2 does not support this feature.
Calling this method always throws an
SQLException.
getClob in interface CallableStatementi - the first parameter is 1, the second is 2, and
so on
Clob object in the
Java programming language. If the value was SQL NULL, the
value null is returned.
SQLException - if a database access error occurs
public Array getArray(int i)
throws SQLException
ARRAY
parameter as an Array object in the Java programming
language.
HSQLDB-Specific Information:
HSQLDB 1.7.2 does not support this feature.
Calling this method always throws an
SQLException.
getArray in interface CallableStatementi - the first parameter is 1, the second is 2, and
so on
Array object in
the Java programming language. If the value was SQL NULL,
the value null is returned.
SQLException - if a database access error occurs
public Date getDate(int parameterIndex,
Calendar cal)
throws SQLException
DATE
parameter as a java.sql.Date object, using
the given Calendar object
to construct the date.
With a Calendar object, the driver
can calculate the date taking into account a custom timezone and
locale. If no Calendar object is specified, the driver
uses the default timezone and locale.
HSQLDB-Specific Information:
HSQLDB 1.7.2 does not support this feature.
Calling this method always throws an
SQLException.
getDate in interface CallableStatementparameterIndex - the first parameter is 1, the second is 2,
and so oncal - the Calendar object the driver will use
to construct the date
NULL,
the result is null.
SQLException - if a database access error occurssetDate(java.lang.String, java.sql.Date)
public Time getTime(int parameterIndex,
Calendar cal)
throws SQLException
TIME
parameter as a java.sql.Time object, using
the given Calendar object
to construct the time.
With a Calendar object, the driver
can calculate the time taking into account a custom timezone and locale.
If no Calendar object is specified, the driver uses the
default timezone and locale.
HSQLDB-Specific Information:
HSQLDB 1.7.2 does not support this feature.
Calling this method always throws an
SQLException.
getTime in interface CallableStatementparameterIndex - the first parameter is 1, the second is 2,
and so oncal - the Calendar object the driver will use
to construct the time
NULL,
the result is null.
SQLException - if a database access error occurssetTime(java.lang.String, java.sql.Time)
public Timestamp getTimestamp(int parameterIndex,
Calendar cal)
throws SQLException
TIMESTAMP
parameter as a java.sql.Timestamp object, using
the given Calendar object to construct
the Timestamp object.
With a Calendar object, the driver
can calculate the timestamp taking into account a custom timezone and
locale. If no Calendar object is specified, the driver
uses the default timezone and locale.
HSQLDB-Specific Information:
HSQLDB 1.7.2 does not support this feature.
Calling this method always throws an
SQLException.
getTimestamp in interface CallableStatementparameterIndex - the first parameter is 1, the second is 2,
and so oncal - the Calendar object the driver will use
to construct the timestamp
NULL,
the result is null.
SQLException - if a database access error occurssetTimestamp(java.lang.String, java.sql.Timestamp)
public void registerOutParameter(int paramIndex,
int sqlType,
String typeName)
throws SQLException
registerOutParameter
should be used for a user-defined or REF output parameter.
Examples of user-defined types include: STRUCT,
DISTINCT, JAVA_OBJECT, and named array types.
Before executing a stored procedure call, you must explicitly
call registerOutParameter to register the type from
java.sql.Types for each
OUT parameter. For a user-defined 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-defined and REF parameters.
Although it is intended for user-defined and REF parameters,
this method may be used to register a parameter of any JDBC type.
If the parameter does not have a user-defined or REF type,
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.
HSQLDB-Specific Information:
HSQLDB 1.7.2 does not support this feature.
Calling this method always throws an
SQLException.
registerOutParameter in interface CallableStatementparamIndex - the first parameter is 1, the second is 2,...sqlType - a value from TypestypeName - the fully-qualified name of an SQL structured type
SQLException - if a database access error occursTypes
public void registerOutParameter(String parameterName,
int sqlType)
throws SQLException
parameterName to the JDBC type
sqlType. All OUT parameters must be registered
before a stored procedure is executed.
The JDBC type specified by sqlType for an OUT
parameter determines the Java type that must be used
in the get method 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, sqlType
should be java.sql.Types.OTHER. The method
getObject(int) retrieves the value.
HSQLDB-Specific Information:
HSQLDB 1.7.2 does not support this feature.
Calling this method always throws an
SQLException.
registerOutParameter in interface CallableStatementparameterName - the name of the parametersqlType - the JDBC type code defined by java.sql.Types.
If the parameter is of JDBC type NUMERIC
or DECIMAL, the version of
registerOutParameter that accepts a scale value
should be used.
SQLException - if a database access error occursTypes
public void registerOutParameter(String parameterName,
int sqlType,
int scale)
throws SQLException
parameterName to be of JDBC type
sqlType. This method must be called
before a stored procedure is executed.
The JDBC type specified by sqlType for an OUT
parameter determines the Java type that must be used
in the get method to read the value of that parameter.
This version of registerOutParameter should be
used when the parameter is of JDBC type NUMERIC
or DECIMAL.
HSQLDB-Specific Information:
HSQLDB 1.7.2 does not support this feature.
Calling this method always throws an
SQLException.
registerOutParameter in interface CallableStatementparameterName - the name of the parametersqlType - SQL type code defined by java.sql.Types.scale - the desired number of digits to the right of the
decimal point. It must be greater than or equal to zero.
SQLException - if a database access error occursTypes
public void registerOutParameter(String parameterName,
int sqlType,
String typeName)
throws SQLException
registerOutParameter
should be used for a user-named or REF output parameter. Examples
of user-named types include: STRUCT, DISTINCT, JAVA_OBJECT, and
named array types.
Before executing a stored procedure call, you must explicitly
call registerOutParameter to register the type from
java.sql.Types for each
OUT parameter. 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 the getXXX method whose Java type XXX corresponds
to the parameter's registered SQL type.
HSQLDB-Specific Information:
HSQLDB 1.7.2 does not support this feature.
Calling this method always throws an
SQLException.
registerOutParameter in interface CallableStatementparameterName - the name of the parametersqlType - a value from TypestypeName - the fully-qualified name of an SQL structured type
SQLException - if a database access error occursTypes
public URL getURL(int parameterIndex)
throws SQLException
DATALINK
parameter as a java.net.URL object.
HSQLDB-Specific Information:
HSQLDB 1.7.2 does not support this feature.
Calling this method always throws an
SQLException.
getURL in interface CallableStatementparameterIndex - the first parameter is 1, the second is 2,...
java.net.URL object that represents the
JDBC DATALINK value used as the designated
parameter
SQLException - if a database access error occurs,
or if the URL being returned is
not a valid URL on the Java platformsetURL(java.lang.String, java.net.URL)
public void setURL(String parameterName,
URL val)
throws SQLException
java.net.URL
object. The driver converts this to an SQL DATALINK
value when it sends it to the database.
HSQLDB-Specific Information:
Starting with 1.7.2, HSLQDB supports this.
setURL in interface CallableStatementparameterName - the name of the parameterval - the parameter value
SQLException - if a database access error occurs,
or if a URL is malformedgetURL(int)
public void setNull(String parameterName,
int sqlType)
throws SQLException
NULL.
Note: You must specify the parameter's SQL type.
HSQLDB-Specific Information:
Starting with 1.7.2, HSLQDB supports this.
setNull in interface CallableStatementparameterName - the name of the parametersqlType - the SQL type code defined in java.sql.Types
SQLException - if a database access error occurs
public void setBoolean(String parameterName,
boolean x)
throws SQLException
boolean
value. The driver converts this to an SQL BIT value when
it sends it to the database.
HSQLDB-Specific Information:
Starting with 1.7.2, HSLQDB supports this.
setBoolean in interface CallableStatementparameterName - the name of the parameterx - the parameter value
SQLException - if a database access error occursgetBoolean(int)
public void setByte(String parameterName,
byte x)
throws SQLException
byte value.
The driver converts this to an SQL TINYINT value when it
sends it to the database.
HSQLDB-Specific Information:
Starting with 1.7.2, HSLQDB supports this.
setByte in interface CallableStatementparameterName - the name of the parameterx - the parameter value
SQLException - if a database access error occursgetByte(int)
public void setShort(String parameterName,
short x)
throws SQLException
short value.
The driver converts this to an SQL SMALLINT value when
it sends it to the database.
HSQLDB-Specific Information:
Starting with 1.7.2, HSLQDB supports this.
setShort in interface CallableStatementparameterName - the name of the parameterx - the parameter value
SQLException - if a database access error occursgetShort(int)
public void setInt(String parameterName,
int x)
throws SQLException
int value.
The driver converts this to an SQL INTEGER value when it
sends it to the database.
HSQLDB-Specific Information:
Starting with 1.7.2, HSLQDB supports this.
setInt in interface CallableStatementparameterName - the name of the parameterx - the parameter value
SQLException - if a database access error occursgetInt(int)
public void setLong(String parameterName,
long x)
throws SQLException
long value.
The driver converts this to an SQL BIGINT value when it
sends it to the database.
HSQLDB-Specific Information:
Starting with 1.7.2, HSLQDB supports this.
setLong in interface CallableStatementparameterName - the name of the parameterx - the parameter value
SQLException - if a database access error occursgetLong(int)
public void setFloat(String parameterName,
float x)
throws SQLException
float value.
The driver converts this to an SQL FLOAT value when it
sends it to the database.
HSQLDB-Specific Information:
Starting with 1.7.2, HSLQDB supports this.
setFloat in interface CallableStatementparameterName - the name of the parameterx - the parameter value
SQLException - if a database access error occursgetFloat(int)
public void setDouble(String parameterName,
double x)
throws SQLException
double value.
The driver converts this to an SQL DOUBLE value when it
sends it to the database.
HSQLDB-Specific Information:
Starting with 1.7.2, HSLQDB supports this.
setDouble in interface CallableStatementparameterName - the name of the parameterx - the parameter value
SQLException - if a database access error occursgetDouble(int)
public void setBigDecimal(String parameterName,
BigDecimal x)
throws SQLException
java.math.BigDecimal value.
The driver converts this to an SQL NUMERIC value when
it sends it to the database.
HSQLDB-Specific Information:
Starting with 1.7.2, HSLQDB supports this.
setBigDecimal in interface CallableStatementparameterName - the name of the parameterx - the parameter value
SQLException - if a database access error occursgetBigDecimal(int, int)
public void setString(String parameterName,
String x)
throws 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.
HSQLDB-Specific Information:
Starting with 1.7.2, HSLQDB supports this.
setString in interface CallableStatementparameterName - the name of the parameterx - the parameter value
SQLException - if a database access error occursgetString(int)
public void setBytes(String parameterName,
byte[] x)
throws 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.
HSQLDB-Specific Information:
Starting with 1.7.2, HSLQDB supports this.
setBytes in interface CallableStatementparameterName - the name of the parameterx - the parameter value
SQLException - if a database access error occursgetBytes(int)
public void setDate(String parameterName,
Date x)
throws SQLException
java.sql.Date
value. The driver converts this to an SQL DATE value
when it sends it to the database.
HSQLDB-Specific Information:
Starting with 1.7.2, HSLQDB supports this.
setDate in interface CallableStatementparameterName - the name of the parameterx - the parameter value
SQLException - if a database access error occursgetDate(int)
public void setTime(String parameterName,
Time x)
throws SQLException
java.sql.Time
value. The driver converts this to an SQL TIME value
when it sends it to the database.
HSQLDB-Specific Information:
Starting with 1.7.2, HSLQDB supports this.
setTime in interface CallableStatementparameterName - the name of the parameterx - the parameter value
SQLException - if a database access error occursgetTime(int)
public void setTimestamp(String parameterName,
Timestamp x)
throws SQLException
java.sql.Timestamp value. The driver
converts this to an SQL TIMESTAMP value when it
sends it to the database.
HSQLDB-Specific Information:
Starting with 1.7.2, HSLQDB supports this.
setTimestamp in interface CallableStatementparameterName - the name of the parameterx - the parameter value
SQLException - if a database access error occursgetTimestamp(int)
public void setAsciiStream(String parameterName,
InputStream x,
int length)
throws 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.
HSQLDB-Specific Information:
Starting with 1.7.2, HSLQDB supports this.
setAsciiStream in interface CallableStatementparameterName - the name of the parameterx - the Java input stream that contains the ASCII parameter valuelength - the number of bytes in the stream
SQLException - if a database access error occurs
public void setBinaryStream(String parameterName,
InputStream x,
int length)
throws 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.
HSQLDB-Specific Information:
Starting with 1.7.2, HSLQDB supports this.
setBinaryStream in interface CallableStatementparameterName - the name of the parameterx - the java input stream which contains the binary parameter valuelength - the number of bytes in the stream
SQLException - if a database access error occurs
public void setObject(String parameterName,
Object x,
int targetSqlType,
int scale)
throws SQLException
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 datatabase- specific abstract data types.
HSQLDB-Specific Information:
Starting with 1.7.2, HSLQDB supports this.
setObject in interface CallableStatementparameterName - 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.
SQLException - if a database access error occursTypes,
getObject(int)
public void setObject(String parameterName,
Object x,
int targetSqlType)
throws SQLException
setObject
above, except that it assumes a scale of zero.
HSQLDB-Specific Information:
Starting with 1.7.2, HSLQDB supports this.
setObject in interface CallableStatementparameterName - 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
SQLException - if a database access error occursgetObject(int)
public void setObject(String parameterName,
Object x)
throws SQLException
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.
HSQLDB-Specific Information:
Starting with 1.7.2, HSLQDB supports this.
setObject in interface CallableStatementparameterName - the name of the parameterx - the object containing the input parameter value
SQLException - if a database access error occurs or if the given
Object parameter is ambiguousgetObject(int)
public void setCharacterStream(String parameterName,
Reader reader,
int length)
throws 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-Specific Information:
Starting with 1.7.2, HSLQDB supports this.
setCharacterStream in interface CallableStatementparameterName - the name of the parameterreader - the java.io.Reader object that
contains the UNICODE data used as the designated parameterlength - the number of characters in the stream
SQLException - if a database access error occurs
public void setDate(String parameterName,
Date x,
Calendar cal)
throws 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.
HSQLDB-Specific Information:
Starting with 1.7.2, HSLQDB supports this.
setDate in interface CallableStatementparameterName - the name of the parameterx - the parameter valuecal - the Calendar object the driver will use
to construct the date
SQLException - if a database access error occursgetDate(int)
public void setTime(String parameterName,
Time x,
Calendar cal)
throws 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.
HSQLDB-Specific Information:
Starting with 1.7.2, HSLQDB supports this.
setTime in interface CallableStatementparameterName - the name of the parameterx - the parameter valuecal - the Calendar object the driver will use
to construct the time
SQLException - if a database access error occursgetTime(int)
public void setTimestamp(String parameterName,
Timestamp x,
Calendar cal)
throws 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.
HSQLDB-Specific Information:
Starting with 1.7.2, HSLQDB supports this.
setTimestamp in interface CallableStatementparameterName - the name of the parameterx - the parameter valuecal - the Calendar object the driver will use
to construct the timestamp
SQLException - if a database access error occursgetTimestamp(int)
public void setNull(String parameterName,
int sqlType,
String typeName)
throws 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-Specific Information:
Starting with 1.7.2, HSLQDB supports this.
setNull in interface CallableStatementparameterName - the name of the parametersqlType - 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
SQL REF value
SQLException - if a database access error occurs
public String getString(String parameterName)
throws SQLException
CHAR, VARCHAR,
or LONGVARCHAR parameter as a String in
the Java programming language.
For the fixed-length type JDBC CHAR,
the String object
returned has exactly the same value the JDBC
CHAR value had in the
database, including any padding added by the database.
HSQLDB-Specific Information:
HSQLDB 1.7.2 does not support this feature.
Calling this method always throws an
SQLException.
getString in interface CallableStatementparameterName - the name of the parameter
NULL,
the result is null.
SQLException - if a database access error occurssetString(java.lang.String, java.lang.String)
public boolean getBoolean(String parameterName)
throws SQLException
BIT parameter as a
boolean in the Java programming language.
HSQLDB-Specific Information:
HSQLDB 1.7.2 does not support this feature.
Calling this method always throws an
SQLException.
getBoolean in interface CallableStatementparameterName - the name of the parameter
NULL,
the result is false.
SQLException - if a database access error occurssetBoolean(java.lang.String, boolean)
public byte getByte(String parameterName)
throws SQLException
TINYINT parameter as a
byte in the Java programming language.
HSQLDB-Specific Information:
HSQLDB 1.7.2 does not support this feature.
Calling this method always throws an
SQLException.
getByte in interface CallableStatementparameterName - the name of the parameter
NULL,
the result is 0.
SQLException - if a database access error occurssetByte(java.lang.String, byte)
public short getShort(String parameterName)
throws SQLException
SMALLINT parameter as
a short in the Java programming language.
HSQLDB-Specific Information:
HSQLDB 1.7.2 does not support this feature.
Calling this method always throws an
SQLException.
getShort in interface CallableStatementparameterName - the name of the parameter
NULL,
the result is 0.
SQLException - if a database access error occurssetShort(java.lang.String, short)
public int getInt(String parameterName)
throws SQLException
INTEGER parameter as
an int in the Java programming language.
HSQLDB-Specific Information:
HSQLDB 1.7.2 does not support this feature.
Calling this method always throws an
SQLException.
getInt in interface CallableStatementparameterName - the name of the parameter
NULL,
the result is 0.
SQLException - if a database access error occurssetInt(java.lang.String, int)
public long getLong(String parameterName)
throws SQLException
BIGINT parameter as
a long in the Java programming language.
HSQLDB-Specific Information:
HSQLDB 1.7.2 does not support this feature.
Calling this method always throws an
SQLException.
getLong in interface CallableStatementparameterName - the name of the parameter
NULL,
the result is 0.
SQLException - if a database access error occurssetLong(java.lang.String, long)
public float getFloat(String parameterName)
throws SQLException
FLOAT parameter as
a float in the Java programming language.
HSQLDB-Specific Information:
HSQLDB 1.7.2 does not support this feature.
Calling this method always throws an
SQLException.
getFloat in interface CallableStatementparameterName - the name of the parameter
NULL,
the result is 0.
SQLException - if a database access error occurssetFloat(java.lang.String, float)
public double getDouble(String parameterName)
throws SQLException
DOUBLE parameter as
a double in the Java programming language.
HSQLDB-Specific Information:
HSQLDB 1.7.2 does not support this feature.
Calling this method always throws an
SQLException.
getDouble in interface CallableStatementparameterName - the name of the parameter
NULL,
the result is 0.
SQLException - if a database access error occurssetDouble(java.lang.String, double)
public byte[] getBytes(String parameterName)
throws SQLException
BINARY or
VARBINARY parameter as an array of byte
values in the Java programming language.
HSQLDB-Specific Information:
HSQLDB 1.7.2 does not support this feature.
Calling this method always throws an
SQLException.
getBytes in interface CallableStatementparameterName - the name of the parameter
NULL,
the result is null.
SQLException - if a database access error occurssetBytes(java.lang.String, byte[])
public Date getDate(String parameterName)
throws SQLException
DATE parameter as a
java.sql.Date object.
HSQLDB-Specific Information:
HSQLDB 1.7.2 does not support this feature.
Calling this method always throws an
SQLException.
getDate in interface CallableStatementparameterName - the name of the parameter
NULL,
the result is null.
SQLException - if a database access error occurssetDate(java.lang.String, java.sql.Date)
public Time getTime(String parameterName)
throws SQLException
TIME parameter as a
java.sql.Time object.
HSQLDB-Specific Information:
HSQLDB 1.7.2 does not support this feature.
Calling this method always throws an
SQLException.
getTime in interface CallableStatementparameterName - the name of the parameter
NULL,
the result is null.
SQLException - if a database access error occurssetTime(java.lang.String, java.sql.Time)
public Timestamp getTimestamp(String parameterName)
throws SQLException
TIMESTAMP parameter as a
java.sql.Timestamp object.
HSQLDB-Specific Information:
HSQLDB 1.7.2 does not support this feature.
Calling this method always throws an
SQLException.
getTimestamp in interface CallableStatementparameterName - the name of the parameter
NULL,
the result is null.
SQLException - if a database access error occurssetTimestamp(java.lang.String, java.sql.Timestamp)
public Object getObject(String parameterName)
throws SQLException
Object in the Java
programming language. If the value is an SQL NULL, the
driver returns a Java null.
This method returns a Java object whose type corresponds to the JDBC
type that was registered for this parameter using the method
registerOutParameter. By registering the target JDBC
type as java.sql.Types.OTHER, this method can be used
to read database-specific abstract data types.
HSQLDB-Specific Information:
HSQLDB 1.7.2 does not support this feature.
Calling this method always throws an
SQLException.
getObject in interface CallableStatementparameterName - the name of the parameter
java.lang.Object holding the OUT parameter value.
SQLException - if a database access error occursTypes,
setObject(java.lang.String, java.lang.Object, int, int)
public BigDecimal getBigDecimal(String parameterName)
throws SQLException
NUMERIC parameter as a
java.math.BigDecimal object with as many digits to the
right of the decimal point as the value contains.
HSQLDB-Specific Information:
HSQLDB 1.7.2 does not support this feature.
Calling this method always throws an
SQLException.
getBigDecimal in interface CallableStatementparameterName - the name of the parameter
NULL, the result is null.
SQLException - if a database access error occurssetBigDecimal(java.lang.String, java.math.BigDecimal)
public Object getObject(String parameterName,
Map map)
throws SQLException
i and uses map for 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 method
registerOutParameter. By registering the target
JDBC type as java.sql.Types.OTHER, this method can
be used to read database-specific abstract data types.
HSQLDB-Specific Information:
HSQLDB 1.7.2 does not support this feature.
Calling this method always throws an
SQLException.
getObject in interface CallableStatementparameterName - the name of the parametermap - the mapping from SQL type names to Java classes
java.lang.Object holding the OUT parameter value
SQLException - if a database access error occurssetObject(java.lang.String, java.lang.Object, int, int)
public Ref getRef(String parameterName)
throws SQLException
REF(<structured-type>)
parameter as a Ref object in the Java programming language.
HSQLDB-Specific Information:
HSQLDB 1.7.2 does not support this feature.
Calling this method always throws an
SQLException.
getRef in interface CallableStatementparameterName - the name of the parameter
Ref object in the
Java programming language. If the value was SQL NULL,
the value null is returned.
SQLException - if a database access error occurs
public Blob getBlob(String parameterName)
throws SQLException
BLOB parameter as a
Blob object in the Java programming language.
HSQLDB-Specific Information:
HSQLDB 1.7.2 does not support this feature.
Calling this method always throws an
SQLException.
getBlob in interface CallableStatementparameterName - the name of the parameter
Blob object in the
Java programming language. If the value was SQL NULL,
the value null is returned.
SQLException - if a database access error occurs
public Clob getClob(String parameterName)
throws SQLException
CLOB parameter as a
Clob object in the Java programming language.
HSQLDB-Specific Information:
HSQLDB 1.7.2 does not support this feature.
Calling this method always throws an
SQLException.
getClob in interface CallableStatementparameterName - the name of the parameter
Clob object in the
Java programming language. If the value was SQL NULL,
the value null is returned.
SQLException - if a database access error occurs
public Array getArray(String parameterName)
throws SQLException
ARRAY parameter as an
Array object in the Java programming language.
HSQLDB-Specific Information:
HSQLDB 1.7.2 does not support this feature.
Calling this method always throws an
SQLException.
getArray in interface CallableStatementparameterName - the name of the parameter
Array object in
Java programming language. If the value was SQL NULL,
the value null is returned.
SQLException - if a database access error occurs
public Date getDate(String parameterName,
Calendar cal)
throws SQLException
DATE parameter as a
java.sql.Date object, using
the given Calendar object
to construct the date.
With a Calendar object, the driver
can calculate the date taking into account a custom timezone and
locale. If no Calendar object is specified, the d
river uses the default timezone and locale.
HSQLDB-Specific Information:
HSQLDB 1.7.2 does not support this feature.
Calling this method always throws an
SQLException.
getDate in interface CallableStatementparameterName - the name of the parametercal - the Calendar object the driver will use
to construct the date
NULL,
the result is null.
SQLException - if a database access error occurssetDate(java.lang.String, java.sql.Date)
public Time getTime(String parameterName,
Calendar cal)
throws SQLException
TIME parameter as a
java.sql.Time object, using
the given Calendar object
to construct the time.
With a Calendar object, the driver
can calculate the time taking into account a custom timezone and
locale. If no Calendar object is specified, the driver
uses the default timezone and locale.
HSQLDB-Specific Information:
HSQLDB 1.7.2 does not support this feature.
Calling this method always throws an
SQLException.
getTime in interface CallableStatementparameterName - the name of the parametercal - the Calendar object the driver will use
to construct the time
NULL,
the result is null.
SQLException - if a database access error occurssetTime(java.lang.String, java.sql.Time)
public Timestamp getTimestamp(String parameterName,
Calendar cal)
throws SQLException
TIMESTAMP parameter as a
java.sql.Timestamp object, using
the given Calendar object to construct
the Timestamp object.
With a Calendar object, the driver
can calculate the timestamp taking into account a custom timezone
and locale. If no Calendar object is specified, the
driver uses the default timezone and locale.
HSQLDB-Specific Information:
HSQLDB 1.7.2 does not support this feature.
Calling this method always throws an
SQLException.
getTimestamp in interface CallableStatementparameterName - the name of the parametercal - the Calendar object the driver will use
to construct the timestamp
NULL,
the result is null.
SQLException - if a database access error occurssetTimestamp(java.lang.String, java.sql.Timestamp)
public URL getURL(String parameterName)
throws SQLException
DATALINK parameter as a
java.net.URL object.
HSQLDB-Specific Information:
HSQLDB 1.7.2 does not support this feature.
Calling this method always throws an
SQLException.
getURL in interface CallableStatementparameterName - the name of the parameter
java.net.URL object in the
Java programming language. If the value was SQL
NULL, the value null is returned.
SQLException - if a database access error occurs,
or if there is a problem with the URLsetURL(java.lang.String, java.net.URL)
|
|||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||