Package io.quarkus.hibernate.envers

Interface HibernateEnversBuildTimeConfigPersistenceUnit

public interface HibernateEnversBuildTimeConfigPersistenceUnit

  • Method Details

    • active

      @ConfigDocDefault("\'true\' if Hibernate ORM is enabled; \'false\' otherwise") Optional<Boolean> active()
      Whether Hibernate Envers should be active for this persistence unit at runtime. If Hibernate Envers is not active, the audit entities will *still* be added to the Hibernate ORM metamodel and to the database schema that Hibernate ORM generates: you would need to disable Hibernate Envers at build time (i.e. set `quarkus.hibernate-envers.enabled` to `false`) in order to avoid that. However, when Hibernate Envers is not active, it will not process entity change events nor create new versions of entities. and accessing the AuditReader through AuditReaderFactory will not be possible. Note that if Hibernate Envers is disabled (i.e. `quarkus.hibernate-envers.enabled` is set to `false`), it won't be active for any persistence unit, and setting this property to `true` will fail.

    • storeDataAtDelete

      @WithDefault("false") boolean storeDataAtDelete()
      Enable store_data_at_delete feature. Maps to EnversSettings.STORE_DATA_AT_DELETE.

    • auditTableSuffix

      @WithDefault("_AUD") Optional<String> auditTableSuffix()
      Defines a suffix for historical data table. Defaults to _AUD. Maps to EnversSettings.AUDIT_TABLE_SUFFIX.

    • auditTablePrefix

      @WithDefault("") Optional<String> auditTablePrefix()
      Defines a prefix for historical data table. Default is the empty string. Maps to EnversSettings.AUDIT_TABLE_PREFIX.

    • revisionFieldName

      @WithDefault("REV") Optional<String> revisionFieldName()
      Revision field name. Defaults to REV. Maps to EnversSettings.REVISION_FIELD_NAME.

    • revisionTypeFieldName

      @WithDefault("REVTYPE") Optional<String> revisionTypeFieldName()
      Revision type field name. Defaults to REVTYPE. Maps to EnversSettings.REVISION_TYPE_FIELD_NAME.

    • revisionOnCollectionChange

      @WithDefault("true") boolean revisionOnCollectionChange()
      Enable the revision_on_collection_change feature. Maps to EnversSettings.REVISION_ON_COLLECTION_CHANGE.

    • doNotAuditOptimisticLockingField

      @WithDefault("true") boolean doNotAuditOptimisticLockingField()
      Enable the do_not_audit_optimistic_locking_field feature. Maps to EnversSettings.DO_NOT_AUDIT_OPTIMISTIC_LOCKING_FIELD.

    • defaultSchema

      @WithDefault("") Optional<String> defaultSchema()
      Defines the default schema of where audit tables are to be created. Maps to EnversSettings.DEFAULT_SCHEMA.

    • defaultCatalog

      @WithDefault("") Optional<String> defaultCatalog()
      Defines the default catalog of where audit tables are to be created. Maps to EnversSettings.DEFAULT_CATALOG.

    • trackEntitiesChangedInRevision

      @WithDefault("false") boolean trackEntitiesChangedInRevision()
      Enables the track_entities_changed_in_revision feature. Maps to EnversSettings.TRACK_ENTITIES_CHANGED_IN_REVISION.

    • useRevisionEntityWithNativeId

      @WithDefault("true") boolean useRevisionEntityWithNativeId()
      Enables the use_revision_entity_with_native_id feature. Maps to EnversSettings.USE_REVISION_ENTITY_WITH_NATIVE_ID.

    • globalWithModifiedFlag

      @WithDefault("false") boolean globalWithModifiedFlag()
      Enables the global_with_modified_flag feature. Maps to EnversSettings.GLOBAL_WITH_MODIFIED_FLAG.

    • modifiedFlagSuffix

      @WithDefault("_MOD") Optional<String> modifiedFlagSuffix()
      Defines the suffix to be used for modified flag columns. Defaults to _MOD. Maps to EnversSettings.MODIFIED_FLAG_SUFFIX

    • revisionListener

      Optional<String> revisionListener()
      Defines the fully qualified class name of a user defined revision listener. Maps to EnversSettings.REVISION_LISTENER.

    • auditStrategy

      @WithDefault("org.hibernate.envers.strategy.DefaultAuditStrategy") Optional<String> auditStrategy()
      Defines the fully qualified class name of the audit strategy to be used. Maps to EnversSettings.AUDIT_STRATEGY.

    • originalIdPropName

      @WithDefault("originalId") Optional<String> originalIdPropName()
      Defines the property name for the audit entity's composite primary key. Defaults to originalId. Maps to EnversSettings.ORIGINAL_ID_PROP_NAME.

    • auditStrategyValidityEndRevFieldName

      @WithDefault("REVEND") Optional<String> auditStrategyValidityEndRevFieldName()
      Defines the column name that holds the end revision number in audit entities. Defaults to REVEND. Maps to EnversSettings.AUDIT_STRATEGY_VALIDITY_END_REV_FIELD_NAME.

    • auditStrategyValidityStoreRevendTimestamp

      @WithDefault("false") boolean auditStrategyValidityStoreRevendTimestamp()
      Enables the audit_strategy_validity_store_revend_timestamp feature. Maps to EnversSettings.AUDIT_STRATEGY_VALIDITY_STORE_REVEND_TIMESTAMP.

    • auditStrategyValidityRevendTimestampFieldName

      @WithDefault("REVEND_TSTMP") Optional<String> auditStrategyValidityRevendTimestampFieldName()
      Defines the column name of the revision end timestamp in the audit tables. Defaults to REVEND_TSTMP. Maps to EnversSettings.AUDIT_STRATEGY_VALIDITY_REVEND_TIMESTAMP_FIELD_NAME.

    • embeddableSetOrdinalFieldName

      @WithDefault("SETORDINAL") Optional<String> embeddableSetOrdinalFieldName()
      Defines the name of the column used for storing collection ordinal values for embeddable elements. Defaults to SETORDINAL. Maps to EnversSettings.EMBEDDABLE_SET_ORDINAL_FIELD_NAME.

    • allowIdentifierReuse

      @WithDefault("false") boolean allowIdentifierReuse()
      Enables the allow_identifier_reuse feature. Maps to EnversSettings.ALLOW_IDENTIFIER_REUSE.

    • modifiedColumnNamingStrategy

      @WithDefault("org.hibernate.envers.boot.internal.LegacyModifiedColumnNamingStrategy") Optional<String> modifiedColumnNamingStrategy()
      Defines the naming strategy to be used for modified columns. Defaults to org.hibernate.envers.boot.internal.LegacyModifiedColumnNamingStrategy. Maps to EnversSettings.MODIFIED_COLUMN_NAMING_STRATEGY.