Package org.hibernate.envers.configuration

Interface EnversSettings

public interface EnversSettings
Configuration property names.

  • Field Details

    • REVISION_ON_COLLECTION_CHANGE

      static final String REVISION_ON_COLLECTION_CHANGE
      Triggers revision generation when not-owned relation field changes. Defaults to true.
      See Also:

    • DO_NOT_AUDIT_OPTIMISTIC_LOCKING_FIELD

      static final String DO_NOT_AUDIT_OPTIMISTIC_LOCKING_FIELD
      Treats optimistic locking properties as unversioned. Defaults to true.
      See Also:

    • STORE_DATA_AT_DELETE

      static final String STORE_DATA_AT_DELETE
      Indicates whether entity data should be stored during removal. Defaults to false.
      See Also:

    • DEFAULT_SCHEMA

      static final String DEFAULT_SCHEMA
      Default name of the schema containing audit tables.
      See Also:

    • DEFAULT_CATALOG

      static final String DEFAULT_CATALOG
      Default name of the catalog containing audit tables.
      See Also:

    • TRACK_ENTITIES_CHANGED_IN_REVISION

      static final String TRACK_ENTITIES_CHANGED_IN_REVISION
      Track entity names that have been changed during each revision. Defaults to false.
      See Also:

    • USE_REVISION_ENTITY_WITH_NATIVE_ID

      static final String USE_REVISION_ENTITY_WITH_NATIVE_ID
      Use revision entity with native identifier generator. Defaults to true for backward compatibility.
      See Also:

    • GLOBAL_WITH_MODIFIED_FLAG

      static final String GLOBAL_WITH_MODIFIED_FLAG
      Globally activates modified properties flag feature. Defaults to false.
      See Also:

    • MODIFIED_FLAG_SUFFIX

      static final String MODIFIED_FLAG_SUFFIX
      Suffix of modified flag columns. Defaults to _MOD.
      See Also:

    • REVISION_LISTENER

      static final String REVISION_LISTENER
      Fully qualified class name of user defined revision listener.
      See Also:

    • AUDIT_TABLE_PREFIX

      static final String AUDIT_TABLE_PREFIX
      Audit table prefix. Empty by default.
      See Also:

    • AUDIT_TABLE_SUFFIX

      static final String AUDIT_TABLE_SUFFIX
      Audit table suffix. Defaults to _AUD.
      See Also:

    • AUDIT_STRATEGY

      static final String AUDIT_STRATEGY
      Audit strategy. Defaults to DefaultAuditStrategy.
      See Also:

    • REVISION_FIELD_NAME

      static final String REVISION_FIELD_NAME
      Revision field name. Defaults to REV.
      See Also:

    • REVISION_TYPE_FIELD_NAME

      static final String REVISION_TYPE_FIELD_NAME
      Revision type field name. Defaults to REVTYPE.
      See Also:

    • ORIGINAL_ID_PROP_NAME

      static final String ORIGINAL_ID_PROP_NAME
      Original id property name name. Defaults to originalId.
      See Also:

    • AUDIT_STRATEGY_VALIDITY_END_REV_FIELD_NAME

      static final String AUDIT_STRATEGY_VALIDITY_END_REV_FIELD_NAME
      Column name that will hold the end revision number in audit entities. Defaults to REVEND.
      See Also:

    • AUDIT_STRATEGY_VALIDITY_STORE_REVEND_TIMESTAMP

      static final String AUDIT_STRATEGY_VALIDITY_STORE_REVEND_TIMESTAMP
      Store the timestamp of the end revision, until which the data was valid, in addition to the end revision itself. Defaults to false.
      See Also:

    • AUDIT_STRATEGY_VALIDITY_REVEND_TIMESTAMP_FIELD_NAME

      static final String AUDIT_STRATEGY_VALIDITY_REVEND_TIMESTAMP_FIELD_NAME
      Column name of the timestamp of the end revision until which the data was valid. Defaults to REVEND_TSTMP.
      See Also:

    • AUDIT_STRATEGY_VALIDITY_REVEND_TIMESTAMP_NUMERIC

      static final String AUDIT_STRATEGY_VALIDITY_REVEND_TIMESTAMP_NUMERIC
      Determines whether the timestamp of the end revision is stored as a numeric data type. Defaults to false.
      Since:
      6.0
      See Also:

    • AUDIT_STRATEGY_VALIDITY_REVEND_TIMESTAMP_LEGACY_PLACEMENT

      static final String AUDIT_STRATEGY_VALIDITY_REVEND_TIMESTAMP_LEGACY_PLACEMENT
      Whether to use legacy validity audit strategy revision end timestamp behavior where the field is not included as part of the joined entity inheritance subclass audit tables. Defaults to true.
      Since:
      6.0
      See Also:

    • EMBEDDABLE_SET_ORDINAL_FIELD_NAME

      static final String EMBEDDABLE_SET_ORDINAL_FIELD_NAME
      Name of column used for storing ordinal of the change in sets of embeddable elements. Defaults to SETORDINAL.
      See Also:

    • ALLOW_IDENTIFIER_REUSE

      static final String ALLOW_IDENTIFIER_REUSE
      Guarantees proper validity audit strategy behavior when application reuses identifiers of deleted entities. Exactly one row with null end date exists for each identifier.
      See Also:

    • FIND_BY_REVISION_EXACT_MATCH

      static final String FIND_BY_REVISION_EXACT_MATCH
      Forces AuditReader#find implementations that accept a revision-number argument to perform an exact match against the supplied revision number rather than potentially returning hits that are less-than or equal-to the supplied revision number. This option is meant to maintain backward compatibility while attempting to correct a bug in behavior without impacting existing users who may use the current behavior. Defaults to false.
      Since:
      5.4.4
      See Also:

    • MODIFIED_COLUMN_NAMING_STRATEGY

      static final String MODIFIED_COLUMN_NAMING_STRATEGY
      Specifies the ModifiedColumnNamingStrategy to use Defaults to LegacyModifiedColumnNamingStrategy.
      Since:
      5.4.7
      See Also:

    • CASCADE_DELETE_REVISION

      static final String CASCADE_DELETE_REVISION
      Deletion of a revision entity will cause a foreign key constraint database error when at least one audit record exists for that revision. By enabling this feature, deletion of the revision entity will also force all audit records associated to that revision to be deleted via cascade. Defaults to false.
      Since:
      4.3.0
      See Also:

    • GLOBAL_RELATION_NOT_FOUND_LEGACY_FLAG

      static final String GLOBAL_RELATION_NOT_FOUND_LEGACY_FLAG
      Globally defines whether legacy relation not-found behavior should be used or not. Defaults to true. By specifying true, any EntityNotFoundException will be thrown unless the containing class or property explicitly specifies that use case to be ignored. Conversely, when specifying the value false, the inverse applies and requires explicitly specifying the use case as error so that the exception is thrown.
      See Also:

    • REVISION_SEQUENCE_NOCACHE

      @Internal static final String REVISION_SEQUENCE_NOCACHE
      Whether to apply a nocache configuration for the revision sequence. This is mostly interesting for testing.
      See Also: