Package org.hibernate.jpa

Class QueryHints

  • public class QueryHints
extends java.lang.Object
    Defines the supported JPA query hints

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String HINT_CACHE_MODE
      The hint key for specifying the cache mode (CacheMode) to be in effect for the execution of the hinted query.
      static java.lang.String HINT_CACHE_REGION
      The hint key for specifying the name of the cache region (within Hibernate's query result cache region) to use for storing the query results.
      static java.lang.String HINT_CACHEABLE
      The hint key for specifying whether the query results should be cached for the next (cached) execution of the "same query".
      static java.lang.String HINT_COMMENT
      The hint key for specifying a comment which is to be embedded into the SQL sent to the database.
      static java.lang.String HINT_FETCH_SIZE
      The hint key for specifying a JDBC fetch size, used when executing the resulting SQL.
      static java.lang.String HINT_FETCHGRAPH
      Hint providing a "fetchgraph" EntityGraph.
      static java.lang.String HINT_FLUSH_MODE
      The hint key for specifying the flush mode (FlushMode) to be in effect for the execution of the hinted query.
      static java.lang.String HINT_FOLLOW_ON_LOCKING  
      static java.lang.String HINT_LOADGRAPH
      Hint providing a "loadgraph" EntityGraph.
      static java.lang.String HINT_NATIVE_LOCKMODE  
      static java.lang.String HINT_NATIVE_SPACES  
      static java.lang.String HINT_PASS_DISTINCT_THROUGH  
      static java.lang.String HINT_READONLY
      The hint key for specifying that objects loaded into the persistence context as a result of this query execution should be associated with the persistence context as read-only.
      static java.lang.String HINT_TIMEOUT
      Deprecated.
      use SPEC_HINT_TIMEOUT instead
      static java.lang.String JAKARTA_HINT_FETCHGRAPH
      Hint providing a "fetchgraph" EntityGraph.
      static java.lang.String JAKARTA_HINT_LOADGRAPH
      Hint providing a "loadgraph" EntityGraph.
      static java.lang.String JAKARTA_SPEC_HINT_TIMEOUT
      The hint key for specifying a query timeout per JPA, which defines the timeout in milliseconds
      static java.lang.String SPEC_HINT_TIMEOUT
      The hint key for specifying a query timeout per JPA, which defines the timeout in milliseconds

    • Constructor Summary

      Constructors 
      Modifier Constructor Description
      protected QueryHints()  

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static java.util.Set<java.lang.String> getDefinedHints()  

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Field Detail

      • HINT_TIMEOUT

        @Deprecated
public static final java.lang.String HINT_TIMEOUT
        Deprecated.
        use SPEC_HINT_TIMEOUT instead
        The hint key for specifying a query timeout per Hibernate O/RM, which defines the timeout in seconds.
        See Also:
        Constant Field Values

      • SPEC_HINT_TIMEOUT

        public static final java.lang.String SPEC_HINT_TIMEOUT
        The hint key for specifying a query timeout per JPA, which defines the timeout in milliseconds
        See Also:
        Constant Field Values

      • JAKARTA_SPEC_HINT_TIMEOUT

        public static final java.lang.String JAKARTA_SPEC_HINT_TIMEOUT
        The hint key for specifying a query timeout per JPA, which defines the timeout in milliseconds
        See Also:
        Constant Field Values

      • HINT_COMMENT

        public static final java.lang.String HINT_COMMENT
        The hint key for specifying a comment which is to be embedded into the SQL sent to the database.
        See Also:
        Constant Field Values

      • HINT_FETCH_SIZE

        public static final java.lang.String HINT_FETCH_SIZE
        The hint key for specifying a JDBC fetch size, used when executing the resulting SQL.
        See Also:
        Constant Field Values

      • HINT_CACHEABLE

        public static final java.lang.String HINT_CACHEABLE
        The hint key for specifying whether the query results should be cached for the next (cached) execution of the "same query".
        See Also:
        Constant Field Values

      • HINT_CACHE_REGION

        public static final java.lang.String HINT_CACHE_REGION
        The hint key for specifying the name of the cache region (within Hibernate's query result cache region) to use for storing the query results.
        See Also:
        Constant Field Values

      • HINT_READONLY

        public static final java.lang.String HINT_READONLY
        The hint key for specifying that objects loaded into the persistence context as a result of this query execution should be associated with the persistence context as read-only.
        See Also:
        Constant Field Values

      • HINT_CACHE_MODE

        public static final java.lang.String HINT_CACHE_MODE
        The hint key for specifying the cache mode (CacheMode) to be in effect for the execution of the hinted query.
        See Also:
        Constant Field Values

      • HINT_FLUSH_MODE

        public static final java.lang.String HINT_FLUSH_MODE
        The hint key for specifying the flush mode (FlushMode) to be in effect for the execution of the hinted query.
        See Also:
        Constant Field Values

      • HINT_NATIVE_LOCKMODE

        public static final java.lang.String HINT_NATIVE_LOCKMODE
        See Also:
        Constant Field Values

      • HINT_FETCHGRAPH

        public static final java.lang.String HINT_FETCHGRAPH
        Hint providing a "fetchgraph" EntityGraph. Attributes explicitly specified as AttributeNodes are treated as FetchType.EAGER (via join fetch or subsequent select). Note: Currently, attributes that are not specified are treated as FetchType.LAZY or FetchType.EAGER depending on the attribute's definition in metadata, rather than forcing FetchType.LAZY.

      • HINT_LOADGRAPH

        public static final java.lang.String HINT_LOADGRAPH
        Hint providing a "loadgraph" EntityGraph. Attributes explicitly specified as AttributeNodes are treated as FetchType.EAGER (via join fetch or subsequent select). Attributes that are not specified are treated as FetchType.LAZY or FetchType.EAGER depending on the attribute's definition in metadata

      • JAKARTA_HINT_FETCHGRAPH

        public static final java.lang.String JAKARTA_HINT_FETCHGRAPH
        Hint providing a "fetchgraph" EntityGraph. Attributes explicitly specified as AttributeNodes are treated as FetchType.EAGER (via join fetch or subsequent select). Note: Currently, attributes that are not specified are treated as FetchType.LAZY or FetchType.EAGER depending on the attribute's definition in metadata, rather than forcing FetchType.LAZY.

      • JAKARTA_HINT_LOADGRAPH

        public static final java.lang.String JAKARTA_HINT_LOADGRAPH
        Hint providing a "loadgraph" EntityGraph. Attributes explicitly specified as AttributeNodes are treated as FetchType.EAGER (via join fetch or subsequent select). Attributes that are not specified are treated as FetchType.LAZY or FetchType.EAGER depending on the attribute's definition in metadata

      • HINT_FOLLOW_ON_LOCKING

        public static final java.lang.String HINT_FOLLOW_ON_LOCKING
        See Also:
        Constant Field Values

      • HINT_PASS_DISTINCT_THROUGH

        public static final java.lang.String HINT_PASS_DISTINCT_THROUGH
        See Also:
        Constant Field Values

      • HINT_NATIVE_SPACES

        public static final java.lang.String HINT_NATIVE_SPACES
        See Also:
        Constant Field Values

    • Constructor Detail

      • QueryHints

        protected QueryHints()

    • Method Detail

      • getDefinedHints

        public static java.util.Set<java.lang.String> getDefinedHints()