Module persistence.api
Package javax.persistence

Annotation Type NamedNativeQuery

@Target(TYPE) @Retention(RUNTIME) @Repeatable(NamedNativeQueries.class) public @interface NamedNativeQuery
Specifies a named native SQL query. Query names are scoped to the persistence unit. The NamedNativeQuery annotation can be applied to an entity or mapped superclass.
Since:
Java Persistence 1.0

  • Required Element Summary

    Required Elements
    Modifier and Type
    Required Element
    Description
    String
    name
    The name used to refer to the query with the EntityManager methods that create query objects.
    String
    query
    The SQL query string.

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    QueryHint[]
    hints
    Query properties and hints.
    Class
    resultClass
    The class of the result.
    String
    resultSetMapping
    The name of a SqlResultSetMapping, as defined in metadata.

  • Element Details

    • name

      String name
      The name used to refer to the query with the EntityManager methods that create query objects.
      Returns:
      The name

    • query

      String query
      The SQL query string.
      Returns:
      The SQL string

    • hints

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

    • resultClass

      Class resultClass
      The class of the result.
      Returns:
      The result class
      Default:
      void.class

    • resultSetMapping

      String resultSetMapping
      The name of a SqlResultSetMapping, as defined in metadata.
      Returns:
      ResultSet mapping
      Default:
      ""