Hibernate ORM - hibernate-core 6.4.4.Final · org.hibernate.id.enhanced.SequenceStyleGenerator

General configuration parameters
Parameter name	Default value	Interpretation
sequence_name		The name of the sequence/table to use to store/retrieve values
initial_value	1	The initial value to be stored for the given segment; the effect in terms of storage varies based on `Optimizer` and `DatabaseStructure`
increment_size	50	The increment size for the underlying segment; the effect in terms of storage varies based on `Optimizer` and `DatabaseStructure`
optimizer	depends on defined increment size	Allows explicit definition of which optimization strategy to use
force_table_use	`false`	Allows explicit definition of which optimization strategy to use

Table configuration parameters
Parameter name	Default value	Interpretation
value_column	next_val	The name of column which holds the sequence value for the given segment

Modifier and Type	Field and Description
public static final String	ALT_SEQUENCE_PARAM
public static final String	CONFIG_SEQUENCE_PER_ENTITY_SUFFIX Specifies the suffix to use for an implicit sequence name - appended to the entity-name / collection-role
private DatabaseStructure	databaseStructure
public static final String	DEF_SEQUENCE_SUFFIX The default value for `CONFIG_SEQUENCE_PER_ENTITY_SUFFIX`
public static final String	DEF_VALUE_COLUMN The default value for `VALUE_COLUMN_PARAM`
public static final String	FORCE_TBL_PARAM A flag to force using a table as the underlying structure rather than a sequence.
private Type	identifierType
private static final CoreMessageLogger	LOG
private Optimizer	optimizer
public static final String	SEQUENCE_PARAM Indicates the name of the sequence (or table) to use.
public static final String	VALUE_COLUMN_PARAM Indicates the name of the column holding the identifier values.

Access	Constructor and Description
public	SequenceStyleGenerator()

Method Summary

