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.
Inherited Constant Summary
Public Method Summary
abstract Array | |
abstract Array | |
abstract 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. |
abstract BigDecimal |
getBigDecimal(int parameterIndex, int scale)
This method is deprecated.
use
getBigDecimal(int parameterIndex)
or getBigDecimal(String parameterName) |
abstract 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. |
abstract Blob | |
abstract Blob | |
abstract boolean |
getBoolean(String parameterName)
Retrieves the value of a JDBC
BIT or BOOLEAN
parameter as a
boolean in the Java programming language. |
abstract boolean |
getBoolean(int parameterIndex)
Retrieves the value of the designated JDBC
BIT
or BOOLEAN parameter as a
boolean in the Java programming language. |
abstract byte | |
abstract byte |
getByte(int parameterIndex)
Retrieves the value of the designated JDBC
TINYINT parameter
as a byte in the Java programming language. |
abstract byte[] | |
abstract 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. |
abstract Reader |
getCharacterStream(int parameterIndex)
Retrieves the value of the designated parameter as a
java.io.Reader object in the Java programming language. |
abstract Reader |
getCharacterStream(String parameterName)
Retrieves the value of the designated parameter as a
java.io.Reader object in the Java programming language. |
abstract Clob |
getClob(int parameterIndex)
Retrieves the value of the designated JDBC
CLOB parameter as a
java.sql.Clob object in the Java programming language. |
abstract Clob | |
abstract Date |
getDate(int parameterIndex)
Retrieves the value of the designated JDBC
DATE parameter as a
java.sql.Date object. |
abstract Date | |
abstract Date | |
abstract Date | |
abstract double |
getDouble(int parameterIndex)
Retrieves the value of the designated JDBC
DOUBLE parameter as a double
in the Java programming language. |
abstract double | |
abstract float | |
abstract float |
getFloat(int parameterIndex)
Retrieves the value of the designated JDBC
FLOAT parameter
as a float in the Java programming language. |
abstract int |
getInt(int parameterIndex)
Retrieves the value of the designated JDBC
INTEGER parameter
as an int in the Java programming language. |
abstract int | |
abstract long | |
abstract long |
getLong(int parameterIndex)
Retrieves the value of the designated JDBC
BIGINT parameter
as a long in the Java programming language. |
abstract Reader |
getNCharacterStream(int parameterIndex)
Retrieves the value of the designated parameter as a
java.io.Reader object in the Java programming language. |
abstract Reader |
getNCharacterStream(String parameterName)
Retrieves the value of the designated parameter as a
java.io.Reader object in the Java programming language. |
abstract NClob | |
abstract NClob |
getNClob(int parameterIndex)
Retrieves the value of the designated JDBC
NCLOB parameter as a
java.sql.NClob object in the Java programming language. |
abstract String |
getNString(String parameterName)
Retrieves the value of the designated
NCHAR ,
NVARCHAR
or LONGNVARCHAR parameter as
a String in the Java programming language. |
abstract String |
getNString(int parameterIndex)
Retrieves the value of the designated
NCHAR ,
NVARCHAR
or LONGNVARCHAR parameter as
a String in the Java programming language. |
abstract Object |
getObject(int parameterIndex)
Retrieves the value of the designated parameter as an
Object
in the Java programming language. |
abstract Object | |
abstract Object | |
abstract Object | |
abstract Ref | |
abstract Ref | |
abstract RowId |
getRowId(int parameterIndex)
Retrieves the value of the designated JDBC
ROWID parameter as a
java.sql.RowId object. |
abstract RowId | |
abstract SQLXML | |
abstract SQLXML |
getSQLXML(int parameterIndex)
Retrieves the value of the designated
SQL XML parameter as a
java.sql.SQLXML object in the Java programming language. |
abstract short | |
abstract short |
getShort(int parameterIndex)
Retrieves the value of the designated JDBC
SMALLINT parameter
as a short in the Java programming language. |
abstract String |
getString(int parameterIndex)
Retrieves the value of the designated JDBC
CHAR ,
VARCHAR , or LONGVARCHAR parameter as a
String in the Java programming language. |
abstract String | |
abstract Time | |
abstract Time | |
abstract Time |
getTime(int parameterIndex)
Retrieves the value of the designated JDBC
TIME parameter as a
java.sql.Time object. |
abstract Time | |
abstract 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. |
abstract Timestamp |
getTimestamp(int parameterIndex)
Retrieves the value of the designated JDBC
TIMESTAMP parameter as a
java.sql.Timestamp object. |
abstract 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. |
abstract Timestamp |
getTimestamp(String parameterName)
Retrieves the value of a JDBC
TIMESTAMP parameter as a
java.sql.Timestamp object. |
abstract URL |
getURL(int parameterIndex)
Retrieves the value of the designated JDBC
DATALINK parameter as a
java.net.URL object. |
abstract URL | |
abstract void |
registerOutParameter(int parameterIndex, int sqlType)
Registers the OUT parameter in ordinal position
parameterIndex to the JDBC type
sqlType . |
abstract void |
registerOutParameter(String parameterName, int sqlType, String typeName)
Registers the designated output parameter.
|
abstract void |
registerOutParameter(int parameterIndex, int sqlType, String typeName)
Registers the designated output parameter.
|
abstract void |
registerOutParameter(int parameterIndex, int sqlType, int scale)
Registers the parameter in ordinal position
parameterIndex to be of JDBC type
sqlType . |
abstract void |
registerOutParameter(String parameterName, int sqlType, int scale)
Registers the parameter named
parameterName to be of JDBC type
sqlType . |
abstract void |
registerOutParameter(String parameterName, int sqlType)
Registers the OUT parameter named
parameterName to the JDBC type
sqlType . |
abstract 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.
|
abstract void |
setAsciiStream(String parameterName, InputStream x, long length)
Sets the designated parameter to the given input stream, which will have
the specified number of bytes.
|
abstract void |
setAsciiStream(String parameterName, InputStream x)
Sets the designated parameter to the given input stream.
|
abstract void |
setBigDecimal(String parameterName, BigDecimal x)
Sets the designated parameter to the given
java.math.BigDecimal value. |
abstract void |
setBinaryStream(String parameterName, InputStream x)
Sets the designated parameter to the given input stream.
|
abstract void |
setBinaryStream(String parameterName, InputStream x, long length)
Sets the designated parameter to the given input stream, which will have
the specified number of bytes.
|
abstract 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.
|
abstract void | |
abstract void |
setBlob(String parameterName, InputStream inputStream, long length)
Sets the designated parameter to a
InputStream object. |
abstract void |
setBlob(String parameterName, InputStream inputStream)
Sets the designated parameter to a
InputStream object. |
abstract void |
setBoolean(String parameterName, boolean x)
Sets the designated parameter to the given Java
boolean value. |
abstract void | |
abstract void | |
abstract 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. |
abstract void |
setCharacterStream(String parameterName, Reader reader, long length)
Sets the designated parameter to the given
Reader
object, which is the given number of characters long. |
abstract void |
setCharacterStream(String parameterName, Reader reader)
Sets the designated parameter to the given
Reader
object. |
abstract void | |
abstract void | |
abstract void | |
abstract void | |
abstract void | |
abstract void | |
abstract void | |
abstract void | |
abstract void | |
abstract void |
setNCharacterStream(String parameterName, Reader value, long length)
Sets the designated parameter to a
Reader object. |
abstract void |
setNCharacterStream(String parameterName, Reader value)
Sets the designated parameter to a
Reader object. |
abstract void | |
abstract void | |
abstract void | |
abstract void |
setNString(String parameterName, String value)
Sets the designated parameter to the given
String object. |
abstract void | |
abstract void | |
abstract void | |
abstract void | |
abstract void | |
abstract void | |
abstract void | |
abstract void | |
abstract void | |
abstract void | |
abstract void | |
abstract void |
setTimestamp(String parameterName, Timestamp x, Calendar cal)
Sets the designated parameter to the given
java.sql.Timestamp value,
using the given Calendar object. |
abstract void |
setTimestamp(String parameterName, Timestamp x)
Sets the designated parameter to the given
java.sql.Timestamp value. |
abstract void | |
abstract boolean |
wasNull()
Retrieves whether the last OUT parameter read had the value of
SQL
NULL . |