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

Annotation Interface NamedPLSQLStoredProcedureQuery

@Target(TYPE) @Retention(RUNTIME) @Repeatable(NamedPLSQLStoredProcedureQueries.class) public @interface NamedPLSQLStoredProcedureQuery
A NamedPLSQLStoredProcedureQuery 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 NamedPLSQLStoredProcedureQuery 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
    Unique name that references this stored procedure query.
    String
    procedureName
    The name of the stored procedure.

  • 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 procedure.
    Class<?>
    resultClass
    Refers to the class of the result.
    String
    resultSetMapping
    The name of the SqlResultSetMapping.

  • Element Details

    • name

      String name
      Unique name that references this stored procedure query.

    • hints

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

    • resultClass

      Class<?> resultClass
      Refers to the class of the result.
      Default:
      void.class

    • resultSetMapping

      String resultSetMapping
      The name of the SqlResultSetMapping.
      Default:
      ""

    • procedureName

      String procedureName
      The name of the stored procedure.

    • parameters

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