Required Element Summary

Optional Element Summary

Element Details

• name

  String name

  The name of this query. Must be unique within a persistence unit.

  See Also:

  • SessionFactory.addNamedQuery(java.lang.String, jakarta.persistence.TypedQuery<R>)
  • Session.createNamedQuery(java.lang.String, java.lang.Class<R>)

• query

  String query

  The text of the SQL query.

• resultClass

  Class<?> resultClass

  The resultingClass.

  Should not be used in conjunction withresultSetMapping()

  Default:

  void.class

• resultSetMapping

  String resultSetMapping

  The name of aSqlResultSetMapping.

  Should not be used in conjunction withresultClass().

  Default:

  ""

• flush

  QueryFlushMode flush

  Determines whether the session should be flushed before executing the query.

  Since:

  7.0

  See Also:

  • CommonQueryContract.setQueryFlushMode(QueryFlushMode)

  Default:

  DEFAULT

• flushMode

  @Deprecated(since="7",forRemoval=true)FlushModeType flushMode

  Deprecated, for removal: This API element is subject to removal in a future version.

  useflush()

  The flush mode for the query.

  See Also:

  • CommonQueryContract.setFlushMode(jakarta.persistence.FlushModeType)
  • HibernateHints.HINT_FLUSH_MODE

  Default:

  PERSISTENCE_CONTEXT

• cacheable

  boolean cacheable

  Whether the query results are cacheable. Default isfalse, that is, not cacheable.

  See Also:

  • SelectionQuery.setCacheable(boolean)
  • HibernateHints.HINT_CACHEABLE

  Default:

  false

• cacheRegion

  String cacheRegion

  If the query results are cacheable, the name of the query cache region.

  See Also:

  • SelectionQuery.setCacheRegion(String)
  • HibernateHints.HINT_CACHE_REGION

  Default:

  ""

• fetchSize

  int fetchSize

  The number of rows fetched by the JDBC driver per trip.

  See Also:

  • SelectionQuery.setFetchSize(int)
  • HibernateHints.HINT_FETCH_SIZE

  Default:

  -1

• timeout

  int timeout

  The query timeout in seconds. Default is no timeout.

  See Also:

  • CommonQueryContract.setTimeout(int)
  • HibernateHints.HINT_TIMEOUT
  • SpecHints.HINT_SPEC_QUERY_TIMEOUT

  Default:

  -1

• comment

  String comment

  A comment added to the SQL query. Useful when engaging with DBA.

  See Also:

  • CommonQueryContract.setComment(String)
  • HibernateHints.HINT_COMMENT

  Default:

  ""

• cacheStoreMode

  CacheStoreMode cacheStoreMode

  The cache storage mode for objects returned by this query.

  See Also:

  • Query.setCacheMode(CacheMode)
  • SpecHints.HINT_SPEC_CACHE_STORE_MODE

  Default:

  USE

• cacheRetrieveMode

  CacheRetrieveMode cacheRetrieveMode

  The cache retrieval mode for objects returned by this query.

  See Also:

  • Query.setCacheMode(CacheMode)
  • SpecHints.HINT_SPEC_CACHE_RETRIEVE_MODE

  Default:

  USE

• cacheMode

  CacheMode cacheMode

  The cache interaction mode for this query.

  See Also:

  • SelectionQuery.setCacheMode(CacheMode)
  • HibernateHints.HINT_CACHE_MODE

  Default:

  NORMAL

• readOnly

  boolean readOnly

  Whether the results should be loaded in read-only mode. Default isfalse.

  See Also:

  • SelectionQuery.setReadOnly(boolean)
  • HibernateHints.HINT_READ_ONLY

  Default:

  false

• querySpaces

  String[] querySpaces

  Thequery spaces involved in this query.

  Typically, the names of tables which are referenced by the query.

  See Also:

  • SynchronizeableQuery.addSynchronizedQuerySpace(java.lang.String)
  • HibernateHints.HINT_NATIVE_SPACES
  • Synchronize

  Default:

  {}