Module eclipselink
Package org.eclipse.persistence.annotations

Annotation Interface NamedStoredProcedureQuery

@Target(TYPE) @Retention(RUNTIME) @Repeatable(NamedStoredProcedureQueries.class) public @interface NamedStoredProcedureQuery
A NamedStoredProcedureQuery annotation allows the definition of queries that call stored procedures as named queries.

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

See Also:
Author:
Guy Pelletier

  • Element Details

    • name

      String name
      Unique name that references this stored procedure query.

    • hints

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

    • resultClass

      @Deprecated Class<?> resultClass
      Deprecated.
      Use resultClasses().
      Refers to the class of the result.
      Default:
      void.class

    • resultClasses

      Class<?>[] resultClasses
      Refers to the classes of the result.
      Default:
      {}

    • resultSetMapping

      @Deprecated String resultSetMapping
      Deprecated.
      Use resultSetMappings().
      The name of the SQLResultMapping.
      Default:
      ""

    • resultSetMappings

      String[] resultSetMappings
      The names of the SqlResultSetMapping.
      Default:
      {}

    • procedureName

      String procedureName
      The name of the stored procedure.

    • returnsResultSet

      boolean returnsResultSet
      Defines if stored procedure returns a result set.

      This is only relevant on databases that support returning result sets from stored procedures.

      Default:
      false

    • multipleResultSets

      boolean multipleResultSets
      Defines if the stored procedure returns multiple result sets.

      This is only relevant on databases that support multiple result sets from stored procedures.

      Default:
      false

    • callByIndex

      boolean callByIndex
      Defines if the stored procedure should be called by index or by name.

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

      By name requires the database platform support naming procedure parameters.

      Default:
      false

    • parameters

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