Package org.hibernate.cfg

Interface AvailableSettings

All Superinterfaces:

BatchSettings, BytecodeSettings, C3p0Settings, CacheSettings, EnvironmentSettings, FetchSettings, JdbcSettings, JpaComplianceSettings, ManagedBeanSettings, MappingSettings, MultiTenancySettings, PersistenceSettings, ProxoolSettings, QuerySettings, SchemaToolingSettings, SessionEventSettings, StatisticsSettings, TransactionSettings, ValidationSettings

All Known Implementing Classes:

Environment

public interface AvailableSettings
extends BatchSettings, BytecodeSettings, CacheSettings, EnvironmentSettings, FetchSettings, JdbcSettings, JpaComplianceSettings, ManagedBeanSettings, MappingSettings, MultiTenancySettings, PersistenceSettings, QuerySettings, SchemaToolingSettings, SessionEventSettings, StatisticsSettings, TransactionSettings, ValidationSettings

Enumerates the configuration properties supported by Hibernate, including properties defined by the JPA specification.

The settings defined here may be specified at configuration time:

• in a configuration file, for example, in persistence.xml or hibernate.cfg.xml,
• via Configuration.setProperty(String, String), or
• via StandardServiceRegistryBuilder.applySetting(String, Object).

Note that Hibernate does not distinguish between JPA-defined configuration properties and "native" configuration properties. Any property listed here may be used to configure Hibernate no matter what configuration mechanism or bootstrap API is used.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ALLOW_REFRESH_DETACHED_ENTITY	When enabled, allows calls to EntityManager.refresh(Object) and Session.refresh(Object) on a detached entity instance.
static final String	CFG_XML_FILE
static final String	CURRENT_SESSION_CONTEXT_CLASS	Specifies a CurrentSessionContext for scoping the current session, either: jta, thread, or managed, or the name of a class implementing org.hibernate.context.spi.CurrentSessionContext.
static final String	CUSTOM_ENTITY_DIRTINESS_STRATEGY	Setting to identify a CustomEntityDirtinessStrategy to use.
static final String	DELAY_ENTITY_LOADER_CREATIONS	Controls how entity loaders are created.
static final String	DISCARD_PC_ON_CLOSE	When enabled, specifies that the persistent context should be discarded when either SharedSessionContract.close() or EntityManager.close() is called.
static final String	EVENT_LISTENER_PREFIX	Event listener configuration properties follow the pattern hibernate.event.listener.eventType packageName.ClassName1, packageName.ClassName2
static final String	FLUSH_MODE	Deprecated, for removal: This API element is subject to removal in a future version. There are much better ways to control the flush mode of a session, for example, SessionBuilder.flushMode(org.hibernate.FlushMode) or Session.setHibernateFlushMode(org.hibernate.FlushMode).
static final String	HBM_XML_FILES
static final String	IDENTIFIER_GENERATOR_STRATEGY_PROVIDER	Deprecated. use GenerationTypeStrategyRegistration instead
static final String	JAKARTA_LOCK_SCOPE	Set a default value for the hint SpecHints.HINT_SPEC_LOCK_SCOPE, used when the hint is not explicitly specified.
static final String	JAKARTA_LOCK_TIMEOUT	Set a default value for the hint SpecHints.HINT_SPEC_LOCK_TIMEOUT, used when the hint is not explicitly specified.
static final String	JPA_LOCK_SCOPE	Deprecated. Use JAKARTA_LOCK_SCOPE instead
static final String	JPA_LOCK_TIMEOUT	Deprecated. Use JAKARTA_LOCK_TIMEOUT instead
static final String	LOADED_CLASSES
static final String	MERGE_ENTITY_COPY_OBSERVER	Setting that specifies how Hibernate will respond when multiple representations of the same persistent entity ("entity copy") are detected while merging.
static final String	ORM_XML_FILES
static final String	USE_IDENTIFIER_ROLLBACK	When enabled, specifies that the generated identifier of an entity is unset when the entity is deleted.

Fields inherited from interface org.hibernate.cfg.BatchSettings

BATCH_STRATEGY, BATCH_VERSIONED_DATA, BUILDER, ORDER_INSERTS, ORDER_UPDATES, STATEMENT_BATCH_SIZE

