Java Doc for CallableStatement.java in  » Apache-Harmony-Java-SE » java-package » java » sql » Java Source Code / Java DocumentationJava Source Code and Java Documentation

The JDBC API provides an SQL escape syntax allowing Stored Procedures to be called in a standard way for all databases. The JDBC escape syntax has two forms. One form includes a result parameter. The second form does not include a result parameter. Where the result parameter is used, it must be declared as an OUT parameter. Other parameters can be declared as IN, OUT or INOUT. Parameters are referenced either by name or by a numerical index, with the first parameter being 1, the second 1 and so on. Here are examples of the two forms of the escape syntax: { ?= call <.procedurename>.[([parameter1,parameter2,...])]} {call <.procedurename>.[([parameter1,parameter2,...])]}

IN parameters are set before calling the procedure, using the setter methods which are inherited from PreparedStatement. For OUT parameters, their Type must be registered before executing the stored procedure, and the value is retrieved using the getter methods defined in the CallableStatement interface.

CallableStatements can return one or more ResultSets. Where multiple ResultSets are returned they are accessed using the methods inherited from the Statement interface.

The JDBC driver uses the Calendar to create the Date using a particular timezone and locale.

The JDBC driver uses the Calendar to create the Date using a particular timezone and locale.

The object type returned is the JDBC type registered for the parameter with a registerOutParameter call.

The object type returned is the JDBC type registered for the parameter with a registerOutParameter call.

This is a good method for setting an SQL LONVARCHAR parameter where the length of the data is large.

The Object is converted to the given targetSqlType before it is sent to the database.

The Object is converted to the given targetSqlType before it is sent to the database.

The JDBC driver uses the Calendar to create the Date using a particular timezone and locale. Default behaviour of the driver is to use the Java virtual machine default settings.
Parameters:
  parameterIndex - the parameter number index, where the first parameter hasindex 1
Parameters:
  cal - the Calendar to use to construct the Date the java.sql.Date with the parameter value. null if the value isSQL NULL.
throws:
  SQLException - if a database error happens

The JDBC driver uses the Calendar to create the Date using a particular timezone and locale. Default behaviour of the driver is to use the Java virtual machine default settings.
Parameters:
  parameterName - the parameter name
Parameters:
  cal - used for creating the returned Date the java.sql.Date with the parameter value. null if the value isSQL NULL.
throws:
  SQLException - if a database error happens

The object type returned is the JDBC type registered for the parameter with a registerOutParameter call. If a parameter was registered as a java.sql.Types.OTHER then it may hold abstract types that are particular to the connected database.
Parameters:
  parameterIndex - the parameter number index, where the first parameter hasindex 1 an Object holding the value of the parameter.
throws:
  SQLException - if there is a problem accessing the database

The object type returned is the JDBC type registered for the parameter with a registerOutParameter call. If a parameter was registered as a java.sql.Types.OTHER then it may hold abstract types that are particular to the connected database.
Parameters:
  parameterName - the parameter name the Java Object representation of the value of theparameter.
throws:
  SQLException - if there is a problem accessing the database

The string corresponding to a CHAR of fixed length will be of identical length to the value in the database inclusive of padding characters.
Parameters:
  parameterIndex - the parameter number index, where the first parameter hasindex 1 a String with the parameter value. null if the value is SQL NULL.
throws:
  SQLException - if there is a problem accessing the database

The string corresponding to a CHAR of fixed length will be of identical length to the value in the database inclusive of padding characters.
Parameters:
  parameterName - the parameter name a String with the parameter value. null if the value is SQL NULL.
throws:
  SQLException - if there is a problem accessing the database

The Type defined by this method fixes the Java type that must be retrieved using the getter methods of CallableStatement. If a database specific type is expected for a parameter, the Type java.sql.Types.OTHER should be used. Note that there is another variant of this method for User Defined Types or a REF type.
Parameters:
  parameterIndex - the parameter number index, where the first parameter hasindex 1
Parameters:
  sqlType - the JDBC type as defined by java.sql.Types. The JDBC typesNUMERIC and DECIMAL should be defined using the version ofregisterOutParameter that takes ascale parameter.
throws:
  SQLException - if a database error happens

