Package org.hibernate.procedure

package org.hibernate.procedure

Defines support for executing database stored procedures and functions and accessing their outputs.

This API is used as follows:

1. First a reference to ProcedureCall is obtained via one of the overloaded SharedSessionContract.createStoredProcedureCall(String) methods.
2. The ProcedureCall reference is then used to "configure" the procedure call (set timeouts and such) and to perform parameter registration. All procedure parameters that the application wants to use must be registered. For each IN or INOUT parameter, a value may then be bound.
3. At this point we are ready to execute the procedure call and start accessing the outputs. This is done by first calling the ProcedureCall.getOutputs()} method. The underlying JDBC call is executed as needed. The pattern to access the returns is iteration over the outputs while ProcedureOutputs.goToNext()} returns true and calling ProcedureOutputs.getCurrent()} during iteration:

       ProcedureCall call = session.createStoredProcedureCall( "some_procedure" );
       ...
       ProcedureOutputs outputs = call.getOutputs();
       while ( outputs.goToNext() ) {
           final Output output = outputs.getCurrent();
           if ( output.isResultSet() ) {
               handleResultSetOutput( (ResultSetOutput) output );
           }
           else {
               handleUpdateCountOutput( (UpdateCountOutput) output );
           }
       }
       

4. Finally, output parameters can be accessed using the overloaded ProcedureOutputs.getOutputParameterValue(ProcedureParameter) methods. For portability amongst databases, it is advised to access the output parameters after all returns have been processed.

See Also:

• SharedSessionContract.createStoredProcedureCall(String)
• SharedSessionContract.createStoredProcedureCall(String, Class[])
• SharedSessionContract.createStoredProcedureCall(String, String...)

Related Packages

Package	Description
org.hibernate	This package defines the central Hibernate APIs, beginning with SessionFactory, which represents an instance of Hibernate at runtime and is the source of new instances of Session and StatelessSession, the most important APIs exposing persistence-related operations for entities.
org.hibernate.procedure.spi	Defines an SPI for calling stored procedures and functions.

Class	Description
FunctionReturn<T>	Describes the function return value of a ProcedureCall executed via a JDBC escape of form ("{? = call ...}.
IllegalOutputTypeException	Indicates either -
NamedParametersNotSupportedException	Thrown to indicate that an attempt was made to register a stored procedure named parameter, but the underlying database reports to not support named parameters.
NoMoreOutputsException	Indicates that all outputs have been processed.
NoSuchParameterException
Output	Common contract for individual outputs which can be either results or update counts.
ParameterMisuseException	Thrown to indicate a misuse of a parameter
ParameterStrategyException
ParameterTypeException	Indicates Hibernate is unable to determine the type details for a parameter.
ProcedureCall	Defines support for executing database stored procedures and functions using the JDBC stored procedure SQL escape syntax.
ProcedureOutputs	Represents the outputs of executing a JDBC statement.
ProcedureParameter<T>
ResultSetOutput<T>	Models a ResultSet as an Output.
UpdateCountOutput	Models a return that is an update count (count of rows affected)