jakarta.persistence

Annotation Type SequenceGenerator

@Repeatable(value=SequenceGenerators.class)
 @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 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:

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:

2.0

Default:

""

schema

public abstract String schema

(Optional) The schema of the sequence generator.

Since:

2.0

Default:

""

initialValue

public abstract int initialValue

(Optional) The value from which the sequence object is to start generating.

Default:

1

allocationSize

public abstract int allocationSize

(Optional) The amount to increment by when allocating sequence numbers from the sequence.

Default:

50