Annotation Type Index

@Retention(CLASS) @Target({}) public @interface Index
Database index over mapped field names, declared on an entity.

  • Required Element Summary

    Required Elements
    Modifier and Type
    Required Element
    Description
    String[]
    fields
    Lists Java attribute names in index order, not SQL column names.

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    String
    name
    Names the database index.
    boolean
    unique
    Requires indexed value combinations to be unique.

  • Element Details

    • name

      String name
      Names the database index.
      Returns:
      index name; empty by default to request a derived name
      Default:
      ""

    • fields

      String[] fields
      Lists Java attribute names in index order, not SQL column names.
      Returns:
      indexed fields

    • unique

      boolean unique
      Requires indexed value combinations to be unique.
      Returns:
      true for a unique index; false by default
      Default:
      false