Modifier and Type	Method and Description
private int	adjustIncrementSize(JdbcEnvironment jdbcEnvironment, QualifiedName sequenceName, int incrementSize, boolean physicalSequence, OptimizerDescriptor optimizationStrategy, ServiceRegistry serviceRegistry)
protected DatabaseStructure	Returns: An abstraction for the actual database structure in use (table vs. sequence). buildDatabaseStructure(Type The Hibernate type of the identifier property type, Properties The params supplied in the generator config (plus some standard useful extras). params, JdbcEnvironment The JDBC environment in which the sequence will be used. jdbcEnvironment, boolean Should a table be used even if the dialect supports sequences? forceTableUse, QualifiedName The name to use for the sequence or table. sequenceName, int The initial value. initialValue, int the increment size to use (after any adjustments). incrementSize) Build the database structure.
protected DatabaseStructure	buildSequenceStructure(Type type, Properties params, JdbcEnvironment jdbcEnvironment, QualifiedName sequenceName, int initialValue, int incrementSize)
protected DatabaseStructure	buildTableStructure(Type type, Properties params, JdbcEnvironment jdbcEnvironment, QualifiedName sequenceName, int initialValue, int incrementSize)
public void	configure(Type The id property type descriptor type, Properties param values, keyed by parameter name parameters, ServiceRegistry Access to service that may be needed. serviceRegistry) Overrides default org.hibernate.id.IdentifierGenerator.configure. Configure this instance, given the value of parameters specified by the user as `<param>` elements.
protected int	Returns: The adjusted increment size. determineAdjustedIncrementSize(OptimizerDescriptor The optimizer strategy (name) optimizationStrategy, int The `determined increment size` incrementSize) In certain cases we need to adjust the increment size based on the selected optimizer.
public String	determineBulkInsertionIdentifierGenerationSelectFragment(SqlStringGenerationContext context) Overrides default org.hibernate.id.BulkInsertionCapableIdentifierGenerator.determineBulkInsertionIdentifierGenerationSelectFragment. Return the select expression fragment, if any, that generates the identifier values.
private String	determineContributor(Properties params)
private QualifiedName	determineImplicitName(Identifier catalog, Identifier schema, Properties params, ServiceRegistry serviceRegistry)
protected int	Returns: The increment size determineIncrementSize(Properties The params supplied in the generator config (plus some standard useful extras). params) Determine the increment size to be applied.
protected int	Returns: The initial value determineInitialValue(Properties The params supplied in the generator config (plus some standard useful extras). params) Determine the initial sequence value to use.
protected OptimizerDescriptor	Returns: The optimizer strategy (name) determineOptimizationStrategy(Properties The params supplied in the generator config (plus some standard useful extras). params, int The `determined increment size` incrementSize) Determine the optimizer to use.
protected QualifiedName	Returns: The sequence name determineSequenceName(Properties The params supplied in the generator config (plus some standard useful extras). params, Dialect The dialect in effect dialect, JdbcEnvironment The JdbcEnvironment jdbcEnv, ServiceRegistry serviceRegistry) Determine the name of the sequence (or table if this resolves to a physical table) to use.
protected Identifier	Returns: The value column name determineValueColumnName(Properties The params supplied in the generator config (plus some standard useful extras). params, JdbcEnvironment The JDBC environment jdbcEnvironment) Determine the name of the column used to store the generator value in the db.
public Object	generate(SharedSessionContractImplementor The session from which the request originates session, Object the entity or collection (idbag) for which the id is being generated object) Implements org.hibernate.id.IdentifierGenerator.generate. Generate a new identifier.
public DatabaseStructure	Returns: Value for property 'databaseStructure'. getDatabaseStructure() Getter for property 'databaseStructure'.
public Type	Returns: Value for property 'identifierType'. getIdentifierType() Getter for property 'identifierType'.
public Optimizer	Returns: Value for property 'optimizer'. getOptimizer() Implements org.hibernate.id.OptimizableGenerator.getOptimizer. Getter for property 'optimizer'.
private Number	Returns: sequence increment value getSequenceIncrementValue(JdbcEnvironment the current JdbcEnvironment jdbcEnvironment, String sequence name sequenceName) Get the database sequence increment value from the associated `SequenceInformation` object.
public void	initialize(SqlStringGenerationContext A context to help generate SQL strings context) Overrides default org.hibernate.id.IdentifierGenerator.initialize. Initializes this instance, in particular pre-generates SQL as necessary.
protected boolean	isPhysicalSequence(JdbcEnvironment jdbcEnvironment, boolean forceTableUse)
public void	registerExportables(Database The database instance database) Overrides default org.hibernate.id.IdentifierGenerator.registerExportables. Implements org.hibernate.boot.model.relational.ExportableProducer.registerExportables. Register database objects used by this identifier generator, for example, a sequence or tables.
public boolean	supportsBulkInsertionIdentifierGeneration() Overrides default org.hibernate.id.BulkInsertionCapableIdentifierGenerator.supportsBulkInsertionIdentifierGeneration. Given the configuration of this generator, is identifier generation as part of bulk insertion supported?

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

ALT_SEQUENCE_PARAM	back to summary
public static final String ALT_SEQUENCE_PARAM

CONFIG_SEQUENCE_PER_ENTITY_SUFFIX	back to summary
public static final String CONFIG_SEQUENCE_PER_ENTITY_SUFFIX Specifies the suffix to use for an implicit sequence name - appended to the entity-name / collection-role

databaseStructure	back to summary
private DatabaseStructure databaseStructure

DEF_SEQUENCE_SUFFIX	back to summary
public static final String DEF_SEQUENCE_SUFFIX The default value for `CONFIG_SEQUENCE_PER_ENTITY_SUFFIX`

DEF_VALUE_COLUMN	back to summary
public static final String DEF_VALUE_COLUMN The default value for `VALUE_COLUMN_PARAM`

FORCE_TBL_PARAM	back to summary
public static final String FORCE_TBL_PARAM A flag to force using a table as the underlying structure rather than a sequence.

identifierType	back to summary
private Type identifierType

LOG	back to summary
private static final CoreMessageLogger LOG

optimizer	back to summary
private Optimizer optimizer