The Type defined by this method fixes the Java type that must be retrieved using the getter methods of CallableStatement.
Parameters:
  parameterIndex - the parameter number index, where the first parameter hasindex 1
Parameters:
  sqlType - the JDBC type as defined by java.sql.Types.
Parameters:
  scale - the number of digits after the decimal point. Must be greaterthan or equal to 0.
throws:
  SQLException - if a database error happens

The Type defined by this method fixes the Java type that must be retrieved using the getter methods of CallableStatement. If a database specific type is expected for a parameter, the Type java.sql.Types.OTHER should be used. Note that there is another variant of this method for User Defined Types or a REF type.
Parameters:
  parameterName - the parameter name
Parameters:
  sqlType - a JDBC type expressed as a constant from Types. TypesNUMERIC and DECIMAL should be defined using the variant ofthis method that takes a scale parameter.
throws:
  SQLException - if a database error happens

The Type defined by this method fixes the Java type that must be retrieved using the getter methods of CallableStatement.
Parameters:
  parameterName - the parameter name
Parameters:
  sqlType - a JDBC type expressed as a constant from Types
Parameters:
  scale - the number of digits after the decimal point. Must be greaterthan or equal to 0.
throws:
  SQLException - if a database error happens

This is a good method for setting an SQL LONVARCHAR parameter where the length of the data is large. Data is read from the InputStream until end-of-file is reached or the specified number of bytes is copied.
Parameters:
  parameterName - the parameter name
Parameters:
  theInputStream - the ASCII InputStream carrying the data to update theparameter with
Parameters:
  length - the number of bytes in the InputStream to copy to theparameter
throws:
  SQLException - if a database error happens

Use this method when a large amount of data needs to be set into a LONGVARBINARY parameter.
Parameters:
  parameterName - the name of the parameter
Parameters:
  theInputStream - the binary InputStream carrying the data to update theparameter
Parameters:
  length - the number of bytes in the InputStream to copy to theparameter
throws:
  SQLException - if a database error happens

For reasons of portability, the caller is expected to supply both the SQL Type code and Type name (which is just the parameter name if the type is user defined, or the name of the type being referenced if a REF).
Parameters:
  parameterName - the parameter name
Parameters:
  sqlType - a JDBC type expressed as a constant from Types
Parameters:
  typeName - if the target parameter is a user defined type then thisshould contain the full type namethe fully qualified name of a UDT or REF type - ignored if the parameteris not a UDT.
throws:
  SQLException - if a database error happens

If the object's class implements the interface SQLData, the JDBC driver calls SQLData.writeSQL to write it to the SQL data stream. If theObject implements any of the following interfaces then it is the role of the driver to flow the value to the connected database using the appropriate SQL type :

• Ref
• Struct
• Array
• Clob
• Blob

The Object is converted to the given targetSqlType before it is sent to the database. If the object has a custom mapping (its class implements the interface SQLData), the JDBC driver will call the method SQLData.writeSQL to write it to the SQL data stream. If theObject implements any of the following interfaces then it is the role of the driver to flow the value to the connected database using the appropriate SQL type :

• Ref
• Struct
• Array
• Clob
• Blob

The Object is converted to the given targetSqlType before it is sent to the database. If the object has a custom mapping (its class implements the interface SQLData), the JDBC driver will call the method SQLData.writeSQL to write it to the SQL data stream. If theObject implements any of the following interfaces then it is the role of the driver to flow the value to the connected database using the appropriate SQL type :

• Ref
• Struct
• Array
• Clob
• Blob

The driver uses the supplied Calendar to create the SQL TIME value, which allows it to use a custom timezone - otherwise the driver uses the default timezone of the Java virtual machine.
Parameters:
  parameterName - the parameter name
Parameters:
  theTime - the new value with which to update the parameter
Parameters:
  cal - used for creating the new SQL TIME value
throws:
  SQLException - if a database error happens

The driver uses the supplied Calendar to create the SQL TIMESTAMP value, which allows it to use a custom timezone - otherwise the driver uses the default timezone of the Java virtual machine.
Parameters:
  parameterName - the parameter name
Parameters:
  theTimestamp - the new value with which to update the parameter
Parameters:
  cal - used for creating the new SQL TIME value
throws:
  SQLException - if a database error happens