org.hibernate.annotations

Annotation Type NamedQuery

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

Extends NamedQuery with Hibernate features

Author:

Carlos Gonz�lez-Cadenas

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
java.lang.String	name the name of the NamedQuery
java.lang.String	query the Query String for the NamedQuery

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
boolean	cacheable mark the query as cacheable or not
CacheModeType	cacheMode the cache mode used for this query
java.lang.String	cacheRegion the cache region to use
java.lang.String	comment comment added to the SQL query, useful for the DBA
int	fetchSize the number of rows fetched by the JDBC Driver per roundtrip
FlushModeType	flushMode the flush mode for the query
boolean	readOnly marks whether the results are fetched in read-only mode or not
int	timeout the query timeout in seconds

Element Detail

name

public abstract java.lang.String name

the name of the NamedQuery

query

public abstract java.lang.String query

the Query String for the NamedQuery

flushMode

public abstract FlushModeType flushMode

the flush mode for the query

Default:

org.hibernate.annotations.FlushModeType.PERSISTENCE_CONTEXT

cacheable

public abstract boolean cacheable

mark the query as cacheable or not

Default:

false

cacheRegion

public abstract java.lang.String cacheRegion

the cache region to use

Default:

""

fetchSize

public abstract int fetchSize

the number of rows fetched by the JDBC Driver per roundtrip

Default:

-1

timeout

public abstract int timeout

the query timeout in seconds

Default:

-1

comment

public abstract java.lang.String comment

comment added to the SQL query, useful for the DBA

Default:

""

cacheMode

public abstract CacheModeType cacheMode

the cache mode used for this query

Default:

org.hibernate.annotations.CacheModeType.NORMAL

readOnly

public abstract boolean readOnly

marks whether the results are fetched in read-only mode or not

Default:

false