Jakarta Persistence (JPA) Interface

jakarta.persistence.StoredProcedureQuery

Super Interfaces:: Query

Interface used to control stored procedure query execution.

Stored procedure query execution may be controlled in accordance with the following:

The setParameter methods are used to set the values of all required IN and INOUT parameters. It is not required to set the values of stored procedure parameters for which default values have been defined by the stored procedure.
When getResultList and getSingleResult are called on a StoredProcedureQuery object, the provider calls execute on an unexecuted stored procedure query before processing getResultList or getSingleResult.
When executeUpdate is called on a StoredProcedureQuery object, the provider will call execute on an unexecuted stored procedure query, followed by getUpdateCount. The results of executeUpdate will be those of getUpdateCount.
The execute method supports both the simple case where scalar results are passed back only via INOUT and OUT parameters as well as the most general case (multiple result sets and/or update counts, possibly also in combination with output parameter values).
The execute method returns true if the first result is a result set, and false if it is an update count or there are no results other than through INOUT and OUT parameters, if any.
If the execute method returns true, the pending result set can be obtained by calling getResultList or getSingleResult.
The hasMoreResults method can then be used to test for further results.
If execute or hasMoreResults returns false, the getUpdateCount method can be called to obtain the pending result if it is an update count. The getUpdateCount method will return either the update count (zero or greater) or -1 if there is no update count (i.e., either the next result is a result set or there is no next update count).
For portability, results that correspond to JDBC result sets and update counts need to be processed before the values of any INOUT or OUT parameters are extracted.
After results returned through getResultList and getUpdateCount have been exhausted, results returned through INOUT and OUT parameters can be retrieved.
The getOutputParameterValue methods are used to retrieve the values passed back from the procedure through INOUT and OUT parameters.
When using REF_CURSOR parameters for result sets the update counts should be exhausted before calling getResultList to retrieve the result set. Alternatively, the REF_CURSOR result set can be retrieved through getOutputParameterValue. Result set mappings are applied to results corresponding to REF_CURSOR parameters in the order the REF_CURSOR parameters were registered with the query.
In the simplest case, where results are returned only via INOUT and OUT parameters, execute can be followed immediately by calls to getOutputParameterValue.

See Also:: Query
Parameter

Since:: Jakarta Persistence (JPA) 2.1

Public Instance Methods

boolean execute()

Return true if the first result corresponds to a result set, and false if it is an update count or if there are no results other than through INOUT and OUT parameters, if any.

Returns:: true if first result corresponds to result set.

Throws:: PersistenceException - if the query execution exceeds the query timeout value set and the transaction is rolled back.; QueryTimeoutException - if the query execution exceeds the query timeout value set and only the statement is rolled back.

Since:: Jakarta Persistence (JPA) 1.0

int executeUpdate()

Return the update count of -1 if there is no pending result or if the first result is not an update count.

The provider will call execute on the query if needed.

Overrides Query.executeUpdate

Returns:: the update count or -1 if there is no pending result or if the next result is not an update count..

Throws:: PersistenceException - if the query execution exceeds the query timeout value set and the transaction is rolled back.; TransactionRequiredException - if there is no transaction or the persistence context has not been joined to the transaction.; QueryTimeoutException - if the statement execution exceeds the query timeout value set and only the statement is rolled back.

Since:: Jakarta Persistence (JPA) 1.0

The cache retrieval mode that will be in effect during query execution.

Inherited from Query

Since:: Jakarta Persistence (JPA) 3.2

The cache storage mode that will be in effect during query execution.

Inherited from Query

Since:: Jakarta Persistence (JPA) 3.2

int getFirstResult()

The position of the first result the query object was set to retrieve.

Returns 0 if setFirstResult was not applied to the query object.

Inherited from Query

Returns:: position of the first result.

Since:: Jakarta Persistence (JPA) 2.0

The Running JPA Queries article explains how to use getFirstResult.

Get the flush mode in effect for the query execution.

If a flush mode has not been set for the query object, returns the flush mode in effect for the entity manager.

Inherited from Query