Fields inherited from interface org.hibernate.cfg.BytecodeSettings

BYTECODE_PROVIDER, ENHANCER_ENABLE_ASSOCIATION_MANAGEMENT, ENHANCER_ENABLE_DIRTY_TRACKING, ENHANCER_ENABLE_LAZY_INITIALIZATION

Fields inherited from interface org.hibernate.cfg.C3p0Settings

C3P0_ACQUIRE_INCREMENT, C3P0_CONFIG_PREFIX, C3P0_IDLE_TEST_PERIOD, C3P0_MAX_SIZE, C3P0_MAX_STATEMENTS, C3P0_MIN_SIZE, C3P0_TIMEOUT

Fields inherited from interface org.hibernate.cfg.CacheSettings

AUTO_EVICT_COLLECTION_CACHE, CACHE_KEYS_FACTORY, CACHE_REGION_FACTORY, CACHE_REGION_PREFIX, CLASS_CACHE_PREFIX, COLLECTION_CACHE_PREFIX, DEFAULT_CACHE_CONCURRENCY_STRATEGY, JAKARTA_SHARED_CACHE_MODE, JAKARTA_SHARED_CACHE_RETRIEVE_MODE, JAKARTA_SHARED_CACHE_STORE_MODE, JPA_SHARED_CACHE_MODE, JPA_SHARED_CACHE_RETRIEVE_MODE, JPA_SHARED_CACHE_STORE_MODE, QUERY_CACHE_FACTORY, QUERY_CACHE_LAYOUT, USE_DIRECT_REFERENCE_CACHE_ENTRIES, USE_MINIMAL_PUTS, USE_QUERY_CACHE, USE_SECOND_LEVEL_CACHE, USE_STRUCTURED_CACHE

Fields inherited from interface org.hibernate.cfg.EnvironmentSettings

CLASSLOADERS, JNDI_CLASS, JNDI_PREFIX, JNDI_URL, TC_CLASSLOADER

Fields inherited from interface org.hibernate.cfg.FetchSettings

BATCH_FETCH_STYLE, DEFAULT_BATCH_FETCH_SIZE, MAX_FETCH_DEPTH, USE_SUBSELECT_FETCH

Fields inherited from interface org.hibernate.cfg.JdbcSettings

ALLOW_METADATA_ON_BOOT, AUTOCOMMIT, CONNECTION_HANDLING, CONNECTION_PREFIX, CONNECTION_PROVIDER, CONNECTION_PROVIDER_DISABLES_AUTOCOMMIT, DATASOURCE, DIALECT, DIALECT_DB_MAJOR_VERSION, DIALECT_DB_MINOR_VERSION, DIALECT_DB_NAME, DIALECT_DB_VERSION, DIALECT_NATIVE_PARAM_MARKERS, DIALECT_RESOLVERS, DRIVER, FORMAT_SQL, HBM2DDL_CONNECTION, HIGHLIGHT_SQL, ISOLATION, JAKARTA_HBM2DDL_CONNECTION, JAKARTA_HBM2DDL_DB_MAJOR_VERSION, JAKARTA_HBM2DDL_DB_MINOR_VERSION, JAKARTA_HBM2DDL_DB_NAME, JAKARTA_HBM2DDL_DB_VERSION, JAKARTA_JDBC_DRIVER, JAKARTA_JDBC_PASSWORD, JAKARTA_JDBC_URL, JAKARTA_JDBC_USER, JAKARTA_JTA_DATASOURCE, JAKARTA_NON_JTA_DATASOURCE, JDBC_TIME_ZONE, JPA_JDBC_DRIVER, JPA_JDBC_PASSWORD, JPA_JDBC_URL, JPA_JDBC_USER, JPA_JTA_DATASOURCE, JPA_NON_JTA_DATASOURCE, LOG_JDBC_WARNINGS, LOG_SLOW_QUERY, NON_CONTEXTUAL_LOB_CREATION, PASS, POOL_SIZE, SHOW_SQL, STATEMENT_FETCH_SIZE, STATEMENT_INSPECTOR, URL, USE_GET_GENERATED_KEYS, USE_SCROLLABLE_RESULTSET, USE_SQL_COMMENTS, USER

