jakarta.persistence.TableGenerator

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;
     ...
 }

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;
     ...
 }

See Also:

GeneratedValue

Since:

Jakarta Persistence (JPA) 1.0