Returns:: flush mode.

Since:: Jakarta Persistence (JPA) 2.0

Map<String,Object> getHints()

Get the properties and hints and associated values that are in effect for the query instance.

Inherited from Query

Returns:: query properties and hints.

Since:: Jakarta Persistence (JPA) 2.0

Get the current lock mode for the query.

Returns null if a lock mode has not been set on the query object.

Inherited from Query

Returns:: lock mode.

Throws:: IllegalStateException - if the query is found not to be a Jakarta Persistence query language SELECT query or a CriteriaQuery<T> query.

Since:: Jakarta Persistence (JPA) 2.0

int getMaxResults()

The maximum number of results the query object was set to retrieve.

Returns Integer.java.lang.Integer/MAX_VALUE if Query.setMaxResults was not applied to the query object.

Inherited from Query

Returns:: maximum number of results.

Since:: Jakarta Persistence (JPA) 2.0

Object getOutputParameterValue(int position)

Retrieve a value passed back from the procedure through an INOUT or OUT parameter.

For portability, all results corresponding to result sets and update counts must be retrieved before the values of output parameters.

Parameters:: position - parameter position

Returns:: the result that is passed back through the parameter.

Throws:: IllegalArgumentException - if the position does not correspond to a parameter of the query or is not an INOUT or OUT parameter.

Since:: Jakarta Persistence (JPA) 1.0

Object getOutputParameterValue(String parameterName)

Retrieve a value passed back from the procedure through an INOUT or OUT parameter.

For portability, all results corresponding to result sets and update counts must be retrieved before the values of output parameters.

Parameters:: parameterName - name of the parameter as registered or specified in metadata

Returns:: the result that is passed back through the parameter.

Throws:: IllegalArgumentException - if the parameter name does not correspond to a parameter of the query or is not an INOUT or OUT parameter.

Since:: Jakarta Persistence (JPA) 1.0

Get the parameter object corresponding to the declared parameter of the given name.

This method is not required to be supported for native queries.

Inherited from Query

Parameters:: name - parameter name

Returns:: parameter object.

Throws:: IllegalStateException - if invoked on a native query when the implementation does not support this use.; IllegalArgumentException - if the parameter of the specified name does not exist.

Since:: Jakarta Persistence (JPA) 2.0

Get the parameter object corresponding to the declared parameter of the given name and type.

This method is required to be supported for criteria queries only.

Inherited from Query

Parameters:: name - parameter name; type - type

Returns:: parameter object.

Throws:: IllegalStateException - if invoked on a native query or Jakarta Persistence query language query when the implementation does not support this use.; IllegalArgumentException - if the parameter of the specified name does not exist or is not assignable to the type.

Since:: Jakarta Persistence (JPA) 2.0

Get the parameter object corresponding to the declared positional parameter with the given position.

This method is not required to be supported for native queries.

Inherited from Query

Parameters:: position - position

Returns:: parameter object.

Throws:: IllegalStateException - if invoked on a native query when the implementation does not support this use.; IllegalArgumentException - if the parameter with the specified position does not exist.

Since:: Jakarta Persistence (JPA) 2.0

Get the parameter object corresponding to the declared positional parameter with the given position and type.

This method is not required to be supported by the provider.

Inherited from Query

Parameters:: position - position; type - type

Returns:: parameter object.

Throws:: IllegalStateException - if invoked on a native query or Jakarta Persistence query language query when the implementation does not support this use.; IllegalArgumentException - if the parameter with the specified position does not exist or is not assignable to the type.

Since:: Jakarta Persistence (JPA) 2.0

T getParameterValue(Parameter<T> param)

Return the input value bound to the parameter.

(Note that OUT parameters are unbound.)

Inherited from Query

Parameters:: param - parameter object

Returns:: parameter value.

Throws:: IllegalStateException - if the parameter has not been bound.; IllegalArgumentException - if the parameter is not a parameter of the query.

Since:: Jakarta Persistence (JPA) 2.0

Object getParameterValue(String name)

Return the input value bound to the named parameter.

