Module eclipselink

Package org.eclipse.persistence.annotations

Annotation Interface NamedStoredFunctionQuery

@Target(TYPE)
@Retention(RUNTIME)
@Repeatable(NamedStoredFunctionQueries.class)
public @interface NamedStoredFunctionQuery

A NamedStoredFunctionQuery annotation allows the definition of queries that call stored functions as named queries.

A NamedStoredFunctionQuery annotation may be defined on an Entity or MappedSuperclass.

Author:

James

Required Element Summary

Required Elements

Modifier and Type	Required Element	Description
String	functionName	The name of the stored function.
String	name	Unique name that references this stored function query.
StoredProcedureParameter	returnParameter	Defines the return value of the stored function.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element	Description
boolean	callByIndex	Defines if the stored function should be called by index or by name.
jakarta.persistence.QueryHint[]	hints	Query hints.
StoredProcedureParameter[]	parameters	Defines the parameters to the stored function.
String	resultSetMapping	The name of the SqlResultSetMapping.

Element Details

name

String name

Unique name that references this stored function query.

hints

jakarta.persistence.QueryHint[] hints

Query hints.

Default:

{}

resultSetMapping

String resultSetMapping

The name of the SqlResultSetMapping.

Default:

""

functionName

String functionName

The name of the stored function.

callByIndex

boolean callByIndex

Defines if the stored function should be called by index or by name.

By index requires that the parameters() are defined in the same order as the function on the database.

By name requires the database platform support naming function parameters.

Default:

false

parameters

StoredProcedureParameter[] parameters

Defines the parameters to the stored function.

Default:

{}

returnParameter

StoredProcedureParameter returnParameter

Defines the return value of the stored function.