Jakarta Persistence (JPA) Annotation Type

jakarta.persistence.NamedNativeQuery

Implemented Interfaces:
Annotation
Target:
Type
Declares a named native SQL query and, optionally, the mapping of the result of the native SQL query. Query names are scoped to the persistence unit. A named query may be executed by calling EntityManager.createNamedQuery.

In simple cases, a resultClass specifies how the native SQL query result set should be interpreted, for example: 

 @NamedNativeQuery(
         name = "findWidgets",
         query = "SELECT o.id, o.quantity, o.item " +
                 "FROM Order o, Item i " +
                 "WHERE (o.item = i.id) AND (i.name = 'widget')",
         resultClass = com.acme.Order.class
 )

In more complicated cases, a result set mapping is needed, which may be specified using either a separate annotation: 

 @NamedNativeQuery(
         name = "OrderItems",
         query = "SELECT o.id, o.quantity, o.item, i.id, i.name, i.description " +
                 "FROM Order o, Item i " +
                 "WHERE (o.quantity > 25) AND (o.item = i.id)",
         resultSetMapping = "OrderItemResults"
 )
 @SqlResultSetMapping(name="OrderItemResults", entities={
     @EntityResult(entityClass=com.acme.Order.class),
     @EntityResult(entityClass=com.acme.Item.class)
 })
or using the elements of this annotation: 
 @NamedNativeQuery(
         name = "OrderItems",
         query = "SELECT o.id, o.quantity, o.item, i.id, i.name, i.description " +
                 "FROM Order o, Item i " +
                 "WHERE (o.quantity > 25) AND (o.item = i.id)",
         resultSetMapping = "OrderItemResults");
         entities={
                 @EntityResult(entityClass=com.acme.Order.class),
                 @EntityResult(entityClass=com.acme.Item.class)
         }
 )

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

See Also:
Since:
Jakarta Persistence (JPA) 1.0

Annotation Elements

String name
The name used to identify the query in calls to EntityManager.createNamedQuery.
Since:
Jakarta Persistence (JPA) 1.0
String query
The native SQL query string.
Since:
Jakarta Persistence (JPA) 1.0
QueryHint[] hints
Query properties and hints.
(May include vendor-specific query hints.)
Default:
{}
Since:
Jakarta Persistence (JPA) 1.0
Class<?> resultClass
The class of each query result.
If a result set mapping is specified, the specified result class must agree with the type inferred from the result set mapping. If a resultClass is not explicitly specified, then it is inferred from the result set mapping, if any, or defaults to Object or Object[]. The query result class may be overridden by explicitly passing a class object to EntityManager.createNamedQuery.
Default:
void/class
Since:
Jakarta Persistence (JPA) 1.0
String resultSetMapping
The name of a SqlResultSetMapping, as defined in metadata.
The named result set mapping is used to interpret the result set of the native SQL query.

Alternatively, the elements entities, classes, and columns may be used to specify a result set mapping. These elements may not be used in conjunction with resultSetMapping.

Default:
""
Since:
Jakarta Persistence (JPA) 1.0
EntityResult[] entities
Specifies the result set mapping to entities.
May not be used in combination with resultSetMapping.
Default:
{}
Since:
Jakarta Persistence (JPA) 3.2
ConstructorResult[] classes
Specifies the result set mapping to constructors.
May not be used in combination with resultSetMapping.
Default:
{}
Since:
Jakarta Persistence (JPA) 3.2
ColumnResult[] columns
Specifies the result set mapping to scalar values.
May not be used in combination with resultSetMapping.
Default:
{}
Since:
Jakarta Persistence (JPA) 3.2

Additional JDK methods inherited from java.lang.annotation.Annotation

annotationType(), equals(Object), hashCode(), toString()