Package javax.persistence
Annotation Interface SequenceGenerator
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:
- Java Persistence 1.0
-
Required Element Summary
-
Optional Element Summary
Modifier and TypeOptional ElementDescriptionint
(Optional) The amount to increment by when allocating sequence numbers from the sequence.(Optional) The catalog of the sequence generator.int
(Optional) The value from which the sequence object is to start generating.(Optional) The schema of the sequence generator.(Optional) The name of the database sequence object from which to obtain primary key values.
-
Element Details
-
name
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
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
String catalog(Optional) The catalog of the sequence generator.- Since:
- Java Persistence 2.0
- Default:
- ""
-
schema
String schema(Optional) The schema of the sequence generator.- Since:
- Java Persistence 2.0
- Default:
- ""
-
initialValue
int initialValue(Optional) The value from which the sequence object is to start generating.- Default:
- 1
-
allocationSize
int allocationSize(Optional) The amount to increment by when allocating sequence numbers from the sequence.- Default:
- 50
-