Package org.hibernate.cfg
Interface AvailableSettings
- All Superinterfaces:
AgroalSettings,BatchSettings,BytecodeSettings,C3p0Settings,CacheSettings,EnvironmentSettings,FetchSettings,HikariCPSettings,JdbcSettings,JpaComplianceSettings,ManagedBeanSettings,MappingSettings,MultiTenancySettings,PersistenceSettings,QuerySettings,SchemaToolingSettings,SessionEventSettings,StatisticsSettings,TransactionSettings,ValidationSettings
- All Known Implementing Classes:
Environment
public interfaceAvailableSettingsextendsBatchSettings,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.xmlorhibernate.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
FieldsModifier and TypeFieldDescriptionstatic finalStringstatic finalStringSpecifies aCurrentSessionContextfor scoping thecurrent session, either:jta,thread, ormanaged, or the name of a class implementingorg.hibernate.context.spi.CurrentSessionContext.static finalStringSetting to identify aCustomEntityDirtinessStrategyto use.static finalStringDeprecated, for removal: This API element is subject to removal in a future version.This setting no longer has any effect.static finalStringDeprecated, for removal: This API element is subject to removal in a future version.This is no longer useful and will be removed.static finalStringEvent listener configuration properties follow the patternhibernate.event.listener.eventType packageName.ClassName1, packageName.ClassName2static finalStringstatic finalStringSet a default value for the hintSpecHints.HINT_SPEC_LOCK_SCOPE, used when the hint is not explicitly specified.static finalStringSet a default value for the hintSpecHints.HINT_SPEC_LOCK_TIMEOUT, used when the hint is not explicitly specified.static finalStringDeprecated.UseJAKARTA_LOCK_SCOPEinsteadstatic finalStringDeprecated.UseJAKARTA_LOCK_TIMEOUTinsteadstatic finalStringstatic finalStringSpecifies how Hibernate should behave when multiple representations of the same persistent entity instance, that is, multiple detached objects with the same persistent identity, are encountered while cascading amerge()operation.static finalStringstatic finalStringWhen enabled, specifies that the generated identifier of an entity is unset when the entity isdeleted.Fields inherited from interface org.hibernate.cfg.AgroalSettings
AGROAL_ACQUISITION_TIMEOUT,AGROAL_CONFIG_PREFIX,AGROAL_FLUSH_ON_CLOSE,AGROAL_IDLE_TIMEOUT,AGROAL_IDLE_VALIDATION_TIMEOUT,AGROAL_INITIAL_SIZE,AGROAL_INITIAL_SQL,AGROAL_LEAK_TIMEOUT,AGROAL_MAX_LIFETIME,AGROAL_MAX_SIZE,AGROAL_MIN_SIZE,AGROAL_VALIDATE_ON_BORROW,AGROAL_VALIDATION_TIMEOUTFields inherited from interface org.hibernate.cfg.BatchSettings
BATCH_STRATEGY,BUILDER,ORDER_INSERTS,ORDER_UPDATES,STATEMENT_BATCH_SIZEFields inherited from interface org.hibernate.cfg.BytecodeSettings
BYTECODE_PROVIDER,BYTECODE_PROVIDER_INSTANCE,ENHANCER_ENABLE_ASSOCIATION_MANAGEMENT,ENHANCER_ENABLE_DIRTY_TRACKING,ENHANCER_ENABLE_LAZY_INITIALIZATIONFields 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_TIMEOUTFields 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_CACHEFields inherited from interface org.hibernate.cfg.EnvironmentSettings
CLASSLOADERS,JNDI_CLASS,JNDI_PREFIX,JNDI_URL,TC_CLASSLOADERFields inherited from interface org.hibernate.cfg.FetchSettings
DEFAULT_BATCH_FETCH_SIZE,MAX_FETCH_DEPTH,USE_SUBSELECT_FETCHFields inherited from interface org.hibernate.cfg.HikariCPSettings
HIKARI_ACQUISITION_TIMEOUT,HIKARI_CONFIG_PREFIX,HIKARI_IDLE_TIMEOUT,HIKARI_INITIAL_SQL,HIKARI_INITIALIZATION_TIMEOUT,HIKARI_ISOLATE_INTERNAL_QUERIES,HIKARI_KEEPALIVE_TIME,HIKARI_LEAK_TIMEOUT,HIKARI_MAX_LIFETIME,HIKARI_MAX_SIZE,HIKARI_MIN_IDLE_SIZE,HIKARI_POOL_NAME,HIKARI_READ_ONLY,HIKARI_VALIDATION_TIMEOUTFields 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_ERRORS,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,USERFields inherited from interface org.hibernate.cfg.JpaComplianceSettings
JPA_CACHING_COMPLIANCE,JPA_CASCADE_COMPLIANCE,JPA_CLOSED_COMPLIANCE,JPA_COMPLIANCE,JPA_ID_GENERATOR_GLOBAL_SCOPE_COMPLIANCE,JPA_LOAD_BY_ID_COMPLIANCE,JPA_ORDER_BY_MAPPING_COMPLIANCE,JPA_PROXY_COMPLIANCE,JPA_QUERY_COMPLIANCE,JPA_TRANSACTION_COMPLIANCE,JPAQL_STRICT_COMPLIANCEFields inherited from interface org.hibernate.cfg.ManagedBeanSettings
ALLOW_EXTENSIONS_IN_CDI,BEAN_CONTAINER,CDI_BEAN_MANAGER,DELAY_CDI_ACCESS,JAKARTA_CDI_BEAN_MANAGERFields inherited from interface org.hibernate.cfg.MappingSettings
COLUMN_ORDERING_STRATEGY,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_ARRAY_JDBC_TYPE,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_NATIONALIZED_CHARACTER_DATA,VALIDATE_XML,WRAPPER_ARRAY_HANDLING,XML_FORMAT_MAPPER,XML_FORMAT_MAPPER_LEGACY_FORMAT,XML_MAPPING_ENABLEDFields inherited from interface org.hibernate.cfg.MultiTenancySettings
MULTI_TENANT_CONNECTION_PROVIDER,MULTI_TENANT_IDENTIFIER_RESOLVER,TENANT_IDENTIFIER_TO_USE_FOR_ANY_KEYFields 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,UNOWNED_ASSOCIATION_TRANSIENT_CHECKFields inherited from interface org.hibernate.cfg.QuerySettings
CALLABLE_NAMED_PARAMS_ENABLED,CRITERIA_COPY_TREE,CRITERIA_PLAN_CACHE_ENABLED,CRITERIA_VALUE_HANDLING_MODE,DEFAULT_NULL_ORDERING,FAIL_ON_PAGINATION_OVER_COLLECTION_FETCH,IMMUTABLE_ENTITY_UPDATE_QUERY_HANDLING_MODE,IN_CLAUSE_PARAMETER_PADDING,JSON_FUNCTIONS_ENABLED,NATIVE_IGNORE_JDBC_PARAMETERS,NATIVE_PREFER_JDBC_DATETIME_TYPES,PORTABLE_INTEGER_DIVISION,QUERY_MULTI_TABLE_INSERT_STRATEGY,QUERY_MULTI_TABLE_MUTATION_STRATEGY,QUERY_PASS_PROCEDURE_PARAMETER_NAMES,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,XML_FUNCTIONS_ENABLEDFields 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,HBM2DDL_SKIP_DEFAULT_IMPORT_FILE,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_STRATEGYFields inherited from interface org.hibernate.cfg.SessionEventSettings
AUTO_SESSION_EVENTS_LISTENER,INTERCEPTOR,LOG_SESSION_METRICS,SESSION_SCOPED_INTERCEPTORFields inherited from interface org.hibernate.cfg.StatisticsSettings
GENERATE_STATISTICS,QUERY_STATISTICS_MAX_SIZE,STATS_BUILDERFields 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_STRATEGYFields 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
Set a default value for the hintSpecHints.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
JAKARTA_LOCK_TIMEOUT
Set a default value for the hintSpecHints.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
JPA_LOCK_SCOPE
Deprecated.UseJAKARTA_LOCK_SCOPEinstead- See Also:
JPA_LOCK_TIMEOUT
Deprecated.UseJAKARTA_LOCK_TIMEOUTinstead- See Also:
CFG_XML_FILE
- See Also:
ORM_XML_FILES
- See Also:
HBM_XML_FILES
- See Also:
LOADED_CLASSES
- See Also:
CURRENT_SESSION_CONTEXT_CLASS
Specifies aCurrentSessionContextfor scoping thecurrent session, either:jta,thread, ormanaged, or- the name of a class implementing
org.hibernate.context.spi.CurrentSessionContext.
JTASessionContextis used by default.DELAY_ENTITY_LOADER_CREATIONS
Deprecated, for removal: This API element is subject to removal in a future version.This setting no longer has any effect.MERGE_ENTITY_COPY_OBSERVER
Specifies how Hibernate should behave when multiple representations of the same persistent entity instance, that is, multiple detached objects with the same persistent identity, are encountered while cascading amerge()operation.The possible values are:
disallow(the default): throwIllegalStateExceptionif multiple copies of the same entity are encounteredallow: perform the merge operation for every copy encountered, making no attempt to reconcile conflicts (this may result in lost updates)log: (provided for testing only) perform the merge operation for every copy encountered and log information about the copies. This setting requires thatDEBUGlogging be enabled forEntityCopyAllowedLoggedObserver.
Alternatively, the application may customize the behavior by providing a custom implementation of
EntityCopyObserverand setting the property "hibernate.event.merge.entity_copy_observer" to the class name. This, in principle, allows the application program to specify rules for reconciling conflicts.When this property is set to
alloworlog, 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 withCascadeType.MERGEorCascadeType.ALL. The entity state resulting from merging an entity copy will be overwritten when another entity copy is merged.- Since:
- 4.3
- See Also:
DISCARD_PC_ON_CLOSE
Deprecated, for removal: This API element is subject to removal in a future version.This is no longer useful and will be removed.When enabled, specifies that all transactional resources should be immediately released whenSharedSessionContract.close()is called.- See Also:
- API Note:
- The legacy name of this setting is extremely misleading; it has little to do with persistence contexts.
- Default Value:
false(not released), as per the JPA specification.
USE_IDENTIFIER_ROLLBACK
When enabled, specifies that the generated identifier of an entity is unset when the entity isdeleted. If the entity is versioned, the version is also reset to its default value.- See Also:
- Default Value:
false- generated identifiers are not unset
CUSTOM_ENTITY_DIRTINESS_STRATEGY
Setting to identify aCustomEntityDirtinessStrategyto use. May specify either a class name or an instance.EVENT_LISTENER_PREFIX
Event listener configuration properties follow the patternhibernate.event.listener.eventType packageName.ClassName1, packageName.ClassName2- See Also: