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

Annotation Type NamedPLSQLStoredProcedureQuery

@Target(TYPE) @Retention(RUNTIME) public @interface NamedPLSQLStoredProcedureQuery
A PLSQLNamedStoredProcedureQuery annotation allows the definition of queries that call PLSQL stored procedures 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 PLSQLNamedStoredProcedureQuery annotation may be defined on an Entity or MappedSuperclass.
Author:
James Sutherland

  • Required Element Summary

    Required Elements
    Modifier and Type
    Required Element
    Description
    String
    name
    (Required) Unique name that references this stored procedure query.
    String
    procedureName
    (Required) The name of the stored procedure.

  • 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.
    Class
    resultClass
    (Optional) Refers to the class of the result.
    String
    resultSetMapping
    (Optional) The name of the SQLResultMapping.

  • Element Details

    • name

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

    • procedureName

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

    • hints

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

    • resultClass

      Class resultClass
      (Optional) Refers to the class of the result.
      Default:
      void.class

    • resultSetMapping

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

    • parameters

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