Home » JPA » Annotations » Value Generation » SequenceGenerator
256 words

javax.persistence.SequenceGenerator - JPA annotation

javax.persistence
Annotation SequenceGenerator

Target:
Classes and fields (including property get methods)
Defines a primary key generator that may be referenced by name when a generator element is specified for the GeneratedValue 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:
JPA 1.0
Learn how to define and use automatic value generation in Chapter 2 of the ObjectDB/JPA manual.
int allocationSize
(Optional) The amount to increment by when allocating sequence numbers from the sequence.
(Optional) The amount to increment by when allocating sequence numbers from the sequence.
Default value:
50
Since:
JPA 1.0
String catalog
(Optional) The catalog of the sequence generator.
(Optional) The catalog of the sequence generator.
Default value:
""
Since:
JPA 2.0
int initialValue
(Optional) The value from which the sequence object is to start generating.
(Optional) The value from which the sequence object is to start generating.
Default value:
1
Since:
JPA 1.0
String name
(Required) A unique generator name that can be referenced by one or more classes to be the generator for primary key values.
(Required) A unique generator name that can be referenced by one or more classes to be the generator for primary key values.
Since:
JPA 1.0
String schema
(Optional) The schema of the sequence generator.
(Optional) The schema of the sequence generator.
Default value:
""
Since:
JPA 2.0
String sequenceName
(Optional) The name of the database sequence object from which to obtain primary key values.
(Optional) The name of the database sequence object from which to obtain primary key values.

Defaults to a provider-chosen value.

Default value:
""
Since:
JPA 1.0
This documentation page is derived (with some adjustments) from the open source JPA 2 RI (EclipseLink)
and is available under the terms of the Eclipse Public License, v. 1.0 and Eclipse Distribution License, v. 1.0.
Object Relational Mapping (ORM) JPA 2 providers include Hibernate, EclipseLink, TopLink, OpenJPA and DataNucleus.
Object DB is not an ORM JPA implementation but an Object Database for Java with built in JPA 2 support.