NamedQuery (hibernate-core JavaDocs)

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

Extends NamedQuery with Hibernate features.

See Also:: Query

Required Element Summary

Required Elements
Modifier and Type Required Element 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	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
```
String name
```
    The name of this NamedQuery.
- - query
```
String query
```
    The query string for this NamedQuery.
- - flushMode
```
FlushModeType flushMode
```
    The flush mode for this query.
    
    Default:
    
    org.hibernate.annotations.FlushModeType.PERSISTENCE_CONTEXT
- - cacheable
```
boolean cacheable
```
    Whether the query (results) is cacheable or not. Default is false, that is not cacheable.
    
    Default:
    
    false
- - cacheRegion
```
String cacheRegion
```
    If the query results are cacheable, name the query cache region to use.
    
    Default:
    
    ""
- - fetchSize
```
int fetchSize
```
    The number of rows fetched by the JDBC Driver per trip.
    
    Default:
    
    -1
- - timeout
```
int timeout
```
    The query timeout (in seconds). Default is no timeout.
    
    Default:
    
    -1
- - comment
```
String comment
```
    A comment added to the generated SQL query. Useful when engaging with DBA.
    
    Default:
    
    ""
- - cacheMode
```
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
```
boolean readOnly
```
    Whether the results should be read-only. Default is false.
    
    Default:
    
    false