org.apache.deltaspike.data.api

Annotation Type Query

@Retention(value=RUNTIME)
 @Target(value=METHOD)
public @interface Query

Supply query meta data to a method with this annotation.
Currently supports:

• JPQL queries as part of the annotation value
• Execute named queries referenced by the named value
• Execute native SQL queries
• Restrict the result size to a static value
• Provide a lock mode

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
javax.persistence.QueryHint[]	hints (Optional) Query properties and hints.
boolean	isNative Defines a native SQL query.
javax.persistence.LockModeType	lock Defines a lock mode for the query.
int	max Limits the number of results the query returns.
String	named References a named query.
SingleResultType	singleResult Defines how a single result query is fetched.
String	value Defines the Query to execute.

Element Detail

value

public abstract String value

Defines the Query to execute. Can be left empty for method expression queries or when referencing a named() query.

Default:

""

named

public abstract String named

References a named query.

Default:

""

isNative

public abstract boolean isNative

Defines a native SQL query.

Default:

false

max

public abstract int max

Limits the number of results the query returns.

Default:

0

lock

public abstract javax.persistence.LockModeType lock

Defines a lock mode for the query.

Default:

javax.persistence.LockModeType.NONE

hints

public abstract javax.persistence.QueryHint[] hints

(Optional) Query properties and hints. May include vendor-specific query hints.

Default:

{}

singleResult

public abstract SingleResultType singleResult

Defines how a single result query is fetched. Defaults to the JPA way with Exceptions thrown on non-single result queries.

Default:

org.apache.deltaspike.data.api.SingleResultType.JPA