Annotation Type Unique


Annotation for a database unique constraint. Used for database schema generation to create unique constraints. Also used to reorder database operations when flushing changes to avoid unique constraint violations. Corresponds to the xml element "unique".
Since:
2.1
Version:
2.1
  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    Columns that compose this unique constraint.
    Whether this unique constraint is deferred until commit.
    Vendor extensions.
    Member (field and property) names that compose this unique constraint.
    Name of the unique constraint.
    Table for the unique constraint.
  • Element Details

    • name

      String name
      Name of the unique constraint.
      Returns:
      the name of the unique constraint
      Default:
      ""
    • table

      String table
      Table for the unique constraint. This is needed iff annotating a type where this unique constraint is not for the primary table for the persistent class or interface.
      Returns:
      the table on which the unique constraint is defined
      Default:
      ""
    • deferred

      String deferred
      Whether this unique constraint is deferred until commit.
      Returns:
      whether this unique constraint is deferred until commit
      Default:
      ""
    • members

      String[] members
      Member (field and property) names that compose this unique constraint.
      Returns:
      member names that compose this unique constraint
      Default:
      {}
    • columns

      Column[] columns
      Columns that compose this unique constraint.
      Returns:
      columns that compose this unique constraint
      Default:
      {}
    • extensions

      Extension[] extensions
      Vendor extensions.
      Returns:
      the vendor extensions
      Default:
      {}