CallableStatement

public interface CallableStatement implements PreparedStatement

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
getArray(int parameterIndex)
Retrieves the value of the designated JDBC ARRAY parameter as an Array object in the Java programming language.
abstract Array
getArray(String parameterName)
Retrieves the value of a JDBC ARRAY parameter as an Array object in the Java programming language.
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 was 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
getBlob(int parameterIndex)
Retrieves the value of the designated JDBC BLOB parameter as a Blob object in the Java programming language.
abstract Blob
getBlob(String parameterName)
Retrieves the value of a JDBC BLOB parameter as a Blob object in the Java programming language.
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
getByte(String parameterName)
Retrieves the value of a JDBC TINYINT parameter as a byte in the Java programming language.
abstract byte
getByte(int parameterIndex)
Retrieves the value of the designated JDBC TINYINT parameter as a byte in the Java programming language.
abstract 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.
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
getClob(String parameterName)
Retrieves the value of a JDBC CLOB parameter as a java.sql.Clob object in the Java programming language.
abstract Date
getDate(int parameterIndex)
Retrieves the value of the designated JDBC DATE parameter as a java.sql.Date object.
abstract Date
getDate(String parameterName)
Retrieves the value of a JDBC DATE parameter as a java.sql.Date object.
abstract 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.
abstract 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.
abstract double
getDouble(int parameterIndex)
Retrieves the value of the designated JDBC DOUBLE parameter as a double in the Java programming language.
abstract double
getDouble(String parameterName)
Retrieves the value of a JDBC DOUBLE parameter as a double in the Java programming language.
abstract float
getFloat(String parameterName)
Retrieves the value of a JDBC FLOAT parameter as a float in the Java programming language.
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
getInt(String parameterName)
Retrieves the value of a JDBC INTEGER parameter as an int in the Java programming language.
abstract long
getLong(String parameterName)
Retrieves the value of a JDBC BIGINT parameter as a long in the Java programming language.
abstract long