(Note that OUT parameters are unbound.)

Inherited from Query

Parameters:: name - parameter name

Returns:: parameter value.

Throws:: IllegalStateException - if the parameter has not been bound.; IllegalArgumentException - if the parameter of the specified name does not exist.

Since:: Jakarta Persistence (JPA) 2.0

Object getParameterValue(int position)

Return the input value bound to the positional parameter.

(Note that OUT parameters are unbound.)

Inherited from Query

Parameters:: position - position

Returns:: parameter value.

Throws:: IllegalStateException - if the parameter has not been bound.; IllegalArgumentException - if the parameter with the specified position does not exist.

Since:: Jakarta Persistence (JPA) 2.0

Get the parameter objects corresponding to the declared parameters of the query.

Returns empty set if the query has no parameters. This method is not required to be supported for native queries.

Inherited from Query

Returns:: set of the parameter objects.

Throws:: IllegalStateException - if invoked on a native query when the implementation does not support this use.

Since:: Jakarta Persistence (JPA) 2.0

List<E> getResultList()

Retrieve the list of results from the next result set.

The provider will call execute on the query if needed. A REF_CURSOR result set, if any, is retrieved in the order the REF_CURSOR parameter was registered with the query.

Overrides Query.getResultList

Returns:: a list of the results or null is the next item is not a result set.

Throws:: PersistenceException - if the query execution exceeds the query timeout value set and the transaction is rolled back.; QueryTimeoutException - if the query execution exceeds the query timeout value set and only the statement is rolled back.

Since:: Jakarta Persistence (JPA) 1.0

Stream<T> getResultStream()

Execute a SELECT query and return the query results as an untyped Stream<T>.

By default, this method delegates to getResultList().stream(), however persistence provider may choose to override this method to provide additional capabilities.

Inherited from Query

Returns:: a stream of the results, or an empty stream if there are no results.

Throws:: IllegalStateException - if called for a Jakarta Persistence query language UPDATE or DELETE statement.; PessimisticLockException - if pessimistic locking fails and the transaction is rolled back.; LockTimeoutException - if pessimistic locking fails and only the statement is rolled back.; PersistenceException - if the query execution exceeds the query timeout value set and the transaction is rolled back.; TransactionRequiredException - if a lock mode other than NONE has been set and there is no transaction or the persistence context has not been joined to the transaction.; QueryTimeoutException - if the query execution exceeds the query timeout value set and only the statement is rolled back.

See Also:: Stream
::getResultList()

Since:: Jakarta Persistence (JPA) 2.2

Object getSingleResult()

Retrieve a single result from the next result set.

The provider will call execute on the query if needed. A REF_CURSOR result set, if any, is retrieved in the order the REF_CURSOR parameter was registered with the query.

Overrides Query.getSingleResult

Returns:: the result or null if the next item is not a result set.

Throws:: NoResultException - if there is no result in the next result set.; NonUniqueResultException - if more than one result.; PersistenceException - if the query execution exceeds the query timeout value set and the transaction is rolled back.; QueryTimeoutException - if the query execution exceeds the query timeout value set and only the statement is rolled back.

Since:: Jakarta Persistence (JPA) 1.0

Object getSingleResultOrNull()

Retrieve a single result from the next result set.

The provider will call execute on the query if needed. A REF_CURSOR result set, if any, is retrieved in the order the REF_CURSOR parameter was registered with the query.

Overrides Query.getSingleResultOrNull

Returns:: the result or null if the next item is not a result set or if there is no result in the next result set.

Throws:: NonUniqueResultException - if more than one result.; PersistenceException - if the query execution exceeds the query timeout value set and the transaction is rolled back.; QueryTimeoutException - if the query execution exceeds the query timeout value set and only the statement is rolled back.

Since:: Jakarta Persistence (JPA) 1.0

Integer getTimeout()

The query timeout.

Inherited from Query

Since:: Jakarta Persistence (JPA) 3.2

int getUpdateCount()

Return the update count or -1 if there is no pending result or if the next result is not an update count.

