Java Doc for CallableStatement.java in  » 6.0-JDK-Core » sql » java » sql » Java Source Code / Java DocumentationJava Source Code and Java Documentation

 {?= 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
See Also:   ResultSet
See Also:   

For the fixed-length type JDBC NCHAR, the String object returned has exactly the same value the SQL NCHAR value had in the database, including any padding added by the database.
Parameters:
  parameterIndex - index of the first parameter is 1, the second is 2, ...

This method returns a Java object whose type corresponds to the JDBC type that was registered for this parameter using the method registerOutParameter.

This method returns a Java object whose type corresponds to the JDBC type that was registered for this parameter using the method registerOutParameter.

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 the parameter value.

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:
  parameterName - the name of the parameter the parameter value.

For the fixed-length type JDBC NCHAR, the String object returned has exactly the same value the SQL NCHAR value had in the database, including any padding added by the database.
Parameters:
  parameterIndex - index of the first parameter is 1, the second is 2, ... a String object that maps an NCHAR, NVARCHAR or LONGNVARCHAR value
exception:
  SQLException - if the parameterIndex is not valid; if a database access error occurs or this method is called on a closed CallableStatement
exception:
  SQLFeatureNotSupportedException - if the JDBC driver does not supportthis method
since:
   1.6
See Also:   CallableStatement.setNString

For the fixed-length type JDBC NCHAR, the String object returned has exactly the same value the SQL NCHAR value had in the database, including any padding added by the database.
Parameters:
  parameterName - the name of the parameter a String object that maps an NCHAR, NVARCHAR or LONGNVARCHAR value
exception:
  SQLException - if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closed CallableStatement
exception:
  SQLFeatureNotSupportedException - if the JDBC driver does not supportthis method
since:
   1.6
See Also:   CallableStatement.setNString

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.
Parameters:
  parameterIndex - the first parameter is 1, the second is 2, and so on A java.lang.Object holding the OUT parameter value
exception:
  SQLException - if the parameterIndex is not valid; if a database access error occurs or this method is called on a closed CallableStatement
See Also:   Types
See Also:   
See Also:   CallableStatement.setObject

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.
Parameters:
  parameterIndex - the first parameter is 1, the second is 2, and so on
Parameters:
  map - the mapping from SQL type names to Java classes a java.lang.Object holding the OUT parameter value
exception:
  SQLException - if the parameterIndex is not valid; if a database access error occurs or this method is called on a closed CallableStatement
exception:
  SQLFeatureNotSupportedException - if the JDBC driver does not supportthis method
See Also:   CallableStatement.setObject
since:
   1.2

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.
Parameters:
  parameterName - the name of the parameter A java.lang.Object holding the OUT parameter value.
exception:
  SQLException - if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closed CallableStatement
exception:
  SQLFeatureNotSupportedException - if the JDBC driver does not supportthis method
See Also:   Types
See Also:   CallableStatement.setObject
since:
   1.4

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.
Parameters:
  parameterName - the name of the parameter
Parameters:
  map - the mapping from SQL type names to Java classes a java.lang.Object holding the OUT parameter value
exception:
  SQLException - if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closed CallableStatement
exception:
  SQLFeatureNotSupportedException - if the JDBC driver does not supportthis method
See Also:   CallableStatement.setObject
since:
   1.4

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 the parameter value. If the value is SQL NULL, the result is null.
exception:
  SQLException - if the parameterIndex is not valid; if a database access error occurs or this method is called on a closed CallableStatement
See Also:   CallableStatement.setString

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:
  parameterName - the name of the parameter the parameter value. If the value is SQL NULL, the result is null.
exception:
  SQLException - if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closed CallableStatement
exception:
  SQLFeatureNotSupportedException - if the JDBC driver does not supportthis method
See Also:   CallableStatement.setString
since:
   1.4

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 CallableStatement.getObject retrieves the value.
Parameters:
  parameterIndex - the first parameter is 1, the second is 2, and so on
Parameters:
  sqlType - the JDBC type code defined by java.sql.Types.If the parameter is of JDBC type NUMERICor DECIMAL, the version ofregisterOutParameter that accepts a scale value should be used.
exception:
  SQLException - if the parameterIndex is not valid; if a database access error occurs or this method is called on a closed CallableStatement
exception:
  SQLFeatureNotSupportedException - if sqlType isa ARRAY, BLOB, CLOB, DATALINK, JAVA_OBJECT, NCHAR, NCLOB, NVARCHAR, LONGNVARCHAR,REF, ROWID, SQLXMLor STRUCT data type and the JDBC driver does not supportthis data type
See Also:   Types
See Also:   

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
Parameters:
  sqlType - the SQL type code defined by java.sql.Types.
Parameters:
  scale - the desired number of digits to the right of thedecimal point. It must be greater than or equal to zero.
exception:
  SQLException - if the parameterIndex is not valid; if a database access error occurs or this method is called on a closed CallableStatement
exception:
  SQLFeatureNotSupportedException - if sqlType isa ARRAY, BLOB, CLOB, DATALINK, JAVA_OBJECT, NCHAR, NCLOB, NVARCHAR, LONGNVARCHAR,REF, ROWID, SQLXMLor STRUCT data type and the JDBC driver does not supportthis data type
See Also:   Types
See Also:   

All OUT parameters must be registered before a stored procedure is executed.

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.
Parameters:
  parameterIndex - the first parameter is 1, the second is 2,...
Parameters:
  sqlType - a value from java.sql.Types
Parameters:
  typeName - the fully-qualified name of an SQL structured type
exception:
  SQLException - if the parameterIndex is not valid; if a database access error occurs or this method is called on a closed CallableStatement
exception:
  SQLFeatureNotSupportedException - if sqlType isa ARRAY, BLOB, CLOB, DATALINK, JAVA_OBJECT, NCHAR, NCLOB, NVARCHAR, LONGNVARCHAR,REF, ROWID, SQLXMLor STRUCT data type and the JDBC driver does not supportthis data type
See Also:   Types
since:
   1.2

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 CallableStatement.getObject retrieves the value.
Parameters:
  parameterName - the name of the parameter
Parameters:
  sqlType - the JDBC type code defined by java.sql.Types.If the parameter is of JDBC type NUMERICor DECIMAL, the version ofregisterOutParameter that accepts a scale value should be used.
exception:
  SQLException - if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closed CallableStatement
exception:
  SQLFeatureNotSupportedException - if sqlType isa ARRAY, BLOB, CLOB, DATALINK, JAVA_OBJECT, NCHAR, NCLOB, NVARCHAR, LONGNVARCHAR,REF, ROWID, SQLXMLor STRUCT data type and the JDBC driver does not supportthis data type or if the JDBC driver does not supportthis method
since:
   1.4
See Also:   Types
See Also:   

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:
  parameterName - the name of the parameter
Parameters:
  sqlType - SQL type code defined by java.sql.Types.
Parameters:
  scale - the desired number of digits to the right of thedecimal point. It must be greater than or equal to zero.
exception:
  SQLException - if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closed CallableStatement
exception:
  SQLFeatureNotSupportedException - if sqlType isa ARRAY, BLOB, CLOB, DATALINK, JAVA_OBJECT, NCHAR, NCLOB, NVARCHAR, LONGNVARCHAR,REF, ROWID, SQLXMLor STRUCT data type and the JDBC driver does not supportthis data type or if the JDBC driver does not supportthis method
since:
   1.4
See Also:   Types
See Also:   

All OUT parameters must be registered before a stored procedure is executed.

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.
Parameters:
  parameterName - the name of the parameter
Parameters:
  sqlType - a value from java.sql.Types
Parameters:
  typeName - the fully-qualified name of an SQL structured type
exception:
  SQLException - if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closed CallableStatement
exception:
  SQLFeatureNotSupportedException - if sqlType isa ARRAY, BLOB, CLOB, DATALINK, JAVA_OBJECT, NCHAR, NCLOB, NVARCHAR, LONGNVARCHAR,REF, ROWID, SQLXMLor STRUCT data type and the JDBC driver does not supportthis data type or if the JDBC driver does not supportthis method
See Also:   Types
since:
   1.4

Note: This stream object can either be a standard Java stream object or your own subclass that implements the standard interface.
Parameters:
  parameterName - the name of the parameter
Parameters:
  x - the Java input stream that contains the ASCII parameter value
Parameters:
  length - the number of bytes in the stream
exception:
  SQLException - if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closed CallableStatement
exception:
  SQLFeatureNotSupportedException - if the JDBC driver does not supportthis method
since:
   1.4

Note: This stream object can either be a standard Java stream object or your own subclass that implements the standard interface.
Parameters:
  parameterName - the name of the parameter
Parameters:
  x - the Java input stream that contains the ASCII parameter value
Parameters:
  length - the number of bytes in the stream
exception:
  SQLException - if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closed CallableStatement
exception:
  SQLFeatureNotSupportedException - if the JDBC driver does not supportthis method
since:
   1.6

Note: This stream object can either be a standard Java stream object or your own subclass that implements the standard interface.

Note: Consult your JDBC driver documentation to determine if it might be more efficient to use a version of setAsciiStream which takes a length parameter.
Parameters:
  parameterName - the name of the parameter
Parameters:
  x - the Java input stream that contains the ASCII parameter value
exception:
  SQLException - if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closed CallableStatement
throws:
  SQLFeatureNotSupportedException - if the JDBC driver does not support this method
since:
   1.6

Note: This stream object can either be a standard Java stream object or your own subclass that implements the standard interface.
Parameters:
  parameterName - the name of the parameter
Parameters:
  x - the java input stream which contains the binary parameter value
Parameters:
  length - the number of bytes in the stream
exception:
  SQLException - if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closed CallableStatement
exception:
  SQLFeatureNotSupportedException - if the JDBC driver does not supportthis method
since:
   1.4

Note: This stream object can either be a standard Java stream object or your own subclass that implements the standard interface.
Parameters:
  parameterName - the name of the parameter
Parameters:
  x - the java input stream which contains the binary parameter value
Parameters:
  length - the number of bytes in the stream
exception:
  SQLException - if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closed CallableStatement
exception:
  SQLFeatureNotSupportedException - if the JDBC driver does not supportthis method
since:
   1.6

Note: This stream object can either be a standard Java stream object or your own subclass that implements the standard interface.

Note: Consult your JDBC driver documentation to determine if it might be more efficient to use a version of setBinaryStream which takes a length parameter.
Parameters:
  parameterName - the name of the parameter
Parameters:
  x - the java input stream which contains the binary parameter value
exception:
  SQLException - if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closed CallableStatement
throws:
  SQLFeatureNotSupportedException - if the JDBC driver does not support this method
since:
   1.6

Note: Consult your JDBC driver documentation to determine if it might be more efficient to use a version of setBlob which takes a length parameter.
Parameters:
  parameterName - the name of the parameter
Parameters:
  inputStream - An object that contains the data to set the parametervalue to.
throws:
  SQLException - if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closed CallableStatement
throws:
  SQLFeatureNotSupportedException - if the JDBC driver does not support this method
since:
   1.6

Note: This stream object can either be a standard Java stream object or your own subclass that implements the standard interface.
Parameters:
  parameterName - the name of the parameter
Parameters:
  reader - the java.io.Reader object thatcontains the UNICODE data used as the designated parameter
Parameters:
  length - the number of characters in the stream
exception:
  SQLException - if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closed CallableStatement
exception:
  SQLFeatureNotSupportedException - if the JDBC driver does not supportthis method
since:
   1.4

Note: This stream object can either be a standard Java stream object or your own subclass that implements the standard interface.
Parameters:
  parameterName - the name of the parameter
Parameters:
  reader - the java.io.Reader object thatcontains the UNICODE data used as the designated parameter
Parameters:
  length - the number of characters in the stream
exception:
  SQLException - if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closed CallableStatement
exception:
  SQLFeatureNotSupportedException - if the JDBC driver does not supportthis method
since:
   1.6

Note: This stream object can either be a standard Java stream object or your own subclass that implements the standard interface.

Note: Consult your JDBC driver documentation to determine if it might be more efficient to use a version of setCharacterStream which takes a length parameter.
Parameters:
  parameterName - the name of the parameter
Parameters:
  reader - the java.io.Reader object that contains the Unicode data
exception:
  SQLException - if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closed CallableStatement
throws:
  SQLFeatureNotSupportedException - if the JDBC driver does not support this method
since:
   1.6

Note: Consult your JDBC driver documentation to determine if it might be more efficient to use a version of setClob which takes a length parameter.
Parameters:
  parameterName - the name of the parameter
Parameters:
  reader - An object that contains the data to set the parameter value to.
throws:
  SQLException - if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called ona closed CallableStatement
throws:
  SQLFeatureNotSupportedException - if the JDBC driver does not support this method
since:
   1.6

Note: This stream object can either be a standard Java stream object or your own subclass that implements the standard interface.

Note: Consult your JDBC driver documentation to determine if it might be more efficient to use a version of setNCharacterStream which takes a length parameter.
Parameters:
  parameterName - the name of the parameter
Parameters:
  value - the parameter value
throws:
  SQLException - if parameterName does not correspond to a named parameter; if the driver does not support nationalcharacter sets; if the driver can detect that a data conversionerror could occur; if a database access error occurs; or this method is called on a closed CallableStatement
throws:
  SQLFeatureNotSupportedException - if the JDBC driver does not support this method
since:
   1.6

Note: Consult your JDBC driver documentation to determine if it might be more efficient to use a version of setNClob which takes a length parameter.
Parameters:
  parameterName - the name of the parameter
Parameters:
  reader - An object that contains the data to set the parameter value to.
throws:
  SQLException - if parameterName does not correspond to a named parameter; if the driver does not support national character sets;if the driver can detect that a data conversionerror could occur; if a database access error occurs or this method is called on a closed CallableStatement
throws:
  SQLFeatureNotSupportedException - if the JDBC driver does not support this method
since:
   1.6

Note: You must specify the parameter's SQL type.
Parameters:
  parameterName - the name of the parameter
Parameters:
  sqlType - the SQL type code defined in java.sql.Types
exception:
  SQLException - if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closed CallableStatement
exception:
  SQLFeatureNotSupportedException - if the JDBC driver does not supportthis method
since:
   1.4

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.

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.
Parameters:
  parameterName - the name of the parameter
Parameters:
  sqlType - a value from java.sql.Types
Parameters:
  typeName - the fully-qualified name of an SQL user-defined type;ignored if the parameter is not a user-defined type or SQL REF value
exception:
  SQLException - if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closed CallableStatement
exception:
  SQLFeatureNotSupportedException - if the JDBC driver does not supportthis method
since:
   1.4

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, NClob, Struct, java.net.URL, 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.
Parameters:
  parameterName - the name of the parameter
Parameters:
  x - the object containing the input parameter value
Parameters:
  targetSqlType - the SQL type (as defined in java.sql.Types) to be sent to the database. The scale argument may further qualify this type.
Parameters:
  scale - for java.sql.Types.DECIMAL or java.sql.Types.NUMERIC types,this is the number of digits after the decimal point. For all othertypes, this value will be ignored.
exception:
  SQLException - if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closed CallableStatement
exception:
  SQLFeatureNotSupportedException - if targetSqlType isa ARRAY, BLOB, CLOB, DATALINK, JAVA_OBJECT, NCHAR, NCLOB, NVARCHAR, LONGNVARCHAR,REF, ROWID, SQLXMLor STRUCT data type and the JDBC driver does not supportthis data type
See Also:   Types
See Also:   CallableStatement.getObject
since:
   1.4

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, NClob, Struct, java.net.URL, 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.

Note: Not all databases allow for a non-typed Null to be sent to the backend. For maximum portability, the setNull or the setObject(String parameterName, Object x, int sqlType) method should be used instead of setObject(String parameterName, Object x).

Parameters:
  parameterName - the name of the parameter
Parameters:
  x - the object containing the input parameter value
exception:
  SQLException - if parameterName does not correspond to a named parameter; if a database access error occurs,this method is called on a closed CallableStatement or if the givenObject parameter is ambiguous
exception:
  SQLFeatureNotSupportedException - if the JDBC driver does not supportthis method
See Also:   CallableStatement.getObject
since:
   1.4