Jakarta Persistence (JPA) Annotation Type

jakarta.persistence.Table

Implemented Interfaces:
Annotation
Target:
Type
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: 

@Entity
@Table(name = "CUST", schema = "RECORDS")
public class Customer { ... }

This annotation may not be applied to a class annotated MappedSuperclass or Embeddable.

Since:
Jakarta Persistence (JPA) 1.0

Public Instance Methods

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

Defaults to the default catalog.

Since:
Jakarta Persistence (JPA) 1.0
CheckConstraint[] check()
(Optional) Check constraints to be applied to the table.
These are only used if table generation is in effect.
Since:
Jakarta Persistence (JPA) 3.2
String comment()
(Optional) A comment to be applied to the table.
This is only used if table generation is in effect.
Since:
Jakarta Persistence (JPA) 3.2
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:
Jakarta Persistence (JPA) 2.1
String name()
(Optional) The name of the table.

Defaults to the entity name.

Since:
Jakarta Persistence (JPA) 1.0
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:
Jakarta Persistence (JPA) 3.2
String schema()
(Optional) The schema of the table.

Defaults to the default schema for user.

Since:
Jakarta Persistence (JPA) 1.0
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.

Since:
Jakarta Persistence (JPA) 1.0

Annotation Elements

This is a marker annotation with no members/elements.

Additional JDK methods inherited from java.lang.annotation.Annotation

java.lang.annotation.Annotation/annotationType(), java.lang.annotation.Annotation/equals(Object), java.lang.annotation.Annotation/hashCode(), java.lang.annotation.Annotation/toString()