Top Description Methods
jakarta.persistence

public @Interface Table

extends Annotation
Annotations
@Target:TYPE
@Retention:RUNTIME
Imports
java.lang.annotation.Target, .Retention
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 { ... } 
@Entity
@Table(name = "CUST", schema = "RECORDS")
public class Customer { ... }

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

Since
1.0

Method Summary

Modifier and TypeMethod and Description
public String
catalog()

(Optional) The catalog of the table.

public CheckConstraint[]
check()

(Optional) Check constraints to be applied to the table.

public String
comment()

(Optional) A comment to be applied to the table.

public Index[]
indexes()

(Optional) Indexes for the table.

public String
name()

(Optional) The name of the table.

public String
options()

(Optional) A SQL fragment appended to the generated DDL statement which creates this table.

public String
schema()

(Optional) The schema of the table.

public UniqueConstraint[]
uniqueConstraints()

(Optional) Unique constraints to be placed on the table.

Inherited from java.lang.annotation.Annotation:
annotationTypeequalshashCodetoString

Method Detail

catalogback to summary
public String catalog()

(Optional) The catalog of the table.

Defaults to the default catalog.

checkback to summary
public CheckConstraint[] check()

(Optional) Check constraints to be applied to the table. These are only used if table generation is in effect.

Since
3.2
commentback to summary
public String comment()

(Optional) A comment to be applied to the table. This is only used if table generation is in effect.

Since
3.2
indexesback to summary
public 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
nameback to summary
public String name()

(Optional) The name of the table.

Defaults to the entity name.

optionsback to summary
public 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
schemaback to summary
public String schema()

(Optional) The schema of the table.

Defaults to the default schema for user.

uniqueConstraintsback to summary
public 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.