-
@Target(value={TYPE,METHOD,FIELD}) @Retention(value=RUNTIME) public @interface SequenceGenerator
Defines a primary key generator that may be referenced by name when a generator element is specified for theGeneratedValue
annotation. A sequence 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: @SequenceGenerator(name="EMP_SEQ", allocationSize=25)
- Since:
- Java Persistence 1.0
-
-
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 primary key values.
-
Optional Element Summary
Optional Elements Modifier and Type Optional Element and Description int
allocationSize
(Optional) The amount to increment by when allocating sequence numbers from the sequence.String
catalog
(Optional) The catalog of the sequence generator.int
initialValue
(Optional) The value from which the sequence object is to start generating.String
schema
(Optional) The schema of the sequence generator.String
sequenceName
(Optional) The name of the database sequence object from which to obtain primary key values.
-
-
-
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 primary key values.
-
-
-
sequenceName
public abstract String sequenceName
(Optional) The name of the database sequence object from which to obtain primary key values.Defaults to a provider-chosen value.
- Default:
- ""
-
-
-
catalog
public abstract String catalog
(Optional) The catalog of the sequence generator.- Since:
- Java Persistence 2.0
- Default:
- ""
-
-
-
schema
public abstract String schema
(Optional) The schema of the sequence generator.- Since:
- Java Persistence 2.0
- Default:
- ""
-
-
Document created the 11/06/2005, last modified the 18/08/2025
Source of the printed document:https://www.gaudry.be/en/java-api-javaee-rf-javax/persistence/SequenceGenerator.html
The infobrol is a personal site whose content is my sole responsibility. The text is available under CreativeCommons license (BY-NC-SA). More info on the terms of use and the author.
References
These references and links indicate documents consulted during the writing of this page, or which may provide additional information, but the authors of these sources can not be held responsible for the content of this page.
The author of this site is solely responsible for the way in which the various concepts, and the freedoms that are taken with the reference works, are presented here. Remember that you must cross multiple source information to reduce the risk of errors.