Module jakarta.persistence
Package jakarta.persistence

Annotation Interface StoredProcedureParameter

@Target({}) @Retention(RUNTIME) public @interface StoredProcedureParameter
Declares a parameter of a named stored procedure query. All parameters of a named stored procedure query must be declared.
Since:
2.1
See Also:

  • Required Element Summary

    Required Elements
    Modifier and Type
    Required Element
    Description
    Class<?>
    type
    JDBC type of the parameter.

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    ParameterMode
    mode
    Specifies whether the parameter is an IN, INOUT, OUT, or REF_CURSOR parameter.
    String
    name
    The name of the parameter as defined by the stored procedure in the database.

  • Element Details

    • name

      String name
      The name of the parameter as defined by the stored procedure in the database. If a name is not specified, it is assumed that the stored procedure uses positional parameters.
      Default:
      ""

    • mode

      ParameterMode mode
      Specifies whether the parameter is an IN, INOUT, OUT, or REF_CURSOR parameter. REF_CURSOR parameters are used by some databases to return result sets from a stored procedure.
      Default:
      IN

    • type

      Class<?> type
      JDBC type of the parameter.