Annotation Type Index


Allow a database INDEX to be define when generating DDL. The @Index can be defined on a Entity class, or on an attribute. The column is defaulted when defined on a attribute.
Since:
EclipseLink 2.2
  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    The catalog of the INDEX
    Specify the set of columns to define the index on.
    The name of the INDEX, defaults to INDEX_<table-name>
    The schema of the INDEX
    The table to define the index on, defaults to entities primary table.
    boolean
     
  • Element Details

    • name

      String name
      The name of the INDEX, defaults to INDEX_<table-name>
      Default:
      ""
    • schema

      String schema
      The schema of the INDEX
      Default:
      ""
    • catalog

      String catalog
      The catalog of the INDEX
      Default:
      ""
    • table

      String table
      The table to define the index on, defaults to entities primary table.
      Default:
      ""
    • unique

      boolean unique
      Default:
      false
    • columnNames

      String[] columnNames
      Specify the set of columns to define the index on. Not required when annotated on a field/method.
      Default:
      {}