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

Annotation Type NamedPLSQLStoredFunctionQuery

@Target(TYPE) @Retention(RUNTIME) 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
    (Required) The name of the stored procedure.
    String
    name
    (Required) Unique name that references this stored procedure query.
    PLSQLParameter
    returnParameter
    (Required) Defines the return value of the stored function.

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    jakarta.persistence.QueryHint[]
    hints
    (Optional) Query hints.
    PLSQLParameter[]
    parameters
    (Optional) Defines the parameters to the stored procedure.
    String
    resultSetMapping
    (Optional) The name of the SQLResultMapping.

  • Element Details

    • name

      String name
      (Required) Unique name that references this stored procedure query.

    • functionName

      String functionName
      (Required) The name of the stored procedure.

    • returnParameter

      PLSQLParameter returnParameter
      (Required) Defines the return value of the stored function.

    • hints

      jakarta.persistence.QueryHint[] hints
      (Optional) Query hints.
      Default:
      {}

    • resultSetMapping

      String resultSetMapping
      (Optional) The name of the SQLResultMapping.
      Default:
      ""

    • parameters

      PLSQLParameter[] parameters
      (Optional) Defines the parameters to the stored procedure.
      Default:
      {}