|
JDBC for CDC/FP Optional Package | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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.
Connection.prepareCall(java.lang.String)
,
ResultSet
Fields inherited from interface java.sql.Statement |
CLOSE_ALL_RESULTS, CLOSE_CURRENT_RESULT, EXECUTE_FAILED, KEEP_CURRENT_RESULT, NO_GENERATED_KEYS, RETURN_GENERATED_KEYS, SUCCESS_NO_INFO |
Method Summary | |
Blob |
getBlob(int i)
Retrieves the value of the designated 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. |
byte |
getByte(int parameterIndex)
Retrieves the value of the designated 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. |
Clob |
getClob(int i)
Retrieves the value of the designated 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,
java.util.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. |
double |
getDouble(int parameterIndex)
Retrieves the value of the designated 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. |
int |
getInt(int parameterIndex)
Retrieves the value of the designated 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. |
java.lang.Object |
getObject(int parameterIndex)
Retrieves the value of the designated parameter as an 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. |
java.lang.String |
getString(int parameterIndex)
Retrieves the value of the designated 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,
java.util.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. |
Timestamp |
getTimestamp(int parameterIndex)
Retrieves the value of the designated JDBC TIMESTAMP parameter as a
java.sql.Timestamp object. |
Timestamp |
getTimestamp(int parameterIndex,
java.util.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. |
java.net.URL |
getURL(int parameterIndex)
Retrieves the value of the designated 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,
java.lang.String typeName)
Registers the OUT parameter in ordinal position parameterIndex
to the JDBC type sqlType . |
boolean |
wasNull()
Retrieves whether the last OUT parameter read had the value of SQL NULL . |
Methods inherited from interface java.sql.PreparedStatement |
addBatch, clearParameters, execute, executeQuery, executeUpdate, getMetaData, setAsciiStream, setBinaryStream, setBlob, setBoolean, setByte, setBytes, setCharacterStream, setClob, setDate, setDate, setDouble, setFloat, setInt, setLong, setNull, setNull, setObject, setObject, setObject, setShort, setString, setTime, setTime, setTimestamp, setTimestamp, setURL |
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.
parameterIndex
- 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
.
parameterIndex
- 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.true
if the last parameter read was SQL
NULL
; false
otherwiseSQLException
- if a database access error occurspublic java.lang.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.
parameterIndex
- the first parameter is 1, the second is 2,
and so onNULL
,
the result
is null
.SQLException
- if a database access error occursPreparedStatement.setString(int, java.lang.String)
public boolean getBoolean(int parameterIndex) throws SQLException
BIT
parameter as a
boolean
in the Java programming language.parameterIndex
- the first parameter is 1, the second is 2,
and so onNULL
,
the result is false
.SQLException
- if a database access error occursPreparedStatement.setBoolean(int, boolean)
public byte getByte(int parameterIndex) throws SQLException
TINYINT
parameter
as a byte
in the Java programming language.parameterIndex
- the first parameter is 1, the second is 2,
and so onNULL
, the result
is 0
.SQLException
- if a database access error occursPreparedStatement.setByte(int, byte)
public short getShort(int parameterIndex) throws SQLException
SMALLINT
parameter
as a short
in the Java programming language.parameterIndex
- the first parameter is 1, the second is 2,
and so onNULL
, the result
is 0
.SQLException
- if a database access error occursPreparedStatement.setShort(int, short)
public int getInt(int parameterIndex) throws SQLException
INTEGER
parameter
as an int
in the Java programming language.parameterIndex
- the first parameter is 1, the second is 2,
and so onNULL
, the result
is 0
.SQLException
- if a database access error occursPreparedStatement.setInt(int, int)
public long getLong(int parameterIndex) throws SQLException
BIGINT
parameter
as a long
in the Java programming language.parameterIndex
- the first parameter is 1, the second is 2,
and so onNULL
, the result
is 0
.SQLException
- if a database access error occursPreparedStatement.setLong(int, long)
public float getFloat(int parameterIndex) throws SQLException
FLOAT
parameter
as a float
in the Java programming language.parameterIndex
- the first parameter is 1, the second is 2,
and so onNULL
, the result
is 0
.SQLException
- if a database access error occursPreparedStatement.setFloat(int, float)
public double getDouble(int parameterIndex) throws SQLException
DOUBLE
parameter as a double
in the Java programming language.parameterIndex
- the first parameter is 1, the second is 2,
and so onNULL
, the result
is 0
.SQLException
- if a database access error occursPreparedStatement.setDouble(int, double)
public byte[] getBytes(int parameterIndex) throws SQLException
BINARY
or
VARBINARY
parameter as an array of byte
values in the Java programming language.parameterIndex
- the first parameter is 1, the second is 2,
and so onNULL
, the result
is null
.SQLException
- if a database access error occursPreparedStatement.setBytes(int, byte[])
public Date getDate(int parameterIndex) throws SQLException
DATE
parameter as a
java.sql.Date
object.parameterIndex
- the first parameter is 1, the second is 2,
and so onNULL
, the result
is null
.SQLException
- if a database access error occursPreparedStatement.setDate(int, java.sql.Date)
public Time getTime(int parameterIndex) throws SQLException
TIME
parameter as a
java.sql.Time
object.parameterIndex
- the first parameter is 1, the second is 2,
and so onNULL
, the result
is null
.SQLException
- if a database access error occursPreparedStatement.setTime(int, java.sql.Time)
public Timestamp getTimestamp(int parameterIndex) throws SQLException
TIMESTAMP
parameter as a
java.sql.Timestamp
object.parameterIndex
- the first parameter is 1, the second is 2,
and so onNULL
, the result
is null
.SQLException
- if a database access error occursPreparedStatement.setTimestamp(int, java.sql.Timestamp)
public java.lang.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.
parameterIndex
- the first parameter is 1, the second is 2,
and so onjava.lang.Object
holding the OUT parameter valueSQLException
- if a database access error occursTypes
,
PreparedStatement.setObject(int, java.lang.Object, int, int)
public Blob getBlob(int i) throws SQLException
BLOB
parameter as a
Blob
object in the Java programming language.i
- the first parameter is 1, the second is 2, and so onBlob
object in the
Java programming language. If the value was SQL NULL
, the value
null
is returned.SQLException
- if a database access error occurspublic Clob getClob(int i) throws SQLException
CLOB
parameter as a
Clob
object in the Java programming language.i
- the first parameter is 1, the second is 2, and
so onClob
object in the
Java programming language. If the value was SQL NULL
, the
value null
is returned.SQLException
- if a database access error occurspublic Date getDate(int parameterIndex, java.util.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.parameterIndex
- the first parameter is 1, the second is 2,
and so oncal
- the Calendar
object the driver will use
to construct the dateNULL
, the result
is null
.SQLException
- if a database access error occursPreparedStatement.setDate(int, java.sql.Date)
public Time getTime(int parameterIndex, java.util.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.parameterIndex
- the first parameter is 1, the second is 2,
and so oncal
- the Calendar
object the driver will use
to construct the timeNULL
, the result
is null
.SQLException
- if a database access error occursPreparedStatement.setTime(int, java.sql.Time)
public Timestamp getTimestamp(int parameterIndex, java.util.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.parameterIndex
- the first parameter is 1, the second is 2,
and so oncal
- the Calendar
object the driver will use
to construct the timestampNULL
, the result
is null
.SQLException
- if a database access error occursPreparedStatement.setTimestamp(int, java.sql.Timestamp)
public void registerOutParameter(int paramIndex, int sqlType, java.lang.String typeName) 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 method getXXX to read
the value of that parameter.
If the JDBC type expected to be returned to this output parameters is
specified to this particular database, sqlType
should be
java.sql.Types.OTHER
. The method
CallableStatement.getObject
will retrieve the value.
Notes: 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.
paramIndex
- the first parameter is 1, the second 2,...sqlType
- a value from Types
typeName
- the fully-qualified name of a SQL structured typeSQLException
- if a database access error occursTypes
public java.net.URL getURL(int parameterIndex) throws SQLException
DATALINK
parameter as a java.net.URL
object.parameterIndex
- the first parameter is 1, the second is 2,...java.net.URL
object that represents the
JDBC DATALINK
value used as the designated
parameterSQLException
- if a database access error occurs,
or if the URL being returned is
not a valid URL on the Java platformPreparedStatement.setURL(int, java.net.URL)
|
JDBC for CDC/FP Optional Package | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |