java.sql
Interface CallableStatement

All Superinterfaces:

PreparedStatement, Statement, Wrapper

public interface CallableStatement
extends 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.

See Also:

Connection.prepareCall(java.lang.String), ResultSet

Field Summary

 

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
Array	getArray(int parameterIndex)           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 parameterIndex)           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 or BOOLEAN parameter as a boolean in the Java programming language.
boolean	getBoolean(String parameterName)           Retrieves the value of a JDBC BIT or BOOLEAN 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.
Reader	getCharacterStream(int parameterIndex)           Retrieves the value of the designated parameter as a java.io.Reader object in the Java programming language.
Reader	getCharacterStream(String parameterName)           Retrieves the value of the designated parameter as a java.io.Reader object in the Java programming language.
Clob	getClob(int parameterIndex)           Retrieves the value of the designated JDBC CLOB parameter as a java.sql.Clob object in the Java programming language.
Clob	getClob(String parameterName)           Retrieves the value of a JDBC CLOB parameter as a java.sql.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.
Reader	getNCharacterStream(int parameterIndex)           Retrieves the value of the designated parameter as a java.io.Reader object in the Java programming language.
Reader	getNCharacterStream(String parameterName)           Retrieves the value of the designated parameter as a java.io.Reader object in the Java programming language.
NClob	getNClob(int parameterIndex)           Retrieves the value of the designated JDBC NCLOB parameter as a java.sql.NClob object in the Java programming language.
NClob	getNClob(String parameterName)           Retrieves the value of a JDBC NCLOB parameter as a java.sql.NClob object in the Java programming language.
String	getNString(int parameterIndex)           Retrieves the value of the designated NCHAR, NVARCHAR or LONGNVARCHAR parameter as a String in the Java programming language.
String	getNString(String parameterName)           Retrieves the value of the designated NCHAR, NVARCHAR or LONGNVARCHAR parameter as a String 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 parameterIndex, Map<String,Class<?>> map)           Returns an object representing the value of OUT parameter parameterIndex 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<String,Class<?>> map)           Returns an object representing the value of OUT parameter parameterName and uses map for the custom mapping of the parameter value.
Ref	getRef(int parameterIndex)           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.
RowId	getRowId(int parameterIndex)           Retrieves the value of the designated JDBC ROWID parameter as a java.sql.RowId object.
RowId	getRowId(String parameterName)           Retrieves the value of the designated JDBC ROWID parameter as a java.sql.RowId object.
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.
SQLXML	getSQLXML(int parameterIndex)           Retrieves the value of the designated SQL XML parameter as a java.sql.SQLXML object in the Java programming language.
SQLXML	getSQLXML(String parameterName)           Retrieves the value of the designated SQL XML parameter as a java.sql.SQLXML object 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 parameterIndex, 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)           Sets the designated parameter to the given input stream.
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	setAsciiStream(String parameterName, InputStream x, long 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)           Sets the designated parameter to the given input stream.
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	setBinaryStream(String parameterName, InputStream x, long length)           Sets the designated parameter to the given input stream, which will have the specified number of bytes.
void	setBlob(String parameterName, Blob x)           Sets the designated parameter to the given java.sql.Blob object.
void	setBlob(String parameterName, InputStream inputStream)           Sets the designated parameter to a InputStream object.
void	setBlob(String parameterName, InputStream inputStream, long length)           Sets the designated parameter to a InputStream object.
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)           Sets the designated parameter to the given Reader object.
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	setCharacterStream(String parameterName, Reader reader, long length)           Sets the designated parameter to the given Reader object, which is the given number of characters long.
void	setClob(String parameterName, Clob x)           Sets the designated parameter to the given java.sql.Clob object.
void	setClob(String parameterName, Reader reader)           Sets the designated parameter to a Reader object.
void	setClob(String parameterName, Reader reader, long length)           Sets the designated parameter to a Reader object.
void	setDate(String parameterName, Date x)           Sets the designated parameter to the given java.sql.Date value using the default time zone of the virtual machine that is running the application.
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	setNCharacterStream(String parameterName, Reader value)           Sets the designated parameter to a Reader object.
void	setNCharacterStream(String parameterName, Reader value, long length)           Sets the designated parameter to a Reader object.
void	setNClob(String parameterName, NClob value)           Sets the designated parameter to a java.sql.NClob object.
void	setNClob(String parameterName, Reader reader)           Sets the designated parameter to a Reader object.
void	setNClob(String parameterName, Reader reader, long length)           Sets the designated parameter to a Reader object.
void	setNString(String parameterName, String value)           Sets the designated parameter to the given String object.
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	setRowId(String parameterName, RowId x)           Sets the designated parameter to the given java.sql.RowId object.
void	setShort(String parameterName, short x)           Sets the designated parameter to the given Java short value.
void	setSQLXML(String parameterName, SQLXML xmlObject)           Sets the designated parameter to the given java.sql.SQLXML object.
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 interface java.sql.PreparedStatement

addBatch, clearParameters, execute, executeQuery, executeUpdate, getMetaData, getParameterMetaData, setArray, setAsciiStream, setAsciiStream, setAsciiStream, setBigDecimal, setBinaryStream, setBinaryStream, setBinaryStream, setBlob, setBlob, setBlob, setBoolean, setByte, setBytes, setCharacterStream, setCharacterStream, setCharacterStream, setClob, setClob, setClob, setDate, setDate, setDouble, setFloat, setInt, setLong, setNCharacterStream, setNCharacterStream, setNClob, setNClob, setNClob, setNString, setNull, setNull, setObject, setObject, setObject, setRef, setRowId, setShort, setSQLXML, setString, setTime, setTime, setTimestamp, setTimestamp, setUnicodeStream, setURL

 

Methods inherited from interface java.sql.Statement

addBatch, cancel, clearBatch, clearWarnings, close, execute, execute, execute, execute, executeBatch, executeQuery, executeUpdate, executeUpdate, executeUpdate, executeUpdate, getConnection, getFetchDirection, getFetchSize, getGeneratedKeys, getMaxFieldSize, getMaxRows, getMoreResults, getMoreResults, getQueryTimeout, getResultSet, getResultSetConcurrency, getResultSetHoldability, getResultSetType, getUpdateCount, getWarnings, isClosed, isPoolable, setCursorName, setEscapeProcessing, setFetchDirection, setFetchSize, setMaxFieldSize, setMaxRows, setPoolable, setQueryTimeout

 

Methods inherited from interface java.sql.Wrapper
isWrapperFor, unwrap

 

Method Detail

registerOutParameter

void registerOutParameter(int parameterIndex,
                          int sqlType)
                          throws SQLException

Registers the OUT parameter in ordinal position 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.

Parameters:

parameterIndex - the first parameter is 1, the second is 2, and so on

sqlType - 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.

Throws:

SQLException - if the parameterIndex is not valid; if a database access error occurs or this method is called on a closed CallableStatement

SQLFeatureNotSupportedException - if sqlType is a ARRAY, BLOB, CLOB, DATALINK, JAVA_OBJECT, NCHAR, NCLOB, NVARCHAR, LONGNVARCHAR, REF, ROWID, SQLXML or STRUCT data type and the JDBC driver does not support this data type

See Also:

Types

registerOutParameter

void registerOutParameter(int parameterIndex,
                          int sqlType,
                          int scale)
                          throws SQLException

Registers the parameter in ordinal position parameterIndex to be of 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.

This version of registerOutParameter should be used when the parameter is of JDBC type NUMERIC or DECIMAL.

Parameters:

parameterIndex - the first parameter is 1, the second is 2, and so on

sqlType - 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.

Throws:

SQLException - if the parameterIndex is not valid; if a database access error occurs or this method is called on a closed CallableStatement

SQLFeatureNotSupportedException - if sqlType is a ARRAY, BLOB, CLOB, DATALINK, JAVA_OBJECT, NCHAR, NCLOB, NVARCHAR, LONGNVARCHAR, REF, ROWID, SQLXML or STRUCT data type and the JDBC driver does not support this data type

See Also:

Types

wasNull

boolean wasNull()
                throws SQLException

Retrieves whether the last OUT parameter read had the value of SQL 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.

Returns:

true if the last parameter read was SQL NULL; false otherwise

Throws:

SQLException - if a database access error occurs or this method is called on a closed CallableStatement

getString

String getString(int parameterIndex)
                 throws SQLException

Retrieves the value of the designated JDBC 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 SQL CHAR value had in the database, including any padding added by the database.

Parameters:

parameterIndex - the first parameter is 1, the second is 2, and so on

Returns:

the parameter value. If the value is SQL NULL, the result is null.

Throws:

SQLException - if the parameterIndex is not valid; if a database access error occurs or this method is called on a closed CallableStatement

See Also:

se