javax.persistence

Annotation Type NamedQuery

Contents

  • @Target(value=TYPE)
 @Retention(value=RUNTIME)
public @interface NamedQuery
    Specifies a static, named query in the Java Persistence query language. Query names are scoped to the persistence unit. The NamedQuery annotation can be applied to an entity or mapped superclass.

    The following is an example of the definition of a named query in the Java Persistence query language: 

        @NamedQuery(
            name="findAllCustomersWithName",
            query="SELECT c FROM Customer c WHERE c.name LIKE :custName"
    )

    The following is an example of the use of a named query: 

        @PersistenceContext
    public EntityManager em;
    ...
    customers = em.createNamedQuery("findAllCustomersWithName")
            .setParameter("custName", "Smith")
            .getResultList();
    Since:
    Java Persistence 1.0

    • Element Detail

      • name

        public abstract String name
        (Required) The name used to refer to the query with the EntityManager methods that create query objects.

      • query

        public abstract String query
        (Required) The query string in the Java Persistence query language.

      • lockMode

        public abstract LockModeType lockMode
        (Optional) The lock mode type to use in query execution. If a lockMode other than LockModeType.NONE is specified, the query must be executed in a transaction and the persistence context joined to the transaction.
        Since:
        Java Persistence 2.0
        Default:
        javax.persistence.LockModeType.NONE

      • hints

        public abstract QueryHint[] hints
        (Optional) 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/NamedQuery.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, NamedQuery (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.