-
@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 theEntityManager.createNamedStoredProcedureQuery(java.lang.String)
method to create an executableStoredProcedureQuery
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. TheresultSetMappings
element names one or more result set mappings, as defined by theSqlResultSetMapping
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
orresultSetMappings
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
-
-
Required Element Summary
Required Elements Modifier and Type Required Element and Description String
name
The name used to refer to the query with theEntityManager
methods that create stored procedure query objects.String
procedureName
The name of the stored procedure in the database.
-
Optional Element Summary
Optional Elements Modifier and Type Optional Element and Description QueryHint[]
hints
Query properties and hints.StoredProcedureParameter[]
parameters
Information about all parameters of the stored procedure.Class[]
resultClasses
The class or classes that are used to map the results.String[]
resultSetMappings
The names of one or more result set mappings, as defined in metadata.
-
-
-
Element Detail
-
name
public abstract String name
The name used to refer to the query with theEntityManager
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:
- {}
-
-
Nederlandse vertaling
U hebt gevraagd om deze site in het Nederlands te bezoeken. Voor nu wordt alleen de interface vertaald, maar nog niet alle inhoud.Als je me wilt helpen met vertalingen, is je bijdrage welkom. Het enige dat u hoeft te doen, is u op de site registreren en mij een bericht sturen waarin u wordt gevraagd om u toe te voegen aan de groep vertalers, zodat u de gewenste pagina's kunt vertalen. Een link onderaan elke vertaalde pagina geeft aan dat u de vertaler bent en heeft een link naar uw profiel.
Bij voorbaat dank.
Document heeft de 11/06/2005 gemaakt, de laatste keer de 18/08/2025 gewijzigd
Bron van het afgedrukte document:https://www.gaudry.be/nl/java-api-javaee-rf-javax/persistence/NamedStoredProcedureQuery.html
De infobrol is een persoonlijke site waarvan de inhoud uitsluitend mijn verantwoordelijkheid is. De tekst is beschikbaar onder CreativeCommons-licentie (BY-NC-SA). Meer info op de gebruiksvoorwaarden en de auteur.
Referenties
Deze verwijzingen en links verwijzen naar documenten die geraadpleegd zijn tijdens het schrijven van deze pagina, of die aanvullende informatie kunnen geven, maar de auteurs van deze bronnen kunnen niet verantwoordelijk worden gehouden voor de inhoud van deze pagina.
De auteur van deze site is als enige verantwoordelijk voor de manier waarop de verschillende concepten, en de vrijheden die met de referentiewerken worden genomen, hier worden gepresenteerd. Vergeet niet dat u meerdere broninformatie moet doorgeven om het risico op fouten te verkleinen.