Top Description Methods
org.hibernate.annotations

public @Interface NamedNativeQuery

extends Annotation
Annotations
@Target:TYPE, PACKAGE
@Retention:RUNTIME
@Repeatable:NamedNativeQueries
Imports
java.lang.annotation.Repeatable, .Retention, .Target, jakarta.persistence.CacheRetrieveMode, .CacheStoreMode, org.hibernate.CacheMode, .Remove
Declares a named query written in native SQL.

Whereas jakarta.persistence.NamedNativeQuery allows settings to be specified using stringly-typed jakarta.persistence.QueryHints, this annotation is typesafe.

Note that the members of this annotation correspond to hints enumerated by org.hibernate.jpa.AvailableHints.

Author
Emmanuel Bernard
See Also
org.hibernate.query.NativeQuery

Method Summary

Modifier and TypeMethod and Description
public boolean
cacheable()

Whether the query results are cacheable.

public @Remove CacheModeType
cacheMode()

Deprecated since 6.2. use cacheStoreMode() and cacheRetrieveMode() since CacheModeType is deprecated
The cache interaction mode for this query.
public String
cacheRegion()

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

public CacheRetrieveMode
cacheRetrieveMode()

The cache retrieval mode for objects returned by this query.

public CacheStoreMode
cacheStoreMode()

The cache storage mode for objects returned by this query.

public boolean
callable()

Deprecated since 6.0. Calling database procedures and functions through org.hibernate.query.NativeQuery is no longer supported; use jakarta.persistence.NamedStoredProcedureQuery instead.
Is the SQL query a call to a stored procedure or function?
public String
comment()

A comment added to the SQL query.

public int
fetchSize()

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

public FlushModeType
flushMode()

The flush mode for the query.

public String
name()

The name of this query.

public String
query()

The text of the SQL query.

public String[]
querySpaces()

The query spaces involved in this query.

public boolean
readOnly()

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

public Class<?>
resultClass()

The resulting Class.

public String
resultSetMapping()

The name of a jakarta.persistence.SqlResultSetMapping.

public int
timeout()

The query timeout in seconds.

Inherited from java.lang.annotation.Annotation:
annotationTypeequalshashCodetoString

Method Detail

cacheableback to summary
public boolean cacheable()

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

See Also
org.hibernate.query.SelectionQuery#setCacheable(boolean), org.hibernate.jpa.HibernateHints#HINT_CACHEABLE
cacheModeback to summary
public @Remove CacheModeType cacheMode()

Deprecated

since 6.2.

use cacheStoreMode() and cacheRetrieveMode() since CacheModeType is deprecated

The cache interaction mode for this query.

Annotations
@Deprecated
since:6.2
@Remove
See Also
org.hibernate.jpa.HibernateHints#HINT_CACHE_MODE
cacheRegionback to summary
public String cacheRegion()

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

See Also
org.hibernate.query.SelectionQuery#setCacheRegion(String), org.hibernate.jpa.HibernateHints#HINT_CACHE_REGION
cacheRetrieveModeback to summary
public CacheRetrieveMode cacheRetrieveMode()

The cache retrieval mode for objects returned by this query.

See Also
org.hibernate.query.Query#setCacheMode(CacheMode), org.hibernate.jpa.SpecHints#HINT_SPEC_CACHE_RETRIEVE_MODE
cacheStoreModeback to summary
public CacheStoreMode cacheStoreMode()

The cache storage mode for objects returned by this query.

See Also
org.hibernate.query.Query#setCacheMode(CacheMode), org.hibernate.jpa.SpecHints#HINT_SPEC_CACHE_STORE_MODE
callableback to summary
public boolean callable()

Deprecated

since 6.0.

Calling database procedures and functions through org.hibernate.query.NativeQuery is no longer supported; use jakarta.persistence.NamedStoredProcedureQuery instead.

Is the SQL query a call to a stored procedure or function?

Annotations
@Deprecated
since:6.0
See Also
org.hibernate.jpa.HibernateHints#HINT_CALLABLE_FUNCTION
commentback to summary
public String comment()

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

See Also
org.hibernate.query.CommonQueryContract#setComment(String), org.hibernate.jpa.HibernateHints#HINT_COMMENT
fetchSizeback to summary
public int fetchSize()

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

See Also
org.hibernate.query.SelectionQuery#setFetchSize(int), org.hibernate.jpa.HibernateHints#HINT_FETCH_SIZE
flushModeback to summary
public FlushModeType flushMode()

The flush mode for the query.

See Also
org.hibernate.query.CommonQueryContract#setFlushMode(jakarta.persistence.FlushModeType), org.hibernate.jpa.HibernateHints#HINT_FLUSH_MODE
nameback to summary
public String name()

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

See Also
org.hibernate.SessionFactory#addNamedQuery, org.hibernate.Session#createNamedQuery
queryback to summary
public String query()

The text of the SQL query.

querySpacesback to summary
public String[] querySpaces()

The query spaces involved in this query.

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

See Also
org.hibernate.query.SynchronizeableQuery#addSynchronizedQuerySpace, org.hibernate.jpa.HibernateHints#HINT_NATIVE_SPACES, Synchronize
readOnlyback to summary
public boolean readOnly()

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

See Also
org.hibernate.query.SelectionQuery#setReadOnly(boolean), org.hibernate.jpa.HibernateHints#HINT_READ_ONLY
resultClassback to summary
public Class<?> resultClass()

The resulting Class.

Should not be used in conjunction with resultSetMapping()

resultSetMappingback to summary
public String resultSetMapping()

The name of a jakarta.persistence.SqlResultSetMapping.

Should not be used in conjunction with resultClass().

timeoutback to summary
public int timeout()

The query timeout in seconds. Default is no timeout.

See Also
org.hibernate.query.CommonQueryContract#setTimeout(int), org.hibernate.jpa.HibernateHints#HINT_TIMEOUT, org.hibernate.jpa.SpecHints#HINT_SPEC_QUERY_TIMEOUT