Fields inherited from interface org.hibernate.cfg.JpaComplianceSettings

JPA_CACHING_COMPLIANCE, JPA_CLOSED_COMPLIANCE, JPA_COMPLIANCE, JPA_ID_GENERATOR_GLOBAL_SCOPE_COMPLIANCE, JPA_LIST_COMPLIANCE, JPA_LOAD_BY_ID_COMPLIANCE, JPA_ORDER_BY_MAPPING_COMPLIANCE, JPA_PROXY_COMPLIANCE, JPA_QUERY_COMPLIANCE, JPA_TRANSACTION_COMPLIANCE, JPAQL_STRICT_COMPLIANCE

Fields inherited from interface org.hibernate.cfg.ManagedBeanSettings

ALLOW_EXTENSIONS_IN_CDI, BEAN_CONTAINER, CDI_BEAN_MANAGER, DELAY_CDI_ACCESS, JAKARTA_CDI_BEAN_MANAGER

Fields inherited from interface org.hibernate.cfg.MappingSettings

COLUMN_ORDERING_STRATEGY, CREATE_EMPTY_COMPOSITES_ENABLED, DEFAULT_CATALOG, DEFAULT_LIST_SEMANTICS, DEFAULT_SCHEMA, FORCE_DISCRIMINATOR_IN_SELECTS_BY_DEFAULT, GLOBALLY_QUOTED_IDENTIFIERS, GLOBALLY_QUOTED_IDENTIFIERS_SKIP_COLUMN_DEFINITIONS, ID_DB_STRUCTURE_NAMING_STRATEGY, IGNORE_EXPLICIT_DISCRIMINATOR_COLUMNS_FOR_JOINED_SUBCLASS, IMPLICIT_DISCRIMINATOR_COLUMNS_FOR_JOINED_SUBCLASS, IMPLICIT_NAMING_STRATEGY, JAVA_TIME_USE_DIRECT_JDBC, JPA_METAMODEL_POPULATION, JSON_FORMAT_MAPPER, KEYWORD_AUTO_QUOTING_ENABLED, PHYSICAL_NAMING_STRATEGY, PREFER_NATIVE_ENUM_TYPES, PREFERRED_BOOLEAN_JDBC_TYPE, PREFERRED_DURATION_JDBC_TYPE, PREFERRED_INSTANT_JDBC_TYPE, PREFERRED_POOLED_OPTIMIZER, PREFERRED_UUID_JDBC_TYPE, SEQUENCE_INCREMENT_SIZE_MISMATCH_STRATEGY, STATIC_METAMODEL_POPULATION, TABLE_GENERATOR_STORE_LAST_USED, TIMEZONE_DEFAULT_STORAGE, TRANSFORM_HBM_XML, TRANSFORM_HBM_XML_FEATURE_HANDLING, USE_ENTITY_WHERE_CLAUSE_FOR_COLLECTIONS, USE_NATIONALIZED_CHARACTER_DATA, VALIDATE_XML, WRAPPER_ARRAY_HANDLING, XML_FORMAT_MAPPER, XML_MAPPING_ENABLED

Fields inherited from interface org.hibernate.cfg.MultiTenancySettings

MULTI_TENANT_CONNECTION_PROVIDER, MULTI_TENANT_IDENTIFIER_RESOLVER, TENANT_IDENTIFIER_TO_USE_FOR_ANY_KEY

Fields inherited from interface org.hibernate.cfg.PersistenceSettings

JAKARTA_PERSISTENCE_PROVIDER, JAKARTA_TRANSACTION_TYPE, JPA_CALLBACKS_ENABLED, JPA_PERSISTENCE_PROVIDER, JPA_TRANSACTION_TYPE, PERSISTENCE_UNIT_NAME, SCANNER, SCANNER_ARCHIVE_INTERPRETER, SCANNER_DISCOVERY, SESSION_FACTORY_JNDI_NAME, SESSION_FACTORY_NAME, SESSION_FACTORY_NAME_IS_JNDI, SESSION_FACTORY_OBSERVER

