org.hibernate.annotations

Annotation Type NamedQuery

@Target(value={TYPE,PACKAGE})
 @Retention(value=RUNTIME)
 @Repeatable(value=NamedQueries.class)
public @interface NamedQuery

Extends NamedQuery with Hibernate features.

Author:

Carlos Gonzalez-Cadenas

See Also:

Query

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	name The name of this NamedQuery.
String	query The query string for this NamedQuery.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
boolean	cacheable Whether the query (results) is cacheable or not.
CacheModeType	cacheMode The cache mode used for this query.
String	cacheRegion If the query results are cacheable, name the query cache region to use.
String	comment A comment added to the generated SQL query.
int	fetchSize The number of rows fetched by the JDBC Driver per trip.
FlushModeType	flushMode The flush mode for this query.
boolean	readOnly Whether the results should be read-only.
int	timeout The query timeout (in seconds).

Element Detail

name

public abstract String name

The name of this NamedQuery.

query

public abstract String query

The query string for this NamedQuery.

flushMode

public abstract FlushModeType flushMode

The flush mode for this query.

Default:

org.hibernate.annotations.FlushModeType.PERSISTENCE_CONTEXT

cacheable

public abstract boolean cacheable

Whether the query (results) is cacheable or not. Default is false, that is not cacheable.

Default:

false

cacheRegion

public abstract String cacheRegion

If the query results are cacheable, name the query cache region to use.

Default:

""

fetchSize

public abstract int fetchSize

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

Default:

-1

timeout

public abstract int timeout

The query timeout (in seconds). Default is no timeout.

Default:

-1

comment

public abstract String comment

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

Default:

""

cacheMode

public abstract CacheModeType cacheMode

The cache mode used for this query. This refers to entities/collections returned from the query.

Default:

org.hibernate.annotations.CacheModeType.NORMAL

readOnly

public abstract boolean readOnly

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

Default:

false