-
@Target(value={TYPE,METHOD,FIELD}) @Retention(value=RUNTIME) public @interface TableGenerator
Defines a primary key generator that may be referenced by name when a generator element is specified for theGeneratedValue
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).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( name="addressGen", table="ID_GEN", pkColumnName="GEN_KEY", valueColumnName="GEN_VALUE", pkColumnValue="ADDR_ID") @Id @GeneratedValue(strategy=TABLE, generator="addressGen") int id; ... }
- Since:
- Java Persistence 1.0
- See Also:
GeneratedValue
-
-
Required Element Summary
Required Elements Modifier and Type Required Element and Description String
name
(Required) A unique generator name that can be referenced by one or more classes to be the generator for id values.
-
Optional Element Summary
Optional Elements Modifier and Type Optional Element and Description int
allocationSize
(Optional) The amount to increment by when allocating id numbers from the generator.String
catalog
(Optional) The catalog of the table.Index[]
indexes
(Optional) Indexes for the table.int
initialValue
(Optional) The initial value to be used to initialize the column that stores the last value generated.String
pkColumnName
(Optional) Name of the primary key column in the table.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.String
schema
(Optional) The schema of the table.String
table
(Optional) Name of table that stores the generated id values.UniqueConstraint[]
uniqueConstraints
(Optional) Unique constraints that are to be placed on the table.String
valueColumnName
(Optional) Name of the column that stores the last value generated.
-
-
-
Element Detail
-
name
public abstract String name
(Required) A unique generator name that can be referenced by one or more classes to be the generator for id values.
-
-
-
table
public abstract String table
(Optional) Name of table that stores the generated id values.Defaults to a name chosen by persistence provider.
- Default:
- ""
-
-
-
catalog
public abstract String catalog
(Optional) The catalog of the table.Defaults to the default catalog.
- Default:
- ""
-
-
-
schema
public abstract String schema
(Optional) The schema of the table.Defaults to the default schema for user.
- Default:
- ""
-
-
-
pkColumnName
public abstract String pkColumnName
(Optional) Name of the primary key column in the table.Defaults to a provider-chosen name.
- Default:
- ""
-
-
-
valueColumnName
public abstract String valueColumnName
(Optional) Name of the column that stores the last value generated.Defaults to a provider-chosen name.
- Default:
- ""
-
-
-
pkColumnValue
public abstract 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
- Default:
- ""
-
-
-
initialValue
public abstract int initialValue
(Optional) The initial value to be used to initialize the column that stores the last value generated.- Default:
- 0
-
-
-
allocationSize
public abstract int allocationSize
(Optional) The amount to increment by when allocating id numbers from the generator.- Default:
- 50
-
-
-
uniqueConstraints
public abstract 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.
- Default:
- {}
-
-
-
indexes
public abstract 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 will be created automatically.- Since:
- Java Persistence 2.1
- Default:
- {}
-
-
Traduction non disponible
Les API Java ne sont pas encore traduites en français sur l'infobrol. Seule la version anglaise est disponible pour l'instant.
Version en cache
21/08/2025 19:10:09 Cette version de la page est en cache (à la date du 21/08/2025 19:10:09) afin d'accélérer le traitement.Vous pouvez activer le mode utilisateur dans le menu en haut pour afficher la version plus récente de la page.
Document créé le 19/04/2008, dernière modification le 18/08/2025
Source du document imprimé : https://www.gaudry.be/java-api-javaee-rf-javax/persistence/tablegenerator.html
L'infobrol est un site personnel dont le contenu n'engage que moi. Le texte est mis à disposition sous licence CreativeCommons(BY-NC-SA). Plus d'info sur les conditions d'utilisation et sur l'auteur.
Références
Ces références et liens indiquent des documents consultés lors de la rédaction de cette page, ou qui peuvent apporter un complément d'information, mais les auteurs de ces sources ne peuvent être tenus responsables du contenu de cette page.
L'auteur de ce site est seul responsable de la manière dont sont présentés ici les différents concepts, et des libertés qui sont prises avec les ouvrages de référence. N'oubliez pas que vous devez croiser les informations de sources multiples afin de diminuer les risques d'erreurs.