Fields inherited from interface org.hibernate.cfg.ProxoolSettings

PROXOOL_CONFIG_PREFIX, PROXOOL_EXISTING_POOL, PROXOOL_POOL_ALIAS, PROXOOL_PROPERTIES, PROXOOL_XML

Fields inherited from interface org.hibernate.cfg.QuerySettings

CALLABLE_NAMED_PARAMS_ENABLED, CRITERIA_COPY_TREE, CRITERIA_VALUE_HANDLING_MODE, DEFAULT_NULL_ORDERING, FAIL_ON_PAGINATION_OVER_COLLECTION_FETCH, IMMUTABLE_ENTITY_UPDATE_QUERY_HANDLING_MODE, IN_CLAUSE_PARAMETER_PADDING, NATIVE_IGNORE_JDBC_PARAMETERS, PORTABLE_INTEGER_DIVISION, QUERY_MULTI_TABLE_INSERT_STRATEGY, QUERY_MULTI_TABLE_MUTATION_STRATEGY, QUERY_PLAN_CACHE_ENABLED, QUERY_PLAN_CACHE_MAX_SIZE, QUERY_PLAN_CACHE_PARAMETER_METADATA_MAX_SIZE, QUERY_STARTUP_CHECKING, SEMANTIC_QUERY_PRODUCER, SEMANTIC_QUERY_TRANSLATOR

Fields inherited from interface org.hibernate.cfg.SchemaToolingSettings

BULK_ID_STRATEGY_GLOBAL_TEMPORARY_CREATE_TABLES, BULK_ID_STRATEGY_GLOBAL_TEMPORARY_DROP_TABLES, BULK_ID_STRATEGY_LOCAL_TEMPORARY_DROP_TABLES, BULK_ID_STRATEGY_PERSISTENT_TEMPORARY_CREATE_TABLES, BULK_ID_STRATEGY_PERSISTENT_TEMPORARY_DROP_TABLES, ENABLE_SYNONYMS, EXTRA_PHYSICAL_TABLE_TYPES, HBM2DDL_AUTO, HBM2DDL_CHARSET_NAME, HBM2DDL_CREATE_NAMESPACES, HBM2DDL_CREATE_SCHEMAS, HBM2DDL_CREATE_SCRIPT_SOURCE, HBM2DDL_CREATE_SOURCE, HBM2DDL_DATABASE_ACTION, HBM2DDL_DEFAULT_CONSTRAINT_MODE, HBM2DDL_DELIMITER, HBM2DDL_DROP_SCRIPT_SOURCE, HBM2DDL_DROP_SOURCE, HBM2DDL_FILTER_PROVIDER, HBM2DDL_HALT_ON_ERROR, HBM2DDL_IMPORT_FILES, HBM2DDL_IMPORT_FILES_SQL_EXTRACTOR, HBM2DDL_JDBC_METADATA_EXTRACTOR_STRATEGY, HBM2DDL_LOAD_SCRIPT_SOURCE, HBM2DDL_SCRIPTS_ACTION, HBM2DDL_SCRIPTS_CREATE_APPEND, HBM2DDL_SCRIPTS_CREATE_TARGET, HBM2DDL_SCRIPTS_DROP_TARGET, JAKARTA_HBM2DDL_CREATE_SCHEMAS, JAKARTA_HBM2DDL_CREATE_SCRIPT_SOURCE, JAKARTA_HBM2DDL_CREATE_SOURCE, JAKARTA_HBM2DDL_DATABASE_ACTION, JAKARTA_HBM2DDL_DROP_SCRIPT_SOURCE, JAKARTA_HBM2DDL_DROP_SOURCE, JAKARTA_HBM2DDL_LOAD_SCRIPT_SOURCE, JAKARTA_HBM2DDL_SCRIPTS_ACTION, JAKARTA_HBM2DDL_SCRIPTS_CREATE_TARGET, JAKARTA_HBM2DDL_SCRIPTS_DROP_TARGET, SCHEMA_MANAGEMENT_TOOL, STORAGE_ENGINE, UNIQUE_CONSTRAINT_SCHEMA_UPDATE_STRATEGY