Returns:: update count or -1 if there is no pending result or if the next result is not an update count.

Throws:: PersistenceException - if the query execution exceeds the query timeout value set and the transaction is rolled back.; QueryTimeoutException - if the query execution exceeds the query timeout value set and only the statement is rolled back.

Since:: Jakarta Persistence (JPA) 1.0

boolean hasMoreResults()

Return true if the next result corresponds to a result set, and false if it is an update count or if there are no results other than through INOUT and OUT parameters, if any.

Returns:: true if next result corresponds to result set.

Throws:: PersistenceException - if the query execution exceeds the query timeout value set and the transaction is rolled back.; QueryTimeoutException - if the query execution exceeds the query timeout value set and only the statement is rolled back.

Since:: Jakarta Persistence (JPA) 1.0

boolean isBound(Parameter<?> param)

Return a boolean indicating whether a value has been bound to the parameter.

Inherited from Query

Parameters:: param - parameter object

Returns:: boolean indicating whether parameter has been bound.

Since:: Jakarta Persistence (JPA) 2.0

All parameters must be registered.

Parameters:: mode - parameter mode; position - parameter position; type - type of the parameter

Returns:: the same query instance.

Since:: Jakarta Persistence (JPA) 1.0

Parameters:: mode - parameter mode; parameterName - name of the parameter as registered or specified in metadata; type - type of the parameter

Returns:: the same query instance.

Since:: Jakarta Persistence (JPA) 1.0

Set the cache retrieval mode that is in effect during query execution.

This cache retrieval mode overrides the cache retrieve mode in use by the entity manager.

Overrides Query.setCacheRetrieveMode

Parameters:: cacheRetrieveMode - cache retrieval mode

Returns:: the same query instance.

Since:: Jakarta Persistence (JPA) 3.2

Set the cache storage mode that is in effect during query execution.

This cache storage mode overrides the cache storage mode in use by the entity manager.

Overrides Query.setCacheStoreMode

Parameters:: cacheStoreMode - cache storage mode

Returns:: the same query instance.

Since:: Jakarta Persistence (JPA) 3.2

Set the position of the first result to retrieve.

Inherited from Query

Parameters:: startPosition - position of the first result, numbered from 0

Returns:: the same query instance.

Throws:: IllegalArgumentException - if the argument is negative.

Since:: Jakarta Persistence (JPA) 1.0

Set the flush mode type to be used for the query execution.

The flush mode type applies to the query regardless of the flush mode type in use for the entity manager.

Overrides Query.setFlushMode

Parameters:: flushMode - flush mode

Returns:: the same query instance.

Since:: Jakarta Persistence (JPA) 1.0

Set a query property or hint.

The hints elements may be used to specify query properties and hints. Properties defined by this specification must be observed by the provider. Vendor-specific hints that are not recognized by a provider must be silently ignored. Portable applications should not rely on the standard timeout hint. Depending on the database in use, this hint may or may not be observed.

Overrides Query.setHint

Parameters:: value - value for the property or hint; hintName - name of the property or hint

Returns:: the same query instance.

Throws:: IllegalArgumentException - if the second argument is not valid for the implementation.

Since:: Jakarta Persistence (JPA) 1.0

Set the lock mode type to be used for the query execution.

Inherited from Query

Parameters:: lockMode - lock mode

Returns:: the same query instance.

Throws:: IllegalStateException - if the query is found not to be a Jakarta Persistence query language SELECT query or a CriteriaQuery<T> query.

Since:: Jakarta Persistence (JPA) 2.0

Set the maximum number of results to retrieve.

Inherited from Query

Parameters:: maxResult - maximum number of results to retrieve

Returns:: the same query instance.

Throws:: IllegalArgumentException - if the argument is negative.

Since:: Jakarta Persistence (JPA) 1.0

Bind the value of a Parameter object.

Overrides Query.setParameter

Parameters:: param - parameter object; value - parameter value

Returns:: the same query instance.

Throws:: IllegalArgumentException - if the parameter does not correspond to a parameter of the query.

Since:: Jakarta Persistence (JPA) 1.0

Bind an instance of Calendar to a Parameter<T> object.

Overrides Query.setParameter

Parameters:: temporalType - temporal type; param - parameter object; value - parameter value

Returns:: the same query instance.

Throws:: IllegalArgumentException - if the parameter does not correspond to a parameter of the query.

Deprecated:: Newly-written code should use the date/time types defined in java.time.

Since:: Jakarta Persistence (JPA) 1.0

Bind an instance of Date to a Parameter<T> object.

Overrides Query.setParameter

Parameters:: temporalType - temporal type; param - parameter object; value - parameter value

Returns:: the same query instance.

Throws:: IllegalArgumentException - if the parameter does not correspond to a parameter of the query.

Deprecated:: Newly-written code should use the date/time types defined in java.time.

Since:: Jakarta Persistence (JPA) 1.0

Bind an argument value to a named parameter.

Overrides Query.setParameter

Parameters:: name - parameter name; value - parameter value

Returns:: the same query instance.

Throws:: IllegalArgumentException - if the parameter name does not correspond to a parameter of the query or if the argument is of incorrect type.

Since:: Jakarta Persistence (JPA) 1.0

Bind an instance of java.util.Calendar to a named parameter.

Overrides Query.setParameter

Parameters:: name - parameter name; temporalType - temporal type; value - parameter value

Returns:: the same query instance.

Throws:: IllegalArgumentException - if the parameter name does not correspond to a parameter of the query or if the value argument is of incorrect type.

Deprecated:: Newly-written code should use the date/time types defined in java.time.

Since:: Jakarta Persistence (JPA) 1.0

Bind an instance of java.util.Date to a named parameter.

Overrides Query.setParameter

Parameters:: name - parameter name; temporalType - temporal type; value - parameter value

Returns:: the same query instance.

Throws:: IllegalArgumentException - if the parameter name does not correspond to a parameter of the query or if the value argument is of incorrect type.

Deprecated:: Newly-written code should use the date/time types defined in java.time.

Since:: Jakarta Persistence (JPA) 1.0

Bind an argument value to a positional parameter.

Overrides Query.setParameter

Parameters:: position - position; value - parameter value

Returns:: the same query instance.

Throws:: IllegalArgumentException - if position does not correspond to a positional parameter of the query or if the argument is of incorrect type.

Since:: Jakarta Persistence (JPA) 1.0

Bind an instance of java.util.Calendar to a positional parameter.

Overrides Query.setParameter

Parameters:: position - position; temporalType - temporal type; value - parameter value

Returns:: the same query instance.

Throws:: IllegalArgumentException - if position does not correspond to a positional parameter of the query or if the value argument is of incorrect type.

Deprecated:: Newly-written code should use the date/time types defined in java.time.

Since:: Jakarta Persistence (JPA) 1.0

Bind an instance of java.util.Date to a positional parameter.

Overrides Query.setParameter

Parameters:: position - position; temporalType - temporal type; value - parameter value

Returns:: the same query instance.

Throws:: IllegalArgumentException - if position does not correspond to a positional parameter of the query or if the value argument is of incorrect type.

Deprecated:: Newly-written code should use the date/time types defined in java.time.

Since:: Jakarta Persistence (JPA) 1.0

Set the query timeout, in milliseconds.

This is a hint, and is an alternative to setting the hint jakarta.persistence.query.timeout.

Overrides Query.setTimeout

Parameters:: timeout - the timeout, in milliseconds, or null to indicate no timeout

Returns:: the same query instance.

Since:: Jakarta Persistence (JPA) 3.2

T unwrap(Class<T> cls)

Return an object of the specified type to allow access to a provider-specific API.

If the provider implementation of Query does not support the given type, the PersistenceException is thrown.

Inherited from Query

Parameters:: cls - the type of the object to be returned. This is usually either the underlying class implementing Query or an interface it implements.

Returns:: an instance of the specified class.

Throws:: PersistenceException - if the provider does not support the given type.

Since:: Jakarta Persistence (JPA) 2.0