SEQUENCE_PARAM	back to summary
public static final String SEQUENCE_PARAM Indicates the name of the sequence (or table) to use. The implicit value is based on the entity / collection-role name

VALUE_COLUMN_PARAM	back to summary
public static final String VALUE_COLUMN_PARAM Indicates the name of the column holding the identifier values. The default value is next_val

SequenceStyleGenerator	back to summary
public SequenceStyleGenerator()

Method Detail

adjustIncrementSize	back to summary
private int adjustIncrementSize(JdbcEnvironment jdbcEnvironment, QualifiedName sequenceName, int incrementSize, boolean physicalSequence, OptimizerDescriptor optimizationStrategy, ServiceRegistry serviceRegistry)

buildDatabaseStructure	back to summary
protected DatabaseStructure buildDatabaseStructure(Type type, Properties params, JdbcEnvironment jdbcEnvironment, boolean forceTableUse, QualifiedName sequenceName, int initialValue, int incrementSize) Build the database structure. Parameters type:Type The Hibernate type of the identifier property params:Properties The params supplied in the generator config (plus some standard useful extras). jdbcEnvironment:JdbcEnvironment The JDBC environment in which the sequence will be used. forceTableUse:boolean Should a table be used even if the dialect supports sequences? sequenceName:QualifiedName The name to use for the sequence or table. initialValue:int The initial value. incrementSize:int the increment size to use (after any adjustments). Returns:DatabaseStructure An abstraction for the actual database structure in use (table vs. sequence).

buildDatabaseStructure

back to summary

protected DatabaseStructure buildDatabaseStructure(Type type, Properties params, JdbcEnvironment jdbcEnvironment, boolean forceTableUse, QualifiedName sequenceName, int initialValue, int incrementSize)

Build the database structure.

Parameters

type:Type: The Hibernate type of the identifier property
params:Properties: The params supplied in the generator config (plus some standard useful extras).
jdbcEnvironment:JdbcEnvironment: The JDBC environment in which the sequence will be used.
forceTableUse:boolean: Should a table be used even if the dialect supports sequences?
sequenceName:QualifiedName: The name to use for the sequence or table.
initialValue:int: The initial value.
incrementSize:int: the increment size to use (after any adjustments).

Returns:DatabaseStructure

An abstraction for the actual database structure in use (table vs. sequence).

buildSequenceStructure	back to summary
protected DatabaseStructure buildSequenceStructure(Type type, Properties params, JdbcEnvironment jdbcEnvironment, QualifiedName sequenceName, int initialValue, int incrementSize)

buildTableStructure	back to summary
protected DatabaseStructure buildTableStructure(Type type, Properties params, JdbcEnvironment jdbcEnvironment, QualifiedName sequenceName, int initialValue, int incrementSize)

configure back to summary

configure	back to summary
public void configure(Type type, Properties parameters, ServiceRegistry serviceRegistry) throws MappingException Overrides default org.hibernate.id.IdentifierGenerator.configure. Doc from org.hibernate.id.IdentifierGenerator.configure. Configure this instance, given the value of parameters specified by the user as `<param>` elements. This method is called just once, following instantiation, and before `registerExportables(Database)`. Parameters type:Type The id property type descriptor parameters:Properties param values, keyed by parameter name serviceRegistry:ServiceRegistry Access to service that may be needed. Annotations @Override

public void configure(Type type, Properties parameters, ServiceRegistry serviceRegistry) throws MappingException

Overrides default org.hibernate.id.IdentifierGenerator.configure.

Doc from org.hibernate.id.IdentifierGenerator.configure.

Configure this instance, given the value of parameters specified by the user as <param> elements.

This method is called just once, following instantiation, and before registerExportables(Database).

Parameters

type:Type: The id property type descriptor
parameters:Properties: param values, keyed by parameter name
serviceRegistry:ServiceRegistry: Access to service that may be needed.

Annotations

@Override

determineAdjustedIncrementSize back to summary

