javax.persistence

Annotation Type NamedStoredProcedureQuery

Contents

  • @Target(value=TYPE)
 @Retention(value=RUNTIME)
public @interface NamedStoredProcedureQuery
    Specifies and names a stored procedure, its parameters, and its result type.

    The NamedStoredProcedureQuery annotation can be applied to an entity or mapped superclass.

    The name element is the name that is passed as an argument to the EntityManager.createNamedStoredProcedureQuery(java.lang.String) method to create an executable StoredProcedureQuery object. Names are scoped to the persistence unit.

    The procedureName element is the name of the stored procedure in the database.

    The parameters of the stored procedure are specified by the parameters element. All parameters must be specified in the order in which they occur in the parameter list of the stored procedure.

    The resultClasses element refers to the class (or classes) that are used to map the results. The resultSetMappings element names one or more result set mappings, as defined by the SqlResultSetMapping annotation.

    If there are multiple result sets, it is assumed that they will be mapped using the same mechanism — e.g., either all via a set of result class mappings or all via a set of result set mappings. The order of the specification of these mappings must be the same as the order in which the result sets will be returned by the stored procedure invocation. If the stored procedure returns one or more result sets and no resultClasses or resultSetMappings element is specified, any result set will be returned as a list of type Object[]. The combining of different strategies for the mapping of stored procedure result sets is undefined.

    The hints element 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 ignored.

    All parameters of a named stored procedure query must be specified using the StoredProcedureParameter annotation.

    Since:
    Java Persistence 2.1
    See Also:
    StoredProcedureQuery, StoredProcedureParameter

    • Element Detail

      • name

        public abstract String name
        The name used to refer to the query with the EntityManager methods that create stored procedure query objects.

      • procedureName

        public abstract String procedureName
        The name of the stored procedure in the database.

      • parameters

        public abstract StoredProcedureParameter[] parameters
        Information about all parameters of the stored procedure. All parameters must be specified in the order in which they occur in the parameter list of the stored procedure.
        Default:
        {}

      • resultClasses

        public abstract Class[] resultClasses
        The class or classes that are used to map the results.
        Default:
        {}

      • resultSetMappings

        public abstract String[] resultSetMappings
        The names of one or more result set mappings, as defined in metadata.
        Default:
        {}

      • hints

        public abstract QueryHint[] hints
        Query properties and hints. (May include vendor-specific query hints.)
        Default:
        {}

Document created the 11/06/2005, last modified the 18/08/2025
Source of the printed document:https://www.gaudry.be/en/java-api-javaee-rf-javax/persistence/NamedStoredProcedureQuery.html

The infobrol is a personal site whose content is my sole responsibility. The text is available under CreativeCommons license (BY-NC-SA). More info on the terms of use and the author.

References

  1. View the html document Language of the document:fr Manuel PHP : https://docs.oracle.com, NamedStoredProcedureQuery (Java(TM) EE 7 Specification APIs)

These references and links indicate documents consulted during the writing of this page, or which may provide additional information, but the authors of these sources can not be held responsible for the content of this page.
The author of this site is solely responsible for the way in which the various concepts, and the freedoms that are taken with the reference works, are presented here. Remember that you must cross multiple source information to reduce the risk of errors.