Annotation Interface ReadQueryOptions

@Target(METHOD)
@Retention(RUNTIME)
public @interface ReadQueryOptions

Configures options that affect the execution of a database read operation. This annotation may be applied to:

• a method with a StaticQuery or Jakarta Data jakarta.data.repository.Query annotation whose value member specifies a SELECT statement,
• a method with a StaticNativeQuery annotation whose value member specifies a SQL operation which returns a result set, or
• a Jakarta Data repository method annotated jakarta.data.repository.Find.

This annotation must be respected by an implementation of Jakarta Data backed by Jakarta Persistence.

Since:

4.0

See Also:

• WriteQueryOptions

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element	Description
CacheRetrieveMode	cacheRetrieveMode	The cache retrieve mode to use.
CacheStoreMode	cacheStoreMode	The cache store mode to use.
String	entityGraph	The name of a NamedEntityGraph applied to the entity returned by the query.
QueryHint[]	hints	Query properties and hints.
LockModeType	lockMode	The lock mode type to use in query execution.
PessimisticLockScope	lockScope	The pessimistic lock scope to use in query execution if a pessimistic lock mode is specified via lockMode().
int	timeout	A query timeout in milliseconds.

Element Details

cacheStoreMode

CacheStoreMode cacheStoreMode

The cache store mode to use. The presence of this annotation overrides the default cache store mode of the persistence context.

See Also:

• Query.setCacheStoreMode(CacheStoreMode)

Default:

USE

cacheRetrieveMode

CacheRetrieveMode cacheRetrieveMode

The cache retrieve mode to use. The presence of this annotation overrides the default cache retrieve mode of the persistence context.

See Also:

• Query.setCacheRetrieveMode(CacheRetrieveMode)

Default:

USE

timeout

int timeout

A query timeout in milliseconds. By default, there is no timeout.

See Also:

• Query.setTimeout(Integer)

Default:

-1

hints

QueryHint[] hints

Query properties and hints. May include vendor-specific query hints.

See Also:

• Query.setHint(String, Object)

Default:

{}

lockMode

LockModeType lockMode

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.

If a lock mode is explicitly specified for a native query, the behavior is undefined and unportable between persistence providers.

See Also:

• Query.setLockMode(LockModeType)

Default:

NONE

lockScope

PessimisticLockScope lockScope

The pessimistic lock scope to use in query execution if a pessimistic lock mode is specified via lockMode().

Default:

NORMAL

entityGraph

String entityGraph

The name of a NamedEntityGraph applied to the entity returned by the query. By default, no entity graph is applied. The named entity graph must be an entity graph compatible with the entity type returned by the query. If the result type of the query is not an entity type, the behavior is undefined. The entity graph is interpreted as a load graph. The entity graph specified here may be overridden by calling setEntityGraph().

See Also:

• NamedEntityGraph.name()
• TypedQuery.setEntityGraph(EntityGraph)

Default:

""