determineAdjustedIncrementSize	back to summary
protected int determineAdjustedIncrementSize(OptimizerDescriptor optimizationStrategy, int incrementSize) In certain cases we need to adjust the increment size based on the selected optimizer. This is the hook to achieve that. Parameters optimizationStrategy:OptimizerDescriptor The optimizer strategy (name) incrementSize:int The `determined increment size` Returns:int The adjusted increment size.

protected int determineAdjustedIncrementSize(OptimizerDescriptor optimizationStrategy, int incrementSize)

In certain cases we need to adjust the increment size based on the selected optimizer. This is the hook to achieve that.

Parameters

optimizationStrategy:OptimizerDescriptor: The optimizer strategy (name)
incrementSize:int: The determined increment size

Returns:int

The adjusted increment size.

determineBulkInsertionIdentifierGenerationSelectFragment back to summary

determineBulkInsertionIdentifierGenerationSelectFragment	back to summary
public String determineBulkInsertionIdentifierGenerationSelectFragment(SqlStringGenerationContext context) Overrides default org.hibernate.id.BulkInsertionCapableIdentifierGenerator.determineBulkInsertionIdentifierGenerationSelectFragment. Doc from org.hibernate.id.BulkInsertionCapableIdentifierGenerator.determineBulkInsertionIdentifierGenerationSelectFragment. Return the select expression fragment, if any, that generates the identifier values. Returns:String The identifier value generation fragment (SQL). `null` indicates that no fragment is needed. Annotations @Override

public String determineBulkInsertionIdentifierGenerationSelectFragment(SqlStringGenerationContext context)

Overrides default org.hibernate.id.BulkInsertionCapableIdentifierGenerator.determineBulkInsertionIdentifierGenerationSelectFragment.

Doc from org.hibernate.id.BulkInsertionCapableIdentifierGenerator.determineBulkInsertionIdentifierGenerationSelectFragment.

Return the select expression fragment, if any, that generates the identifier values.

Returns:String

The identifier value generation fragment (SQL). null indicates that no fragment is needed.

Annotations

@Override

determineContributor	back to summary
private String determineContributor(Properties params)

determineImplicitName	back to summary
private QualifiedName determineImplicitName(Identifier catalog, Identifier schema, Properties params, ServiceRegistry serviceRegistry)

determineIncrementSize	back to summary
protected int determineIncrementSize(Properties params) Determine the increment size to be applied. The exact implications of this value depends on the optimizer being used. Called during configuration. Parameters params:Properties The params supplied in the generator config (plus some standard useful extras). Returns:int The increment size

determineIncrementSize

back to summary

protected int determineIncrementSize(Properties params)

Determine the increment size to be applied. The exact implications of this value depends on the optimizer being used.

Called during configuration.

Parameters

params:Properties: The params supplied in the generator config (plus some standard useful extras).

Returns:int

The increment size

determineInitialValue back to summary

determineInitialValue	back to summary
protected int determineInitialValue(Properties params) Determine the initial sequence value to use. This value is used when initializing the `database structure` (i.e. sequence/table). Called during configuration. Parameters params:Properties The params supplied in the generator config (plus some standard useful extras). Returns:int The initial value

protected int determineInitialValue(Properties params)

Determine the initial sequence value to use. This value is used when initializing the database structure (i.e. sequence/table).

Called during configuration.

Parameters

params:Properties: The params supplied in the generator config (plus some standard useful extras).

Returns:int

The initial value

determineOptimizationStrategy back to summary

determineOptimizationStrategy	back to summary
protected OptimizerDescriptor determineOptimizationStrategy(Properties params, int incrementSize) Determine the optimizer to use. Called during configuration. Parameters params:Properties The params supplied in the generator config (plus some standard useful extras). incrementSize:int The `determined increment size` Returns:OptimizerDescriptor The optimizer strategy (name)

protected OptimizerDescriptor determineOptimizationStrategy(Properties params, int incrementSize)

Determine the optimizer to use.

Called during configuration.

Parameters

params:Properties: The params supplied in the generator config (plus some standard useful extras).
incrementSize:int: The determined increment size

