Top Description Methods
jakarta.persistence

public @Interface TableGenerator

extends Annotation
Annotations
@Repeatable:TableGenerators
@Target:TYPE, METHOD, FIELD, PACKAGE
@Retention:RUNTIME
Imports
java.lang.annotation.Target, .Retention, .Repeatable
Defines a primary key generator that may be referenced by name when a generator element is specified for the GeneratedValue annotation. A table generator may be specified on the entity class or on the primary key field or property. The scope of the generator name is global to the persistence unit (across all generator types).

If no name is explicitly specified, and the annotation occurs on an entity class or primary key attribute of an entity class, then the name defaults to the name of the entity.

If no name is explicitly specified, and the annotation occurs on a package descriptor, then the annotation defines a recipe for producing a default generator when a GeneratedValue annotation of any program element in the annotated package has strategy=TABLE and a defaulted generator name. The name of this default generator is the defaulted generator name, and its other properties are determined by the members of the package TableGenerator annotation.

Example 1:

@Entity public class Employee { ... @TableGenerator( name = "empGen", table = "ID_GEN", pkColumnName = "GEN_KEY", valueColumnName = "GEN_VALUE", pkColumnValue = "EMP_ID", allocationSize = 1) @Id @GeneratedValue(strategy = TABLE, generator = "empGen") int id; ... } 
@Entity
public class Employee {
    ...
    @TableGenerator(
        name = "empGen",
        table = "ID_GEN",
        pkColumnName = "GEN_KEY",
        valueColumnName = "GEN_VALUE",
        pkColumnValue = "EMP_ID",
        allocationSize = 1)
    @Id
    @GeneratedValue(strategy = TABLE, generator = "empGen")
    int id;
    ...
}

Example 2:

@Entity public class Address { ... @TableGenerator( table = "ID_GEN", pkColumnName = "GEN_KEY", valueColumnName = "GEN_VALUE", pkColumnValue = "ADDR_ID") @Id @GeneratedValue(strategy = TABLE) int id; ... } 
@Entity
public class Address {
    ...
    @TableGenerator(
        table = "ID_GEN",
        pkColumnName = "GEN_KEY",
        valueColumnName = "GEN_VALUE",
        pkColumnValue = "ADDR_ID")
    @Id
    @GeneratedValue(strategy = TABLE)
    int id;
    ...
}
Since
1.0
See Also
GeneratedValue

Method Summary

Modifier and TypeMethod and Description
public int
allocationSize()

(Optional) The amount to increment by when allocating id numbers from the generator.

public String
catalog()

(Optional) The catalog of the table.

public Index[]
indexes()

(Optional) Indexes for the table.

public int
initialValue()

(Optional) The initial value to be used to initialize the column that stores the last value generated.

public String
name()

(optional) A unique generator name that can be referenced by one or more classes to be the generator for id values.

public String
options()

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

public String
pkColumnName()

(Optional) Name of the primary key column in the table.

public String
pkColumnValue()

(Optional) The primary key value in the generator table that distinguishes this set of generated values from others that may be stored in the table.

public String
schema()

(Optional) The schema of the table.

public String
table()

(Optional) Name of the table that stores the generated id values.

public UniqueConstraint[]
uniqueConstraints()

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

public String
valueColumnName()

(Optional) Name of the column that stores the last value generated.

Inherited from java.lang.annotation.Annotation:
annotationTypeequalshashCodetoString

Method Detail

allocationSizeback to summary
public int allocationSize()

(Optional) The amount to increment by when allocating id numbers from the generator.

catalogback to summary
public String catalog()

(Optional) The catalog of the table.

Defaults to the default catalog.

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
initialValueback to summary
public int initialValue()

(Optional) The initial value to be used to initialize the column that stores the last value generated.

nameback to summary
public String name()

(optional) A unique generator name that can be referenced by one or more classes to be the generator for id values.

Defaults to the name of the entity when the annotation occurs on an entity class or primary key attribute.

optionsback to summary
public String options()

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

Since
3.2
pkColumnNameback to summary
public String pkColumnName()

(Optional) Name of the primary key column in the table.

Defaults to a provider-chosen name.

pkColumnValueback to summary
public String pkColumnValue()

(Optional) The primary key value in the generator table that distinguishes this set of generated values from others that may be stored in the table.

Defaults to a provider-chosen value to store in the primary key column of the generator table

schemaback to summary
public String schema()

(Optional) The schema of the table.

Defaults to the default schema for user.

tableback to summary
public String table()

(Optional) Name of the table that stores the generated id values.

Defaults to a name chosen by persistence provider.

uniqueConstraintsback to summary
public UniqueConstraint[] uniqueConstraints()

(Optional) Unique constraints that are to be placed on the table. These are only used if table generation is in effect. These constraints apply in addition to primary key constraints.

Defaults to no additional constraints.

valueColumnNameback to summary
public String valueColumnName()

(Optional) Name of the column that stores the last value generated.

Defaults to a provider-chosen name.