Interface StateManagementSettings

@Incubating(since="7.4")
public interface StateManagementSettings

Settings related to customized state management, temporal entities, and audited entities.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	AUDIT_STRATEGY	Specifies the audit strategy for audited entities.
static final String	CHANGESET_ID_SUPPLIER	Specify a ChangesetIdentifierSupplier which provides unique, monotonically increasing changeset ids for temporal data when using the TemporalTableStrategy.SINGLE_TABLE or TemporalTableStrategy.HISTORY_TABLE mapping strategy or for audited data.
static final String	TEMPORAL_TABLE_STRATEGY	Specifies the implementation strategy for temporal tables.
static final String	USE_SERVER_TRANSACTION_TIMESTAMPS	Use transaction timestamps supplied by the database server's current_timestamp function instead of Instant.now() to initialize the effectivity columns for temporal data when using the TemporalTableStrategy.SINGLE_TABLE or TemporalTableStrategy.HISTORY_TABLE mapping strategy.

Field Details

TEMPORAL_TABLE_STRATEGY

static final String TEMPORAL_TABLE_STRATEGY

Specifies the implementation strategy for temporal tables.

Accepts any of:

• an instance of TemporalTableStrategy, or
• the (case-insensitive) name of a TemporalTableStrategy, for example, native, single_time, or history_table.

Since:

7.4

See Also:

• Temporal
• TemporalTableStrategy
• Constant Field Values

Default Value:

TemporalTableStrategy.SINGLE_TABLE

USE_SERVER_TRANSACTION_TIMESTAMPS

static final String USE_SERVER_TRANSACTION_TIMESTAMPS

Use transaction timestamps supplied by the database server's current_timestamp function instead of Instant.now() to initialize the effectivity columns for temporal data when using the TemporalTableStrategy.SINGLE_TABLE or TemporalTableStrategy.HISTORY_TABLE mapping strategy.

Not recommended on database platforms with no way to obtain the timestamp of the start of the current transaction (most database except PostgreSQL-like databases).

This option cannot be used together with "hibernate.temporal.changeset_id_supplier".

By default, transaction timestamps are generated in memory.

Since:

7.4

See Also:

• Temporal
• Constant Field Values

Default Value:

false

CHANGESET_ID_SUPPLIER

static final String CHANGESET_ID_SUPPLIER

Specify a ChangesetIdentifierSupplier which provides unique, monotonically increasing changeset ids for temporal data when using the TemporalTableStrategy.SINGLE_TABLE or TemporalTableStrategy.HISTORY_TABLE mapping strategy or for audited data. A plain Supplier is also accepted for backward compatibility.

The Java type of the changeset id is inferred from the type argument T in the instantiation of ChangesetIdentifierSupplier<T> implemented by the supplier class, and is used instead of Instant for the effectivity column mappings.

By default, changeset ids are timestamps generated using Instant.now().

This option cannot be used together with "hibernate.temporal.use_server_transaction_timestamps".

Since:

7.4

See Also:

• Temporal
• Audited
• ChangesetCoordinator
• ChangesetIdentifierSupplier
• Constant Field Values

AUDIT_STRATEGY

@Incubating(since="8.0")
static final String AUDIT_STRATEGY

Specifies the audit strategy for audited entities.

Accepts any of:

• an instance of AuditStrategy, or
• the (case-insensitive) name of an AuditStrategy, for example, default or validity.

The available strategies are:

• default: each point-in-time query uses a MAX(REV) subquery to find the current audit row (no additional schema requirements), or
• validity: each audit row carries a REVEND column marking when it was superseded; point-in-time queries use a simple range predicate (REV <= :changesetId AND (REVEND > :changesetId OR REVEND IS NULL)) instead of a subquery, which is significantly faster for large audit tables.

Since:

7.4

See Also:

• Audited
• AuditStrategy
• Constant Field Values

Default Value:

AuditStrategy.DEFAULT