Module eclipselink
Package org.eclipse.persistence.platform.database.oracle.annotations

Annotation Interface NamedPLSQLStoredFunctionQuery

@Target(TYPE) @Retention(RUNTIME) @Repeatable(NamedPLSQLStoredFunctionQueries.class) public @interface NamedPLSQLStoredFunctionQuery
A NamedPLSQLStoredFunctionQuery annotation allows the definition of queries that call PLSQL stored functions as named queries.

The PLSQL support adds support for complex PLSQL types such as RECORD and TABLE types, that are not accessible from JDBC.

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

Author:
James Sutherland

  • 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.
    PLSQLParameter
    returnParameter
    Defines the return value of the stored function.

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    jakarta.persistence.QueryHint[]
    hints
    Query hints.
    PLSQLParameter[]
    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.

    • parameters

      PLSQLParameter[] parameters
      Defines the parameters to the stored function.
      Default:
      {}

    • returnParameter

      PLSQLParameter returnParameter
      Defines the return value of the stored function.