Returns:OptimizerDescriptor

The optimizer strategy (name)

determineSequenceName	back to summary
protected QualifiedName determineSequenceName(Properties params, Dialect dialect, JdbcEnvironment jdbcEnv, ServiceRegistry serviceRegistry) Determine the name of the sequence (or table if this resolves to a physical table) to use. Called during configuration. Parameters params:Properties The params supplied in the generator config (plus some standard useful extras). dialect:Dialect The dialect in effect jdbcEnv:JdbcEnvironment The JdbcEnvironment Returns:QualifiedName The sequence name Annotations @SuppressWarnings:UnusedParameters

determineSequenceName

back to summary

protected QualifiedName determineSequenceName(Properties params, Dialect dialect, JdbcEnvironment jdbcEnv, ServiceRegistry serviceRegistry)

Determine the name of the sequence (or table if this resolves to a physical table) to use.

Called during configuration.

Parameters

params:Properties: The params supplied in the generator config (plus some standard useful extras).
dialect:Dialect: The dialect in effect
jdbcEnv:JdbcEnvironment: The JdbcEnvironment

Returns:QualifiedName

The sequence name

Annotations

@SuppressWarnings:UnusedParameters

determineValueColumnName	back to summary
protected Identifier determineValueColumnName(Properties params, JdbcEnvironment jdbcEnvironment) Determine the name of the column used to store the generator value in the db. Called during configuration when resolving to a physical table. Parameters params:Properties The params supplied in the generator config (plus some standard useful extras). jdbcEnvironment:JdbcEnvironment The JDBC environment Returns:Identifier The value column name

determineValueColumnName

back to summary

protected Identifier determineValueColumnName(Properties params, JdbcEnvironment jdbcEnvironment)

Determine the name of the column used to store the generator value in the db.

Called during configuration when resolving to a physical table.

Parameters

params:Properties: The params supplied in the generator config (plus some standard useful extras).
jdbcEnvironment:JdbcEnvironment: The JDBC environment

Returns:Identifier

The value column name

generate	back to summary
public Object generate(SharedSessionContractImplementor session, Object object) throws HibernateException Implements org.hibernate.id.IdentifierGenerator.generate. Doc from org.hibernate.id.IdentifierGenerator.generate. Generate a new identifier. Parameters session:SharedSessionContractImplementor The session from which the request originates object:Object the entity or collection (idbag) for which the id is being generated Returns:Object a new identifier Annotations @Override Exceptions HibernateException: Indicates trouble generating the identifier

generate

back to summary

public Object generate(SharedSessionContractImplementor session, Object object) throws HibernateException

Implements org.hibernate.id.IdentifierGenerator.generate.

Doc from org.hibernate.id.IdentifierGenerator.generate.

Generate a new identifier.

Parameters

session:SharedSessionContractImplementor: The session from which the request originates
object:Object: the entity or collection (idbag) for which the id is being generated

Returns:Object

a new identifier

Annotations

@Override

Exceptions

HibernateException:: Indicates trouble generating the identifier

getDatabaseStructure	back to summary
public DatabaseStructure getDatabaseStructure() Getter for property 'databaseStructure'. Returns:DatabaseStructure Value for property 'databaseStructure'.

getDatabaseStructure

back to summary

public DatabaseStructure getDatabaseStructure()

Getter for property 'databaseStructure'.

Returns:DatabaseStructure: Value for property 'databaseStructure'.

getIdentifierType	back to summary
public Type getIdentifierType() Getter for property 'identifierType'. Returns:Type Value for property 'identifierType'.

getIdentifierType

back to summary

public Type getIdentifierType()

Getter for property 'identifierType'.

Returns:Type: Value for property 'identifierType'.

getOptimizer	back to summary
public Optimizer getOptimizer() Implements org.hibernate.id.OptimizableGenerator.getOptimizer. Getter for property 'optimizer'. Returns:Optimizer Value for property 'optimizer'. Annotations @Override

getOptimizer

back to summary

