Package jakarta.persistence

Annotation Type SequenceGenerator

  • @Repeatable(SequenceGenerators.class)
@Target({TYPE,METHOD,FIELD})
@Retention(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 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 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

        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:
        2.0
        Default:
        ""

      • schema

        String schema
        (Optional) The schema of the sequence generator.
        Since:
        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