Fields inherited from interface org.hibernate.cfg.SessionEventSettings

AUTO_SESSION_EVENTS_LISTENER, INTERCEPTOR, LOG_SESSION_METRICS, SESSION_SCOPED_INTERCEPTOR

Fields inherited from interface org.hibernate.cfg.StatisticsSettings

GENERATE_STATISTICS, QUERY_STATISTICS_MAX_SIZE, STATS_BUILDER

Fields inherited from interface org.hibernate.cfg.TransactionSettings

ALLOW_JTA_TRANSACTION_ACCESS, ALLOW_UPDATE_OUTSIDE_TRANSACTION, AUTO_CLOSE_SESSION, ENABLE_LAZY_LOAD_NO_TRANS, FLUSH_BEFORE_COMPLETION, JTA_CACHE_TM, JTA_CACHE_UT, JTA_PLATFORM, JTA_PLATFORM_RESOLVER, JTA_TRACK_BY_THREAD, PREFER_USER_TRANSACTION, TRANSACTION_COORDINATOR_STRATEGY

Fields inherited from interface org.hibernate.cfg.ValidationSettings

CHECK_NULLABILITY, JAKARTA_PERSIST_VALIDATION_GROUP, JAKARTA_REMOVE_VALIDATION_GROUP, JAKARTA_UPDATE_VALIDATION_GROUP, JAKARTA_VALIDATION_FACTORY, JAKARTA_VALIDATION_MODE, JPA_PERSIST_VALIDATION_GROUP, JPA_REMOVE_VALIDATION_GROUP, JPA_UPDATE_VALIDATION_GROUP, JPA_VALIDATION_FACTORY, JPA_VALIDATION_MODE

Field Details

JAKARTA_LOCK_SCOPE

static final String JAKARTA_LOCK_SCOPE

Set a default value for the hint SpecHints.HINT_SPEC_LOCK_SCOPE, used when the hint is not explicitly specified.

See JPA 2 sections 8.2.1.9 and 3.4.4.3

See Also:

• SpecHints.HINT_SPEC_LOCK_SCOPE
• Constant Field Values

JAKARTA_LOCK_TIMEOUT

static final String JAKARTA_LOCK_TIMEOUT

Set a default value for the hint SpecHints.HINT_SPEC_LOCK_TIMEOUT, used when the hint is not explicitly specified.

See JPA 2 sections 8.2.1.9 and 3.4.4.3

See Also:

• SpecHints.HINT_SPEC_LOCK_TIMEOUT
• Constant Field Values

JPA_LOCK_SCOPE

@Deprecated
static final String JPA_LOCK_SCOPE

Deprecated.

Use JAKARTA_LOCK_SCOPE instead

See Also:

• Constant Field Values

JPA_LOCK_TIMEOUT

@Deprecated
static final String JPA_LOCK_TIMEOUT

Deprecated.

Use JAKARTA_LOCK_TIMEOUT instead

See Also:

• Constant Field Values

CFG_XML_FILE

static final String CFG_XML_FILE

See Also:

• Constant Field Values

ORM_XML_FILES

static final String ORM_XML_FILES

See Also:

• Constant Field Values

HBM_XML_FILES

static final String HBM_XML_FILES

See Also:

• Constant Field Values

LOADED_CLASSES

static final String LOADED_CLASSES

See Also:

• Constant Field Values

CURRENT_SESSION_CONTEXT_CLASS

static final String CURRENT_SESSION_CONTEXT_CLASS

Specifies a CurrentSessionContext for scoping the current session, either:

• jta, thread, or managed, or
• the name of a class implementing org.hibernate.context.spi.CurrentSessionContext.

If this property is not set, but JTA support is enabled, then JTASessionContext is used by default.

See Also:

• SessionFactory.getCurrentSession()
• CurrentSessionContext
• Constant Field Values

DELAY_ENTITY_LOADER_CREATIONS

static final String DELAY_ENTITY_LOADER_CREATIONS

Controls how entity loaders are created.

When true, the default, the loaders are only created on first access; this ensures that all access patterns which are not useful to the application are never instantiated, possibly saving a substantial amount of memory for applications having many entities. The only exception is the loader for LockMode.NONE, which will always be eagerly initialized; this is necessary to detect mapping errors.