public Optimizer getOptimizer()

Implements org.hibernate.id.OptimizableGenerator.getOptimizer.

Getter for property 'optimizer'.

Returns:Optimizer

Value for property 'optimizer'.

Annotations

@Override

getSequenceIncrementValue back to summary

getSequenceIncrementValue	back to summary
private Number getSequenceIncrementValue(JdbcEnvironment jdbcEnvironment, String sequenceName) Get the database sequence increment value from the associated `SequenceInformation` object. Parameters jdbcEnvironment:JdbcEnvironment the current JdbcEnvironment sequenceName:String sequence name Returns:Number sequence increment value

private Number getSequenceIncrementValue(JdbcEnvironment jdbcEnvironment, String sequenceName)

Get the database sequence increment value from the associated SequenceInformation object.

Parameters

jdbcEnvironment:JdbcEnvironment: the current JdbcEnvironment
sequenceName:String: sequence name

Returns:Number

sequence increment value

initialize back to summary

initialize	back to summary
public void initialize(SqlStringGenerationContext context) Overrides default org.hibernate.id.IdentifierGenerator.initialize. Doc from org.hibernate.id.IdentifierGenerator.initialize. Initializes this instance, in particular pre-generates SQL as necessary. This method is called after `registerExportables(Database)`, and before first use. Parameters context:SqlStringGenerationContext A context to help generate SQL strings Annotations @Override

public void initialize(SqlStringGenerationContext context)

Overrides default org.hibernate.id.IdentifierGenerator.initialize.

Doc from org.hibernate.id.IdentifierGenerator.initialize.

Initializes this instance, in particular pre-generates SQL as necessary.

This method is called after registerExportables(Database), and before first use.

Parameters

context:SqlStringGenerationContext: A context to help generate SQL strings

Annotations

@Override

isPhysicalSequence	back to summary
protected boolean isPhysicalSequence(JdbcEnvironment jdbcEnvironment, boolean forceTableUse)

registerExportables back to summary

registerExportables	back to summary
public void registerExportables(Database database) Overrides default org.hibernate.id.IdentifierGenerator.registerExportables. Implements org.hibernate.boot.model.relational.ExportableProducer.registerExportables. Doc from org.hibernate.id.IdentifierGenerator.registerExportables. Register database objects used by this identifier generator, for example, a sequence or tables. This method is called just once, after `configure(Type, Properties, ServiceRegistry)`. Parameters database:Database The database instance Annotations @Override

public void registerExportables(Database database)

Overrides default org.hibernate.id.IdentifierGenerator.registerExportables.

Implements org.hibernate.boot.model.relational.ExportableProducer.registerExportables.

Doc from org.hibernate.id.IdentifierGenerator.registerExportables.

This method is called just once, after configure(Type, Properties, ServiceRegistry).

Parameters

database:Database: The database instance

Annotations

@Override

supportsBulkInsertionIdentifierGeneration back to summary

supportsBulkInsertionIdentifierGeneration	back to summary
public boolean supportsBulkInsertionIdentifierGeneration() Overrides default org.hibernate.id.BulkInsertionCapableIdentifierGenerator.supportsBulkInsertionIdentifierGeneration. Doc from org.hibernate.id.BulkInsertionCapableIdentifierGenerator.supportsBulkInsertionIdentifierGeneration. Given the configuration of this generator, is identifier generation as part of bulk insertion supported? Returns:boolean `true` if bulk insertions are supported; `false` otherwise. Annotations @Override

public boolean supportsBulkInsertionIdentifierGeneration()

Overrides default org.hibernate.id.BulkInsertionCapableIdentifierGenerator.supportsBulkInsertionIdentifierGeneration.

Doc from org.hibernate.id.BulkInsertionCapableIdentifierGenerator.supportsBulkInsertionIdentifierGeneration.

Given the configuration of this generator, is identifier generation as part of bulk insertion supported?

Returns:boolean

true if bulk insertions are supported; false otherwise.

Annotations

@Override

public Class SequenceStyleGenerator

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail