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

Annotation Interface PLSQLTable

@Target(TYPE) @Retention(RUNTIME) @Repeatable(PLSQLTables.class) public @interface PLSQLTable
A PLSQLTable annotation is used to define a database PLSQL TABLE type.

This type can be used within PLSQL procedure calls.

See Also:
Author:
James Sutherland

  • Required Element Summary

    Required Elements
    Modifier and Type
    Required Element
    Description
    String
    compatibleType
    The name of the database VARRAY type that mirrors the table's structure.
    String
    name
    The name of the record type in the database.

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    boolean
    isNestedTable
    Indicates a non-associative (nested) table.
    Class<?>
    javaType
    The Java Collection class to map the varray to.
    String
    nestedType
    The name of the database OBJECT TYPE or VARRAY type that mirrors the record's structure.

  • Element Details

    • name

      String name
      The name of the record type in the database.

    • compatibleType

      String compatibleType
      The name of the database VARRAY type that mirrors the table's structure.

      The table will be converted to/from this type so it can be passed through JDBC.

    • nestedType

      String nestedType
      The name of the database OBJECT TYPE or VARRAY type that mirrors the record's structure.

      The record will be converted to/from this type so it can be passed through JDBC.

      Default:
      "VARCHAR_TYPE"

    • javaType

      Class<?> javaType
      The Java Collection class to map the varray to.

      This can be any valid Collection implementation.

      Default:
      java.util.ArrayList.class

    • isNestedTable

      boolean isNestedTable
      Indicates a non-associative (nested) table.

      This method would typically be used when generating a constructor for the collection in PL/SQL (as the constructors for associative arrays (Varray) and a non-associative (nested) tables differ).

      Default:
      false