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:
- First a reference to
ProcedureCall
is obtained via one of the overloadedSharedSessionContract.createStoredProcedureCall(java.lang.String)
methods. - 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. - 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 whileOutputs.goToNext()
} returnstrue
and callingOutputs.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 ); } }
- Finally, output parameters can be accessed using the overloaded
ProcedureOutputs.getOutputParameterValue(org.hibernate.query.procedure.ProcedureParameter<T>)
methods. For portability amongst databases, it is advised to access the output parameters after all returns have been processed.
-
ClassDescriptionDescribes the function return for ProcedureCalls that represent calls to a function (
"{? = call ...}
syntax) rather that a proc ({call ...}
syntax)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.Thrown to indicate a misuse of a parameterIndicates Hibernate is unable to determine the type details for a parameter.Defines support for executing database stored procedures and functions.Specialization of theOutputs
contract providing access to the stored procedure's registered output parameters.