Module jakarta.persistence
Package jakarta.persistence

Annotation Type Table

  • @Target(TYPE)
@Retention(RUNTIME)
public @interface Table
    Specifies the primary table mapped by the annotated entity type.

    Additional tables may be specified using SecondaryTable or SecondaryTables annotation.

    If no Table annotation is specified for an entity class, the default values apply.

    Example: {@snippet :

    Since:
    1.0

    • Optional Element Summary

      Optional Elements 
      Modifier and Type Optional Element Description
      java.lang.String catalog
      (Optional) The catalog of the table.
      CheckConstraint[] check
      (Optional) Check constraints to be applied to the table.
      java.lang.String comment
      (Optional) A comment to be applied to the table.
      Index[] indexes
      (Optional) Indexes for the table.
      java.lang.String name
      (Optional) The name of the table.
      java.lang.String options
      (Optional) A SQL fragment appended to the generated DDL statement which creates this table.
      java.lang.String schema
      (Optional) The schema of the table.
      UniqueConstraint[] uniqueConstraints
      (Optional) Unique constraints to be placed on the table.

    • Element Detail

      • name

        java.lang.String name
        (Optional) The name of the table.

        Defaults to the entity name.

        Default:
        ""

      • catalog

        java.lang.String catalog
        (Optional) The catalog of the table.

        Defaults to the default catalog.

        Default:
        ""

      • schema

        java.lang.String schema
        (Optional) The schema of the table.

        Defaults to the default schema for user.

        Default:
        ""

      • uniqueConstraints

        UniqueConstraint[] uniqueConstraints
        (Optional) Unique constraints to be placed on the table. These are only used if table generation is in effect. These constraints apply in addition to any constraints specified by the Column and JoinColumn annotations and constraints entailed by primary key mappings.

        Defaults to no additional constraints.

        Default:
        {}

      • indexes

        Index[] indexes
        (Optional) Indexes for the table. These are only used if table generation is in effect. Note that it is not necessary to specify an index for a primary key, as the primary key index is created automatically.
        Since:
        2.1
        Default:
        {}

      • check

        CheckConstraint[] check
        (Optional) Check constraints to be applied to the table. These are only used if table generation is in effect.
        Since:
        3.2
        Default:
        {}

      • comment

        java.lang.String comment
        (Optional) A comment to be applied to the table. This is only used if table generation is in effect.
        Since:
        3.2
        Default:
        ""

      • options

        java.lang.String options
        (Optional) A SQL fragment appended to the generated DDL statement which creates this table. This is only used if table generation is in effect.
        Since:
        3.2
        Default:
        ""