Package org.hibernate.annotations

Annotation Type NamedNativeQuery

@Target({TYPE,PACKAGE})
@Retention(RUNTIME)
@Repeatable(NamedNativeQueries.class)
public @interface NamedNativeQuery

Declares a named query written in native SQL.

Extends NamedNativeQuery with additional settings.

See Also:

NativeQuery

Required Element Summary

Required Elements

Modifier and Type	Required Element	Description
String	name	The name of this query.
String	query	The text of the SQL query.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element	Description
boolean	cacheable	Whether the query results are cacheable.
CacheModeType	cacheMode	Deprecated. use cacheStoreMode() and cacheRetrieveMode() since CacheModeType is deprecated
String	cacheRegion	If the query results are cacheable, the name of the query cache region.
jakarta.persistence.CacheRetrieveMode	cacheRetrieveMode	The cache retrieval mode for objects returned by this query.
jakarta.persistence.CacheStoreMode	cacheStoreMode	The cache storage mode for objects returned by this query.
boolean	callable	Deprecated. Calling database procedures and functions through NativeQuery is no longer supported; use NamedStoredProcedureQuery instead.
String	comment	A comment added to the SQL query.
int	fetchSize	The number of rows fetched by the JDBC driver per trip.
FlushModeType	flushMode	The flush mode for the query.
String[]	querySpaces	The query spaces involved in this query.
boolean	readOnly	Whether the query results should be marked read-only.
Class<?>	resultClass	The resulting Class.
String	resultSetMapping	The name of a SqlResultSetMapping.
int	timeout	The query timeout in seconds.

Element Detail

name

String name

The name of this query.

See Also:

EntityManagerFactory.addNamedQuery(java.lang.String, jakarta.persistence.Query), Session.createNamedQuery(java.lang.String, java.lang.Class<R>)

query

String query

The text of the SQL query.

resultClass

Class<?> resultClass

The resulting Class. Should not be used in conjunction with resultSetMapping()

Default:

void.class

resultSetMapping

String resultSetMapping

The name of a SqlResultSetMapping. Should not be used in conjunction with resultClass().

Default:

""

flushMode

FlushModeType flushMode

The flush mode for the query.

See Also:

CommonQueryContract.setFlushMode(jakarta.persistence.FlushModeType)

Default:

org.hibernate.annotations.FlushModeType.PERSISTENCE_CONTEXT

cacheable

boolean cacheable

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

See Also:

SelectionQuery.setCacheable(boolean)

Default:

false

cacheRegion

String cacheRegion

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

See Also:

SelectionQuery.setCacheRegion(String)

Default:

""

fetchSize

int fetchSize

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

See Also:

SelectionQuery.setFetchSize(int)

Default:

-1

timeout

int timeout

The query timeout in seconds. Default is no timeout.

See Also:

CommonQueryContract.setTimeout(int)

Default:

-1

comment

String comment

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

See Also:

CommonQueryContract.setComment(String)

Default:

""

cacheStoreMode

jakarta.persistence.CacheStoreMode cacheStoreMode

The cache storage mode for objects returned by this query.

See Also:

Query.setCacheMode(CacheMode)

Default:

jakarta.persistence.CacheStoreMode.USE

cacheRetrieveMode

jakarta.persistence.CacheRetrieveMode cacheRetrieveMode

The cache retrieval mode for objects returned by this query.

See Also:

Query.setCacheMode(CacheMode)

Default:

jakarta.persistence.CacheRetrieveMode.USE

cacheMode

@Deprecated(since="6.2")
CacheModeType cacheMode

Deprecated.

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

The cache interaction mode for this query.

Default:

org.hibernate.annotations.CacheModeType.NORMAL

readOnly

boolean readOnly

Whether the query results should be marked read-only. Default is false.

See Also:

SelectionQuery.setReadOnly(boolean)

Default:

false

querySpaces

String[] querySpaces

The query spaces involved in this query.

See Also:

SynchronizeableQuery

Default:

{}

callable

@Deprecated(since="6.0")
boolean callable

Deprecated.

Calling database procedures and functions through NativeQuery is no longer supported; use NamedStoredProcedureQuery instead.

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

Default:

false