false indicates that all loaders should be created up front; this will consume more memory but ensures all necessary memory is allocated right away.

Since:

5.3

See Also:

• SessionFactoryBuilder.applyDelayedEntityLoaderCreations(boolean)
• Constant Field Values

ALLOW_REFRESH_DETACHED_ENTITY

static final String ALLOW_REFRESH_DETACHED_ENTITY

When enabled, allows calls to EntityManager.refresh(Object) and Session.refresh(Object) on a detached entity instance.

Values are true, which allows refreshing a detached instance and false, which does not. When refreshing is disallowed, an IllegalArgumentException is thrown.

The default behavior is to allow refreshing a detached instance unless Hibernate is bootstrapped via JPA.

Since:

5.2

See Also:

• Constant Field Values

MERGE_ENTITY_COPY_OBSERVER

static final String MERGE_ENTITY_COPY_OBSERVER

Setting that specifies how Hibernate will respond when multiple representations of the same persistent entity ("entity copy") are detected while merging.

The possible values are:

• disallow (the default): throws IllegalStateException if an entity copy is detected
• allow: performs the merge operation on each entity copy that is detected
• log: (provided for testing only) performs the merge operation on each entity copy that is detected and logs information about the entity copies. This setting requires DEBUG logging be enabled for EntityCopyAllowedLoggedObserver.

Alternatively, the application may customize the behavior by providing an implementation of EntityCopyObserver and setting the property "hibernate.event.merge.entity_copy_observer" to the class name.

When this property is set to allow or log, Hibernate will merge each entity copy detected while cascading the merge operation. In the process of merging each entity copy, Hibernate will cascade the merge operation from each entity copy to its associations with CascadeType.MERGE or CascadeType.ALL. The entity state resulting from merging an entity copy will be overwritten when another entity copy is merged.

Since:

4.3

See Also:

• Constant Field Values

DISCARD_PC_ON_CLOSE

static final String DISCARD_PC_ON_CLOSE

When enabled, specifies that the persistent context should be discarded when either SharedSessionContract.close() or EntityManager.close() is called.

See Also:

• Constant Field Values

Default Value:

false (not discarded) per the JPA specification.

USE_IDENTIFIER_ROLLBACK

static final String USE_IDENTIFIER_ROLLBACK

When enabled, specifies that the generated identifier of an entity is unset when the entity is deleted.

See Also:

• SessionFactoryBuilder.applyIdentifierRollbackSupport(boolean)
• Constant Field Values

Default Value:

false - generated identifiers are not unset

CUSTOM_ENTITY_DIRTINESS_STRATEGY

static final String CUSTOM_ENTITY_DIRTINESS_STRATEGY

Setting to identify a CustomEntityDirtinessStrategy to use. May specify either a class name or an instance.

See Also:

• SessionFactoryBuilder.applyCustomEntityDirtinessStrategy(CustomEntityDirtinessStrategy)
• Constant Field Values

EVENT_LISTENER_PREFIX

static final String EVENT_LISTENER_PREFIX

Event listener configuration properties follow the pattern hibernate.event.listener.eventType packageName.ClassName1, packageName.ClassName2

See Also:

• Constant Field Values

FLUSH_MODE

@Deprecated(since="6.2",
            forRemoval=true)
static final String FLUSH_MODE

Deprecated, for removal: This API element is subject to removal in a future version.

There are much better ways to control the flush mode of a session, for example, SessionBuilder.flushMode(org.hibernate.FlushMode) or Session.setHibernateFlushMode(org.hibernate.FlushMode).

See Also:

• HibernateHints.HINT_FLUSH_MODE
• Constant Field Values

IDENTIFIER_GENERATOR_STRATEGY_PROVIDER

@Deprecated(since="6.0")
static final String IDENTIFIER_GENERATOR_STRATEGY_PROVIDER

Deprecated.

use GenerationTypeStrategyRegistration instead

Specifies a class which implements IdentifierGeneratorStrategyProvider, and has a constructor with no parameters.

See Also:

• Constant Field Values