Interface AvailableSettings
-
- All Known Implementing Classes:
Environment
public interface AvailableSettings
-
-
Field Summary
Fields Modifier and Type Field Description static StringALLOW_ENHANCEMENT_AS_PROXYDeprecated.(as of 5.5) with no replacement.static StringALLOW_JTA_TRANSACTION_ACCESSSetting that allows access to the underlyingTransaction, even when using a JTA since normal JPA operations prohibit this behavior.static StringALLOW_REFRESH_DETACHED_ENTITYSetting that allows to callEntityManager.refresh(Object)orSession.refresh(Object)on a detached entity instance when theSessionis obtained from a JPAEntityManager).static StringALLOW_UPDATE_OUTSIDE_TRANSACTIONSetting that allows to perform update operations outside of a transaction boundary.static StringARTIFACT_PROCESSING_ORDERUsed to specify the order in which metadata sources should be processed.static StringAUTO_CLOSE_SESSIONEnable automatic session close at end of transactionstatic StringAUTO_EVICT_COLLECTION_CACHEEnables the automatic eviction of a bi-directional association's collection cache when an element in the ManyToOne collection is added/updated/removed without properly managing the change on the OneToMany side.static StringAUTO_SESSION_EVENTS_LISTENERDefines a defaultSessionEventListenerto be applied to opened Sessions.static StringAUTOCOMMITControls the autocommit mode of JDBC Connections obtained from a non-DataSource ConnectionProvider - assuming the ConnectionProvider impl properly leverages this setting (the provided Hibernate impls all do).static StringBATCH_FETCH_STYLEDeprecated.(since 6.0) : An appropriate batch-fetch style is selected automaticallystatic StringBATCH_STRATEGYSelect a custom batcher.static StringBATCH_VERSIONED_DATAShould versioned data be included in batching?static StringBEAN_CONTAINERIdentifies an explicitBeanContainerto be used.static StringBYTECODE_PROVIDERPick which bytecode enhancing library to use.static StringC3P0_ACQUIRE_INCREMENTNumber of connections acquired when pool is exhaustedstatic StringC3P0_CONFIG_PREFIXA setting prefix used to indicate settings that target the hibernate-c3p0 integrationstatic StringC3P0_IDLE_TEST_PERIODIdle time before a C3P0 pooled connection is validatedstatic StringC3P0_MAX_SIZEMaximum size of C3P0 connection poolstatic StringC3P0_MAX_STATEMENTSMaximum size of C3P0 statement cachestatic StringC3P0_MIN_SIZEMinimum size of C3P0 connection poolstatic StringC3P0_TIMEOUTMaximum idle time for C3P0 connection poolstatic StringCACHE_KEYS_FACTORYAllow control to specify theCacheKeysFactoryimpl to use.static StringCACHE_PROVIDER_CONFIGThe CacheProvider implementation classstatic StringCACHE_REGION_FACTORYTheRegionFactoryimplementation.static StringCACHE_REGION_PREFIXThe CacheProvider region name prefixstatic StringCALLABLE_NAMED_PARAMS_ENABLEDGlobal setting name for controlling whether Hibernate should try to map named parameter names specified in aProcedureCallorStoredProcedureQueryto named parameters in the JDBCCallableStatement.static StringCDI_BEAN_MANAGERDeprecated.UseJAKARTA_CDI_BEAN_MANAGERinsteadstatic StringCFG_XML_FILEstatic StringCHECK_NULLABILITYEnable nullability checking.static StringCLASS_CACHE_PREFIXCaching configuration should follow the following patternhibernate.ejb.classcache.<fully.qualified.Classname> usage[, region]where usage is the cache strategy used and region the cache region namestatic StringCLASSLOADERSUsed to define aCollectionof theClassLoaderinstances Hibernate should use for class-loading and resource-lookups.static StringCOLLECTION_CACHE_PREFIXCaching configuration should follow the following patternhibernate.ejb.collectioncache.<fully.qualified.Classname>.<role> usage[, region]where usage is the cache strategy used and region the cache region namestatic StringCOLLECTION_JOIN_SUBQUERYSetting which indicates whether or not the new JOINS over collection tables should be rewritten to subqueries.static StringCONNECTION_HANDLINGSpecifies how Hibernate should manage JDBC connections in terms of acquiring and releasing.static StringCONNECTION_PREFIXNames a prefix used to define arbitrary JDBC connection properties.static StringCONNECTION_PROVIDERNames theConnectionProviderto use for obtaining JDBC connections.static StringCONNECTION_PROVIDER_DISABLES_AUTOCOMMITAllows a user to tell Hibernate that the Connections we obtain from the configured ConnectionProvider will already have auto-commit disabled when we acquire them from the provider.static StringCONVENTIONAL_JAVA_CONSTANTSSetting which indicates whether or not Java constant follow the Java Naming conventions.static StringCREATE_EMPTY_COMPOSITES_ENABLED[EXPERIMENTAL] Enable instantiation of composite/embedded objects when all of its attribute values arenull.static StringCRITERIA_VALUE_HANDLING_MODEBy default, Criteria queries uses bind parameters for any value passed through the JPA Criteria API.static StringCURRENT_SESSION_CONTEXT_CLASSContext scoping impl forSessionFactory.getCurrentSession()processing.static StringCUSTOM_ENTITY_DIRTINESS_STRATEGYSetting to identify aCustomEntityDirtinessStrategyto use.static StringDATASOURCENames aDataSource.static StringDEFAULT_BATCH_FETCH_SIZEThe default batch size for batch fetchingstatic StringDEFAULT_CACHE_CONCURRENCY_STRATEGYSetting used to give the name of the defaultCacheConcurrencyStrategyto use when either@Cacheableor@Cacheis used.static StringDEFAULT_CATALOGA default database catalog name to use for unqualified tablenamesstatic StringDEFAULT_NULL_ORDERINGDefault precedence of null values inORDER BYclause.static StringDEFAULT_SCHEMAA default database schema (owner) name to use for unqualified tablenamesstatic StringDELAY_CDI_ACCESSUsed in conjunction with "hibernate.resource.beans.container" where CDI is being used.static StringDELAY_ENTITY_LOADER_CREATIONSControls how the individual Loaders for an entity are created.static StringDIALECTNames the Hibernate SQLDialectclassstatic StringDIALECT_DB_MAJOR_VERSIONDeprecated.UseJAKARTA_HBM2DDL_DB_MAJOR_VERSIONinsteadstatic StringDIALECT_DB_MINOR_VERSIONDeprecated.UseJAKARTA_HBM2DDL_DB_MINOR_VERSIONinsteadstatic StringDIALECT_DB_NAMEDeprecated.UseJAKARTA_HBM2DDL_DB_NAMEinsteadstatic StringDIALECT_DB_VERSIONDeprecated.UseJAKARTA_HBM2DDL_DB_VERSIONinsteadstatic StringDIALECT_RESOLVERSNames any additionalDialectResolverimplementations to register with the standardDialectFactory.static StringDISCARD_PC_ON_CLOSEWhether to discard persistent context onSharedSessionContract.close()/EntityManager.close().static StringDRIVERNames the JDBC driver classstatic StringENABLE_LAZY_LOAD_NO_TRANSstatic StringENABLE_SYNONYMSIf enabled, allows schema update and validation to support synonyms.static StringENFORCE_LEGACY_PROXY_CLASSNAMESConfigure the global BytecodeProvider implementation to generate class names matching the existing naming patterns.static StringENHANCER_ENABLE_ASSOCIATION_MANAGEMENTEnable association management feature in runtime bytecode enhancementstatic StringENHANCER_ENABLE_DIRTY_TRACKINGEnable dirty tracking feature in runtime bytecode enhancementstatic StringENHANCER_ENABLE_LAZY_INITIALIZATIONEnable lazy loading feature in runtime bytecode enhancementstatic StringEVENT_LISTENER_PREFIXEvent configuration should follow the following pattern hibernate.event.listener.[eventType] f.q.c.n.EventListener1, f.q.c.n.EventListener12 ...static StringEXTRA_PHYSICAL_TABLE_TYPESIdentifies a comma-separate list of values to specify extra table types, other than the default "TABLE" value, to recognize as defining a physical table by schema update, creation and validation.static StringFAIL_ON_PAGINATION_OVER_COLLECTION_FETCHRaises an exception when in-memory pagination over collection fetch is about to be performed.static StringFLUSH_BEFORE_COMPLETIONEnable automatic flush during the JTA beforeCompletion() callbackstatic StringFLUSH_MODEUsed to determine flush mode.static StringFORCE_DISCRIMINATOR_IN_SELECTS_BY_DEFAULTstatic StringFORMAT_SQLEnable formatting of SQL logged to the consolestatic StringGENERATE_STATISTICSEnable statistics collectionstatic StringGLOBALLY_QUOTED_IDENTIFIERSShould all database identifiers be quoted.static StringGLOBALLY_QUOTED_IDENTIFIERS_SKIP_COLUMN_DEFINITIONSAssumingGLOBALLY_QUOTED_IDENTIFIERS, this allows such global quoting to skip column-definitions as defined byColumn,JoinColumn, etc.static StringHBM_XML_FILESstatic StringHBM2DDL_AUTOSetting to perform SchemaManagementTool actions automatically as part of the SessionFactory lifecycle.static StringHBM2DDL_CHARSET_NAMEThe name of the charset used by the schema generation resource.static StringHBM2DDL_CONNECTIONDeprecated.UseJAKARTA_HBM2DDL_CONNECTIONinsteadstatic StringHBM2DDL_CREATE_NAMESPACESSpecifies whether to automatically create also the database schema/catalog.static StringHBM2DDL_CREATE_SCHEMASDeprecated.UseJAKARTA_HBM2DDL_CREATE_SCHEMASinsteadstatic StringHBM2DDL_CREATE_SCRIPT_SOURCEstatic StringHBM2DDL_CREATE_SOURCESpecifies whether schema generation commands for schema creation are to be determined based on object/relational mapping metadata, DDL scripts, or a combination of the two.static StringHBM2DDL_DATABASE_ACTIONDeprecated.UseJAKARTA_HBM2DDL_SCRIPTS_ACTIONinsteadstatic StringHBM2DDL_DEFAULT_CONSTRAINT_MODEThis setting is used when you useConstraintMode.PROVIDER_DEFAULTstrategy for foreign key mapping.static StringHBM2DDL_DELIMITERIdentifies the delimiter to use to separate schema management statements in script outputs.static StringHBM2DDL_DROP_SCRIPT_SOURCEstatic StringHBM2DDL_DROP_SOURCESpecifies whether schema generation commands for schema dropping are to be determined based on object/relational mapping metadata, DDL scripts, or a combination of the two.static StringHBM2DDL_FILTER_PROVIDERUsed to specify theSchemaFilterProviderto be used by create, drop, migrate and validate operations on the database schema.static StringHBM2DDL_HALT_ON_ERRORWhether the schema migration tool should halt on error, therefore terminating the bootstrap process.static StringHBM2DDL_IMPORT_FILESComma-separated names of the optional files containing SQL DML statements executed during the SessionFactory creation.static StringHBM2DDL_IMPORT_FILES_SQL_EXTRACTORReference to theorg.hibernate.tool.hbm2ddl.ImportSqlCommandExtractorimplementation class to use for parsing source/import files as defined byHBM2DDL_CREATE_SCRIPT_SOURCE,HBM2DDL_DROP_SCRIPT_SOURCEorHBM2DDL_IMPORT_FILES.static StringHBM2DDL_JDBC_METADATA_EXTRACTOR_STRATEGYSetting to choose the strategy used to access the JDBC Metadata.static StringHBM2DDL_LOAD_SCRIPT_SOURCEDeprecated.UseJAKARTA_HBM2DDL_LOAD_SCRIPT_SOURCEinsteadstatic StringHBM2DDL_SCRIPTS_ACTIONDeprecated.UseJAKARTA_HBM2DDL_SCRIPTS_ACTIONinsteadstatic StringHBM2DDL_SCRIPTS_CREATE_APPENDFor cases where the "javax.persistence.schema-generation.scripts.action" value indicates that schema commands should be written to DDL script file, specifies if schema commands should be appended to the end of the file rather than written at the beginning of the file.static StringHBM2DDL_SCRIPTS_CREATE_TARGETFor cases where the "javax.persistence.schema-generation.scripts.action" value indicates that schema creation commands should be written to DDL script file, "javax.persistence.schema-generation.scripts.create-target" specifies either aWriterconfigured for output of the DDL script or a string specifying the file URL for the DDL script.static StringHBM2DDL_SCRIPTS_DROP_TARGETFor cases where the "javax.persistence.schema-generation.scripts.action" value indicates that schema drop commands should be written to DDL script file, "javax.persistence.schema-generation.scripts.drop-target" specifies either aWriterconfigured for output of the DDL script or a string specifying the file URL for the DDL script.static StringHIGHLIGHT_SQLEnable highlighting of SQL logged to the console using ANSI escape codesstatic StringHQL_BULK_ID_STRATEGYDeprecated.UseQUERY_MULTI_TABLE_MUTATION_STRATEGYinsteadstatic StringID_TABLE_STRATEGYDeprecated.UseQUERY_MULTI_TABLE_MUTATION_STRATEGYinsteadstatic StringIDENTIFIER_GENERATOR_STRATEGY_PROVIDERIdentifierGeneratorStrategyProvider class name, the class must have a no-arg constructorstatic StringIGNORE_EXPLICIT_DISCRIMINATOR_COLUMNS_FOR_JOINED_SUBCLASSThe legacy behavior of Hibernate is to not use discriminators for joined inheritance (Hibernate does not need the discriminator...).static StringIMMUTABLE_ENTITY_UPDATE_QUERY_HANDLING_MODEstatic StringIMPLICIT_DISCRIMINATOR_COLUMNS_FOR_JOINED_SUBCLASSThe legacy behavior of Hibernate is to not use discriminators for joined inheritance (Hibernate does not need the discriminator...).static StringIMPLICIT_NAMING_STRATEGYUsed to specify theImplicitNamingStrategyclass to use.static StringIN_CLAUSE_PARAMETER_PADDINGBy default, the IN clause expands to include all bind parameter values.static StringINTERCEPTORNames aInterceptorimplementation to be applied to theSessionFactoryand propagated to each Session created from the SessionFactory.static StringISOLATIONNames the JDBC transaction isolation levelstatic StringJAKARTA_CDI_BEAN_MANAGERUsed to pass along the CDI BeanManager, if any, to be used.static StringJAKARTA_HBM2DDL_CONNECTIONAllows passing a specificConnectioninstance to be used by SchemaManagementTool for the purpose of Dialect determination as well as {@value #JAKARTA_HBM2DDL_DATABASE_ACTION database actions} if requested.static StringJAKARTA_HBM2DDL_CREATE_SCHEMASThe JPA variant ofHBM2DDL_CREATE_NAMESPACESused to specify whether database schemas used in the mapping model should be created on export in addition to creating the tables, sequences, etc.static StringJAKARTA_HBM2DDL_CREATE_SCRIPT_SOURCEstatic StringJAKARTA_HBM2DDL_CREATE_SOURCESpecifies whether schema generation commands for schema creation are to be determined based on object/relational mapping metadata, DDL scripts, or a combination of the two.static StringJAKARTA_HBM2DDL_DATABASE_ACTIONSpecifies what type (including none) of schema-tooling should be performed against the database specified using either "jakarta.persistence.schema-generation-connection" or the configuredConnectionProviderfor the SessionFactory.static StringJAKARTA_HBM2DDL_DB_MAJOR_VERSIONUsed in conjunction with "jakarta.persistence.database-product-name" for the purpose of determining the Dialect to use when the name does not provide enough detail.static StringJAKARTA_HBM2DDL_DB_MINOR_VERSIONUsed in conjunction with "jakarta.persistence.database-product-name" for the purpose of determining the Dialect to use when the name does not provide enough detail.static StringJAKARTA_HBM2DDL_DB_NAMESpecifies the name of the database vendor (as would be reported byDatabaseMetaData.getDatabaseProductName()) for the purpose of determining the Dialect to use.static StringJAKARTA_HBM2DDL_DB_VERSIONUsed in conjunction with "jakarta.persistence.database-product-name" for the purpose of determining the Dialect to use when the name does not provide enough detail.static StringJAKARTA_HBM2DDL_DROP_SCRIPT_SOURCEstatic StringJAKARTA_HBM2DDL_DROP_SOURCESpecifies whether schema generation commands for schema dropping are to be determined based on object/relational mapping metadata, DDL scripts, or a combination of the two.static StringJAKARTA_HBM2DDL_LOAD_SCRIPT_SOURCEJPA variant ofHBM2DDL_IMPORT_FILESfor specifying a database initialization script to be run as part of schema-export Specifies aReaderconfigured for reading of the SQL load script or a string designating theURLfor the SQL load script.static StringJAKARTA_HBM2DDL_SCRIPTS_ACTIONSpecifies what type (including none) of schema-tooling should be written to script files.static StringJAKARTA_HBM2DDL_SCRIPTS_CREATE_TARGETFor cases where "jakarta.persistence.schema-generation.scripts.action" indicates that schema creation commands should be written to a script file, this setting specifies either aWriterconfigured for output of the DDL script or a string specifying the file URL for the DDL script.static StringJAKARTA_HBM2DDL_SCRIPTS_DROP_TARGETFor cases where "jakarta.persistence.schema-generation.scripts.action" indicates that schema drop commands should be written to a script file, this setting specifies either aWriterconfigured for output of the DDL script or a string specifying the file URL for the DDL script.static StringJAKARTA_JDBC_DRIVERThe name of a JDBC driver to use to connect to the database.static StringJAKARTA_JDBC_PASSWORDThe JDBC connection password.static StringJAKARTA_JDBC_URLThe JDBC connection url to use to connect to the database.static StringJAKARTA_JDBC_USERThe JDBC connection user name.static StringJAKARTA_JTA_DATASOURCEThe JNDI name of a JTADataSource.static StringJAKARTA_LOCK_SCOPEUsed to request (hint) a pessimistic lock scope.static StringJAKARTA_LOCK_TIMEOUTUsed to request (hint) a pessimistic lock timeout (in milliseconds).static StringJAKARTA_NON_JTA_DATASOURCEThe JNDI name of a non-JTADataSource.static StringJAKARTA_PERSIST_VALIDATION_GROUPUsed to coordinate with bean validatorsstatic StringJAKARTA_PERSISTENCE_PROVIDERThe name of thePersistenceProviderimplementorstatic StringJAKARTA_REMOVE_VALIDATION_GROUPUsed to coordinate with bean validatorsstatic StringJAKARTA_SHARED_CACHE_MODEUsed to indicate whether second-level (what JPA terms shared cache) caching is enabled as per the rules defined in JPA 2 section 3.1.7.static StringJAKARTA_SHARED_CACHE_RETRIEVE_MODENOTE : Not a valid EMF property...static StringJAKARTA_SHARED_CACHE_STORE_MODENOTE : Not a valid EMF property...static StringJAKARTA_TRANSACTION_TYPEThe type of transactions supported by the entity managers.static StringJAKARTA_UPDATE_VALIDATION_GROUPUsed to coordinate with bean validatorsstatic StringJAKARTA_VALIDATION_FACTORYUsed to pass along any discovered validator factory.static StringJAKARTA_VALIDATION_MODEUsed to indicate what form of automatic validation is in effect as per rules defined in JPA 2 section 3.6.1.1static StringJDBC_TIME_ZONEDefault JDBC TimeZone.static StringJNDI_CLASSNames the JNDIInitialContextclass.static StringJNDI_PREFIXNames a prefix used to define arbitrary JNDIInitialContextproperties.static StringJNDI_URLNames the JNDI provider/connection urlstatic StringJPA_CACHING_COMPLIANCEstatic StringJPA_CALLBACKS_ENABLEDJPA Callbacks are enabled by default.static StringJPA_CLOSED_COMPLIANCEJPA defines specific exceptions on specific methods when called onEntityManagerandEntityManagerFactorywhen those objects have been closed.static StringJPA_COMPLIANCEAllows setting default value for allJpaComplianceflags.static StringJPA_ID_GENERATOR_GLOBAL_SCOPE_COMPLIANCEDetermine if the scope ofTableGenerator.name()andSequenceGenerator.name()should be considered globally or locally defined.static StringJPA_JDBC_DRIVERDeprecated.UseJAKARTA_JDBC_DRIVERinsteadstatic StringJPA_JDBC_PASSWORDDeprecated.UseJAKARTA_JDBC_PASSWORDinsteadstatic StringJPA_JDBC_URLDeprecated.UseJAKARTA_JDBC_URLinsteadstatic StringJPA_JDBC_USERDeprecated.UseJAKARTA_JDBC_USERinsteadstatic StringJPA_JTA_DATASOURCEDeprecated.UseJAKARTA_JTA_DATASOURCEinsteadstatic StringJPA_LIST_COMPLIANCEControls whether Hibernate should recognize what it considers a "bag" (PersistentBag) as a List (PersistentList) or as a bag.static StringJPA_LOAD_BY_ID_COMPLIANCEstatic StringJPA_LOCK_SCOPEDeprecated.UseJAKARTA_LOCK_SCOPEinsteadstatic StringJPA_LOCK_TIMEOUTDeprecated.UseJAKARTA_LOCK_TIMEOUTinsteadstatic StringJPA_NON_JTA_DATASOURCEDeprecated.UseJAKARTA_NON_JTA_DATASOURCEinsteadstatic StringJPA_ORDER_BY_MAPPING_COMPLIANCEControls whether Hibernate should recognize what it considers a "bag" (PersistentBag) as a List (PersistentList) or as a bag.static StringJPA_PERSIST_VALIDATION_GROUPDeprecated.UseJAKARTA_PERSIST_VALIDATION_GROUPinsteadstatic StringJPA_PERSISTENCE_PROVIDERDeprecated.UseJAKARTA_PERSISTENCE_PROVIDERinsteadstatic StringJPA_PROXY_COMPLIANCEThe JPA spec says that aEntityNotFoundExceptionshould be thrown when accessing an entity Proxy which does not have an associated table row in the database.static StringJPA_QUERY_COMPLIANCEControls whether Hibernate's handling ofQuery(JPQL, Criteria and native-query) should strictly follow the JPA spec.static StringJPA_REMOVE_VALIDATION_GROUPDeprecated.UseJAKARTA_REMOVE_VALIDATION_GROUPinsteadstatic StringJPA_SHARED_CACHE_MODEDeprecated.UseJAKARTA_SHARED_CACHE_MODEinsteadstatic StringJPA_SHARED_CACHE_RETRIEVE_MODEDeprecated.UseJAKARTA_SHARED_CACHE_RETRIEVE_MODEinsteadstatic StringJPA_SHARED_CACHE_STORE_MODEDeprecated.UseJAKARTA_SHARED_CACHE_STORE_MODEinsteadstatic StringJPA_TRANSACTION_COMPLIANCEShould Hibernate'sTransactionbehave as defined by the spec for JPA'sEntityTransactionsince it extends the JPA one.static StringJPA_TRANSACTION_TYPEDeprecated.UseJAKARTA_TRANSACTION_TYPEinsteadstatic StringJPA_UPDATE_VALIDATION_GROUPDeprecated.UseJAKARTA_UPDATE_VALIDATION_GROUPinsteadstatic StringJPA_VALIDATION_FACTORYDeprecated.UseJAKARTA_VALIDATION_FACTORYinsteadstatic StringJPA_VALIDATION_MODEDeprecated.UseJAKARTA_VALIDATION_MODEinsteadstatic StringJPAQL_STRICT_COMPLIANCEstatic StringJSON_FORMAT_MAPPERNames aFormatMapperimplementation to be applied to theSessionFactoryfor JSON serialization and deserialization.static StringJTA_CACHE_TMA configuration value key used to indicate that it is safe to cacheTransactionManagerreferences.static StringJTA_CACHE_UTA configuration value key used to indicate that it is safe to cacheUserTransactionreferences.static StringJTA_PLATFORMNames theJtaPlatformimplementation to use for integrating with JTA systems.static StringJTA_PLATFORM_RESOLVERNames theJtaPlatformResolverimplementation to use.static StringJTA_TRACK_BY_THREADA transaction can be rolled back by another thread ("tracking by thread") -- not the original application.static StringKEYWORD_AUTO_QUOTING_ENABLEDSpecifies whether to automatically quote any names that are deemed keywords.static StringLOADED_CLASSESstatic StringLOG_JDBC_WARNINGSEnable fetching JDBC statement warning for logging.static StringLOG_SESSION_METRICSA setting to control whether toStatisticalLoggingSessionEventListeneris enabled on all Sessions (unless explicitly disabled for a given Session).static StringLOG_SLOW_QUERYSetting that logs query which executed slower than specified milliseconds.static StringMAX_FETCH_DEPTHMaximum depth of outer join fetchingstatic StringMERGE_ENTITY_COPY_OBSERVERSetting that specifies how Hibernate will respond when multiple representations of the same persistent entity ("entity copy") is detected while merging.static StringMULTI_TENANTStrategy for multi-tenancy.static StringMULTI_TENANT_CONNECTION_PROVIDERNames aMultiTenantConnectionProviderimplementation to use.static StringMULTI_TENANT_IDENTIFIER_RESOLVERNames aCurrentTenantIdentifierResolverimplementation to use.static StringNATIVE_EXCEPTION_HANDLING_51_COMPLIANCEIndicates if exception handling for a SessionFactory built via Hibernate's native bootstrapping should behave the same as native exception handling in Hibernate ORM 5.1, When set totrue,HibernateExceptionwill not be wrapped or converted according to the JPA specification.static StringNATIVE_QUERY_ORDINAL_PARAMETER_BASEControls the base integer for binding JDBC-style (?) ordinal parameters when the Hibernate SessionFactory is bootstrapped via the native bootstrapping API.static StringNON_CONTEXTUAL_LOB_CREATIONShould we not use contextual LOB creation (aka based onConnection.createBlob()et al).static StringOMIT_JOIN_OF_SUPERCLASS_TABLESWhen you useInheritanceType.JOINEDstrategy for inheritance mapping and query a value from an entity, all superclass tables are joined in the query regardless you need them.static StringORDER_INSERTSEnable ordering of insert statements for the purpose of more efficient JDBC batching.static StringORDER_UPDATESEnable ordering of update statements by primary key valuestatic StringORM_XML_FILESstatic StringPASSNames the connection password.static StringPERSISTENCE_UNIT_NAMEUsed to pass along the name of the persistence unit.static StringPHYSICAL_NAMING_STRATEGYUsed to specify thePhysicalNamingStrategyclass to use.static StringPOOL_SIZEMaximum number of inactive connections for the built-in Hibernate connection pool.static StringPREFER_USER_TRANSACTIONShould we prefer using theJtaPlatform.retrieveUserTransaction()over usingJtaPlatform.retrieveTransactionManager()? Default isfalsestatic StringPREFERRED_BOOLEAN_JDBC_TYPE_CODEGlobal setting identifying the preferred JDBC type code for storing boolean values.static StringPREFERRED_POOLED_OPTIMIZERWhen a generator specified an increment-size and an optimizer was not explicitly specified, which of the "pooled" optimizers should be preferred? Can specify an optimizer short name or an Optimizer impl FQN.static StringPROXOOL_CONFIG_PREFIXA setting prefix used to indicate settings that target the hibernate-proxool integrationstatic StringPROXOOL_EXISTING_POOLProxool property to configure the Proxool Provider from an already existing pool (true / false)static StringPROXOOL_POOL_ALIASProxool property with the Proxool pool alias to use (Required for PROXOOL_EXISTING_POOL, PROXOOL_PROPERTIES, or PROXOOL_XML)static StringPROXOOL_PROPERTIESProxool property to configure the Proxool Provider using a properties file (/path/to/proxool.properties)static StringPROXOOL_XMLProxool property to configure the Proxool Provider using an XML (/path/to/file.xml)static StringQUERY_CACHE_FACTORYTheTimestampsCacheFactoryimplementation class.static StringQUERY_MULTI_TABLE_MUTATION_STRATEGYDefines the "global" strategy to use for handling HQL and Criteria mutation queries.static StringQUERY_PLAN_CACHE_ENABLEDShould query plan caching be enabled at all? Default isfalseunless one ofQUERY_PLAN_CACHE_MAX_SIZEorQUERY_PLAN_CACHE_PARAMETER_METADATA_MAX_SIZEis specifiedstatic StringQUERY_PLAN_CACHE_MAX_SIZEThe maximum number of entries in the Hibernate "Query Plan Cache".static StringQUERY_PLAN_CACHE_PARAMETER_METADATA_MAX_SIZEThe maximum number ofParameterMetadataImplmaintained byQueryInterpretationCache.static StringQUERY_STARTUP_CHECKINGShould named queries be checked during startup (the default is enabled).static StringQUERY_STATISTICS_MAX_SIZEThis setting controls the number ofQueryStatisticsentries that will be stored by the HibernateStatisticsobject.static StringQUERY_SUBSTITUTIONSA comma-separated list of token substitutions to use when translating a Hibernate query to SQLstatic StringQUERY_TRANSLATORDeprecated.static StringSCANNERPass an implementation ofScanner.static StringSCANNER_ARCHIVE_INTERPRETERPassArchiveDescriptorFactoryto use in the scanning process.static StringSCANNER_DEPRECATEDThe deprecated name.static StringSCANNER_DISCOVERYIdentifies a comma-separate list of values indicating the types of things we should auto-detect during scanning.static StringSCHEMA_MANAGEMENT_TOOLUsed to specify theSchemaManagementToolto use for performing schema management.static StringSEMANTIC_QUERY_PRODUCERNames theHqlTranslatorclass to use.static StringSEMANTIC_QUERY_TRANSLATORNames theSqmTranslatorFactoryclass to use.static StringSEQUENCE_INCREMENT_SIZE_MISMATCH_STRATEGYThis setting defines theSequenceMismatchStrategyused when Hibernate detects a mismatch between a sequence configuration in an entity mapping and its database sequence object counterpart.static StringSESSION_FACTORY_NAMESetting used to name the HibernateSessionFactory.static StringSESSION_FACTORY_NAME_IS_JNDIDoes the value defined bySESSION_FACTORY_NAMErepresent a JNDI namespace into which theSessionFactoryshould be bound and made accessible? Defaults totruefor backwards compatibility.static StringSESSION_FACTORY_OBSERVERSessionFactoryObserver class name, the class must have a no-arg constructorstatic StringSESSION_SCOPED_INTERCEPTORNames aInterceptorimplementation to be applied to theSessionFactoryand propagated to each Session created from the SessionFactory.static StringSHOW_HQL_FUNCTIONSEnable logging of functions registered by the configured SQLDialect.static StringSHOW_SQLEnable logging of generated SQL to the consolestatic StringSQL_EXCEPTION_CONVERTERTheSQLExceptionConverterto use for converting SQLExceptions to Hibernate's JDBCException hierarchy.static StringSTATEMENT_BATCH_SIZEMaximum JDBC batch size.static StringSTATEMENT_FETCH_SIZEGives the JDBC driver a hint as to the number of rows that should be fetched from the database when more rows are needed.static StringSTATEMENT_INSPECTORNames aStatementInspectorimplementation to be applied to theSessionFactory.static StringSTATIC_METAMODEL_POPULATIONSetting that controls whether we seek out JPA "static metamodel" classes and populate them.static StringSTORAGE_ENGINEDefines the default storage engine for the relational databases that support multiple storage engines.static StringTABLE_GENERATOR_STORE_LAST_USEDTrue/False setting indicating if the value stored in the table used by theTableGeneratoris the last value generated or the next value to be used.static StringTC_CLASSLOADERUsed to define how the current thread contextClassLoadermust be used for class lookup.static StringTIMEZONE_DEFAULT_STORAGEGlobal setting for configuring the default storage for the time zone information for time zone based types.static StringTRANSACTION_COORDINATOR_STRATEGYNames the implementation ofTransactionCoordinatorBuilderto use for creatingTransactionCoordinatorinstances.static StringUNIQUE_CONSTRAINT_SCHEMA_UPDATE_STRATEGYUnique columns and unique keys both use unique constraints in most dialects.static StringURLNames the JDBC connection url.static StringUSE_DIRECT_REFERENCE_CACHE_ENTRIESEnable direct storage of entity references into the second level cache when applicable (immutable data, etc).static StringUSE_ENTITY_WHERE_CLAUSE_FOR_COLLECTIONSControls whether an entity's "where" clause, mapped using@Where(clause="....")or<entity ...static StringUSE_GET_GENERATED_KEYSTells the JDBC driver to attempt to retrieve row Id with the JDBC 3.0 PreparedStatement.getGeneratedKeys() method.static StringUSE_IDENTIFIER_ROLLBACKstatic StringUSE_LEGACY_LIMIT_HANDLERSDeprecated.this setting now has no effectstatic StringUSE_MINIMAL_PUTSOptimize the cache for minimal puts instead of minimal getsstatic StringUSE_NATIONALIZED_CHARACTER_DATAEnable nationalized character support on all string / clob based attribute ( string, char, clob, text etc ).static StringUSE_NEW_ID_GENERATOR_MAPPINGSSetting which indicates whether or not the newIdentifierGeneratorare used for AUTO, TABLE and SEQUENCE.static StringUSE_QUERY_CACHEEnable the query cache (disabled by default)static StringUSE_REFLECTION_OPTIMIZERUse bytecode libraries optimized property accessstatic StringUSE_SCROLLABLE_RESULTSETUse JDBC scrollable ResultSets.static StringUSE_SECOND_LEVEL_CACHEEnable the second-level cache.static StringUSE_SQL_COMMENTSAdd comments to the generated SQLstatic StringUSE_STREAMS_FOR_BINARYUse java.io streams to read / write binary data from / to JDBCstatic StringUSE_STRUCTURED_CACHEEnable use of structured second-level cache entriesstatic StringUSERNames the connection user.static StringVALIDATE_QUERY_PARAMETERSSetting which indicates ifQuery.setParameter(org.hibernate.query.QueryParameter<T>, T)should not perform parameters validation This setting is applied only when the Session is bootstrapped via JPAEntityManagerFactorystatic StringWRAP_RESULT_SETSDeprecated.(since 5.5) Scheduled for removal in 6.0 as ResultSet wrapping is no longer neededstatic StringXML_MAPPING_ENABLEDAllows to skip processing of XML Mapping.
-
-
-
Field Detail
-
JAKARTA_PERSISTENCE_PROVIDER
static final String JAKARTA_PERSISTENCE_PROVIDER
The name of thePersistenceProviderimplementor See JPA 2 sections 9.4.3 and 8.2.1.4- See Also:
- Constant Field Values
-
JAKARTA_TRANSACTION_TYPE
static final String JAKARTA_TRANSACTION_TYPE
The type of transactions supported by the entity managers. See JPA 2 sections 9.4.3 and 8.2.1.2- See Also:
- Constant Field Values
-
JAKARTA_JTA_DATASOURCE
static final String JAKARTA_JTA_DATASOURCE
The JNDI name of a JTADataSource. See JPA 2 sections 9.4.3 and 8.2.1.5- See Also:
- Constant Field Values
-
JAKARTA_NON_JTA_DATASOURCE
static final String JAKARTA_NON_JTA_DATASOURCE
The JNDI name of a non-JTADataSource. See JPA 2 sections 9.4.3 and 8.2.1.5- See Also:
- Constant Field Values
-
JAKARTA_JDBC_DRIVER
static final String JAKARTA_JDBC_DRIVER
The name of a JDBC driver to use to connect to the database. Used in conjunction withJPA_JDBC_URL,JPA_JDBC_USERandJPA_JDBC_PASSWORDto define how to make connections to the database in lieu of a datasource (eitherJPA_JTA_DATASOURCEorJPA_NON_JTA_DATASOURCE). See section 8.2.1.9- See Also:
- Constant Field Values
-
JAKARTA_JDBC_URL
static final String JAKARTA_JDBC_URL
The JDBC connection url to use to connect to the database. Used in conjunction withJPA_JDBC_DRIVER,JPA_JDBC_USERandJPA_JDBC_PASSWORDto define how to make connections to the database in lieu of a datasource (eitherJPA_JTA_DATASOURCEorJPA_NON_JTA_DATASOURCE). See section 8.2.1.9- See Also:
- Constant Field Values
-
JAKARTA_JDBC_USER
static final String JAKARTA_JDBC_USER
The JDBC connection user name. Used in conjunction withJPA_JDBC_DRIVER,JPA_JDBC_URLandJPA_JDBC_PASSWORDto define how to make connections to the database in lieu of a datasource (eitherJPA_JTA_DATASOURCEorJPA_NON_JTA_DATASOURCE). See section 8.2.1.9- See Also:
- Constant Field Values
-
JAKARTA_JDBC_PASSWORD
static final String JAKARTA_JDBC_PASSWORD
The JDBC connection password. Used in conjunction withJPA_JDBC_DRIVER,JPA_JDBC_URLandJPA_JDBC_USERto define how to make connections to the database in lieu of a datasource (eitherJPA_JTA_DATASOURCEorJPA_NON_JTA_DATASOURCE). See JPA 2 section 8.2.1.9- See Also:
- Constant Field Values
-
JAKARTA_SHARED_CACHE_MODE
static final String JAKARTA_SHARED_CACHE_MODE
Used to indicate whether second-level (what JPA terms shared cache) caching is enabled as per the rules defined in JPA 2 section 3.1.7. See JPA 2 sections 9.4.3 and 8.2.1.7- See Also:
SharedCacheMode, Constant Field Values
-
JAKARTA_SHARED_CACHE_RETRIEVE_MODE
static final String JAKARTA_SHARED_CACHE_RETRIEVE_MODE
NOTE : Not a valid EMF property... Used to indicate if the provider should attempt to retrieve requested data in the shared cache.- See Also:
CacheRetrieveMode, Constant Field Values
-
JAKARTA_SHARED_CACHE_STORE_MODE
static final String JAKARTA_SHARED_CACHE_STORE_MODE
NOTE : Not a valid EMF property... Used to indicate if the provider should attempt to store data loaded from the database in the shared cache.- See Also:
CacheStoreMode, Constant Field Values
-
JAKARTA_VALIDATION_MODE
static final String JAKARTA_VALIDATION_MODE
Used to indicate what form of automatic validation is in effect as per rules defined in JPA 2 section 3.6.1.1 See JPA 2 sections 9.4.3 and 8.2.1.8- See Also:
ValidationMode, Constant Field Values
-
JAKARTA_VALIDATION_FACTORY
static final String JAKARTA_VALIDATION_FACTORY
Used to pass along any discovered validator factory.- See Also:
- Constant Field Values
-
JAKARTA_PERSIST_VALIDATION_GROUP
static final String JAKARTA_PERSIST_VALIDATION_GROUP
Used to coordinate with bean validators See JPA 2 section 8.2.1.9- See Also:
- Constant Field Values
-
JAKARTA_UPDATE_VALIDATION_GROUP
static final String JAKARTA_UPDATE_VALIDATION_GROUP
Used to coordinate with bean validators See JPA 2 section 8.2.1.9- See Also:
- Constant Field Values
-
JAKARTA_REMOVE_VALIDATION_GROUP
static final String JAKARTA_REMOVE_VALIDATION_GROUP
Used to coordinate with bean validators See JPA 2 section 8.2.1.9- See Also:
- Constant Field Values
-
JAKARTA_LOCK_SCOPE
static final String JAKARTA_LOCK_SCOPE
Used to request (hint) a pessimistic lock scope. See JPA 2 sections 8.2.1.9 and 3.4.4.3- See Also:
- Constant Field Values
-
JAKARTA_LOCK_TIMEOUT
static final String JAKARTA_LOCK_TIMEOUT
Used to request (hint) a pessimistic lock timeout (in milliseconds). See JPA 2 sections 8.2.1.9 and 3.4.4.3- See Also:
- Constant Field Values
-
JAKARTA_CDI_BEAN_MANAGER
static final String JAKARTA_CDI_BEAN_MANAGER
Used to pass along the CDI BeanManager, if any, to be used. According to JPA, strictly, the BeanManager should be passed in at boot-time and be ready for use at that time. However not all environments can do this (WildFly e.g.). To accommodate such environments, Hibernate provides 2 options: * a proprietary CDI extension SPI (that we have proposed to the CDI spec group as a standard option) that can be used to provide delayed BeanManager access. To use this solution, the reference passed as the BeanManager during bootstrap should be typed asExtendedBeanManager* delayed access to the BeanManager reference. Here, Hibernate will not access the reference passed as the BeanManager during bootstrap until it is first needed. Note however that this has the effect of delaying any deployment problems until after bootstrapping. This setting is used to configure Hibernate ORM's access to the BeanManager (either directly or viaExtendedBeanManager).- See Also:
- Constant Field Values
-
CLASSLOADERS
static final String CLASSLOADERS
Used to define aCollectionof theClassLoaderinstances Hibernate should use for class-loading and resource-lookups.- Since:
- 5.0
- See Also:
- Constant Field Values
-
TC_CLASSLOADER
static final String TC_CLASSLOADER
Used to define how the current thread contextClassLoadermust be used for class lookup.- See Also:
TcclLookupPrecedence, Constant Field Values
-
STATIC_METAMODEL_POPULATION
static final String STATIC_METAMODEL_POPULATION
Setting that controls whether we seek out JPA "static metamodel" classes and populate them. Accepts 3 values:- enabled -Do the population
- disabled - Do not do the population
- skipUnsupported - Do the population, but ignore any non-JPA features that would otherwise result in the population failing.
- See Also:
- Constant Field Values
-
CONNECTION_PROVIDER
static final String CONNECTION_PROVIDER
Names theConnectionProviderto use for obtaining JDBC connections. Can reference:- an instance of ConnectionProvider
- a
Class<? extends ConnectionProvider>reference - a
Class<? extends ConnectionProvider>FQN
"class"appears in the setting name due to legacy reasons; however it can accept instances.- See Also:
- Constant Field Values
-
DRIVER
static final String DRIVER
Names the JDBC driver class- See Also:
- Constant Field Values
-
URL
static final String URL
Names the JDBC connection url.- See Also:
- Constant Field Values
-
USER
static final String USER
Names the connection user. This might mean one of 2 things in out-of-the-box HibernateConnectionProvider:- The username used to pass along to create the JDBC connection
- The username used to obtain a JDBC connection from a data source
- See Also:
- Constant Field Values
-
PASS
static final String PASS
Names the connection password. See usage discussion onUSER- See Also:
- Constant Field Values
-
ISOLATION
static final String ISOLATION
Names the JDBC transaction isolation level- See Also:
- Constant Field Values
-
AUTOCOMMIT
static final String AUTOCOMMIT
Controls the autocommit mode of JDBC Connections obtained from a non-DataSource ConnectionProvider - assuming the ConnectionProvider impl properly leverages this setting (the provided Hibernate impls all do).- See Also:
- Constant Field Values
-
POOL_SIZE
static final String POOL_SIZE
Maximum number of inactive connections for the built-in Hibernate connection pool.- See Also:
- Constant Field Values
-
DATASOURCE
static final String DATASOURCE
Names aDataSource. Can reference:- a
DataSourceinstance - a JNDI name under which to locate the
DataSource
JNDI_CLASS,JNDI_URL,JNDI_PREFIX, etc.- See Also:
- Constant Field Values
- a
-
CONNECTION_PROVIDER_DISABLES_AUTOCOMMIT
static final String CONNECTION_PROVIDER_DISABLES_AUTOCOMMIT
Allows a user to tell Hibernate that the Connections we obtain from the configured ConnectionProvider will already have auto-commit disabled when we acquire them from the provider. When we get connections already in auto-commit, this allows us to circumvent some operations in the interest of performance. Default value isfalse- do not skip, aka call setAutocommit- Since:
- 5.2.10
- See Also:
- Constant Field Values
-
CONNECTION_PREFIX
static final String CONNECTION_PREFIX
Names a prefix used to define arbitrary JDBC connection properties. These properties are passed along to the JDBC provider when creating a connection.- See Also:
- Constant Field Values
-
JNDI_CLASS
static final String JNDI_CLASS
Names the JNDIInitialContextclass.
-
JNDI_URL
static final String JNDI_URL
Names the JNDI provider/connection url- See Also:
Context.PROVIDER_URL, Constant Field Values
-
JNDI_PREFIX
static final String JNDI_PREFIX
Names a prefix used to define arbitrary JNDIInitialContextproperties. These properties are passed along toInitialContext(java.util.Hashtable)- See Also:
- Constant Field Values
-
DIALECT
static final String DIALECT
Names the Hibernate SQLDialectclass- See Also:
- Constant Field Values
-
DIALECT_RESOLVERS
static final String DIALECT_RESOLVERS
Names any additionalDialectResolverimplementations to register with the standardDialectFactory.- See Also:
- Constant Field Values
-
DIALECT_DB_NAME
@Deprecated static final String DIALECT_DB_NAME
Deprecated.UseJAKARTA_HBM2DDL_DB_NAMEinsteadSpecifies the name of the database provider in cases where a Connection to the underlying database is not available (aka, mainly in generating scripts). In such cases, a value for this setting *must* be specified. The value of this setting is expected to match the value returned byDatabaseMetaData.getDatabaseProductName()for the target database. Additionally specifying "javax.persistence.database-major-version" and/or "javax.persistence.database-minor-version" may be required to understand exactly how to generate the required schema commands.
-
DIALECT_DB_VERSION
@Deprecated static final String DIALECT_DB_VERSION
Deprecated.UseJAKARTA_HBM2DDL_DB_VERSIONinsteadSpecifies the name of the database provider in cases where a Connection to the underlying database is not available (aka, mainly in generating scripts). This value is used to help more precisely determine how to perform schema generation tasks for the underlying database in cases where "javax.persistence.database-product-name" does not provide enough distinction. The value of this setting is expected to match the value returned byDatabaseMetaData.getDatabaseProductVersion()for the target database.- See Also:
DIALECT_DB_NAME, Constant Field Values
-
DIALECT_DB_MAJOR_VERSION
@Deprecated static final String DIALECT_DB_MAJOR_VERSION
Deprecated.UseJAKARTA_HBM2DDL_DB_MAJOR_VERSIONinsteadSpecifies the major version of the underlying database, as would be returned byDatabaseMetaData.getDatabaseMajorVersion()for the target database. This value is used to help more precisely determine how to perform schema generation tasks for the underlying database in cases where "javax.persistence.database-product-name" does not provide enough distinction.
-
DIALECT_DB_MINOR_VERSION
@Deprecated static final String DIALECT_DB_MINOR_VERSION
Deprecated.UseJAKARTA_HBM2DDL_DB_MINOR_VERSIONinsteadSpecifies the minor version of the underlying database, as would be returned byDatabaseMetaData.getDatabaseMinorVersion()for the target database. This setting is used in Dialect resolution
-
STORAGE_ENGINE
static final String STORAGE_ENGINE
Defines the default storage engine for the relational databases that support multiple storage engines. This property must be set either as an Environment variable or JVM System Property. That is because the Dialect is bootstrapped prior to Hibernate property resolution.- Since:
- 5.2.9
- See Also:
- Constant Field Values
-
SCHEMA_MANAGEMENT_TOOL
static final String SCHEMA_MANAGEMENT_TOOL
Used to specify theSchemaManagementToolto use for performing schema management. The default is to useHibernateSchemaManagementTool- Since:
- 5.0
- See Also:
- Constant Field Values
-
TRANSACTION_COORDINATOR_STRATEGY
static final String TRANSACTION_COORDINATOR_STRATEGY
Names the implementation ofTransactionCoordinatorBuilderto use for creatingTransactionCoordinatorinstances. Can be- TransactionCoordinatorBuilder instance
- TransactionCoordinatorBuilder implementation
Classreference - TransactionCoordinatorBuilder implementation class name (FQN) or short-name
- Since:
- 5.0
- See Also:
- Constant Field Values
-
JTA_PLATFORM
static final String JTA_PLATFORM
Names theJtaPlatformimplementation to use for integrating with JTA systems. Can reference either aJtaPlatforminstance or the name of theJtaPlatformimplementation class- Since:
- 4.0
- See Also:
- Constant Field Values
-
PREFER_USER_TRANSACTION
static final String PREFER_USER_TRANSACTION
Should we prefer using theJtaPlatform.retrieveUserTransaction()over usingJtaPlatform.retrieveTransactionManager()? Default isfalse- Since:
- 5.0
- See Also:
- Constant Field Values
-
JTA_PLATFORM_RESOLVER
static final String JTA_PLATFORM_RESOLVER
Names theJtaPlatformResolverimplementation to use.- Since:
- 4.3
- See Also:
- Constant Field Values
-
JTA_CACHE_TM
static final String JTA_CACHE_TM
A configuration value key used to indicate that it is safe to cacheTransactionManagerreferences.- Since:
- 4.0
- See Also:
- Constant Field Values
-
JTA_CACHE_UT
static final String JTA_CACHE_UT
A configuration value key used to indicate that it is safe to cacheUserTransactionreferences.- Since:
- 4.0
- See Also:
- Constant Field Values
-
DEFAULT_CATALOG
static final String DEFAULT_CATALOG
A default database catalog name to use for unqualified tablenames
-
DEFAULT_SCHEMA
static final String DEFAULT_SCHEMA
A default database schema (owner) name to use for unqualified tablenames
-
DEFAULT_CACHE_CONCURRENCY_STRATEGY
static final String DEFAULT_CACHE_CONCURRENCY_STRATEGY
Setting used to give the name of the defaultCacheConcurrencyStrategyto use when either@Cacheableor@Cacheis used.@Cache(strategy="..")is used to override.
-
USE_NEW_ID_GENERATOR_MAPPINGS
static final String USE_NEW_ID_GENERATOR_MAPPINGS
Setting which indicates whether or not the newIdentifierGeneratorare used for AUTO, TABLE and SEQUENCE. Default istrue. Existing applications may want to disable this (set itfalse) for upgrade compatibility.
-
FORCE_DISCRIMINATOR_IN_SELECTS_BY_DEFAULT
static final String FORCE_DISCRIMINATOR_IN_SELECTS_BY_DEFAULT
-
IMPLICIT_DISCRIMINATOR_COLUMNS_FOR_JOINED_SUBCLASS
static final String IMPLICIT_DISCRIMINATOR_COLUMNS_FOR_JOINED_SUBCLASS
The legacy behavior of Hibernate is to not use discriminators for joined inheritance (Hibernate does not need the discriminator...). However, some JPA providers do need the discriminator for handling joined inheritance. In the interest of portability this capability has been added to Hibernate too. However, we want to make sure that legacy applications continue to work as well. Which puts us in a bind in terms of how to handle "implicit" discriminator mappings. The solution is to assume that the absence of discriminator metadata means to follow the legacy behavior *unless* this setting is enabled. With this setting enabled, Hibernate will interpret the absence of discriminator metadata as an indication to use the JPA defined defaults for these absent annotations. See Hibernate Jira issue HHH-6911 for additional background info.
-
IGNORE_EXPLICIT_DISCRIMINATOR_COLUMNS_FOR_JOINED_SUBCLASS
static final String IGNORE_EXPLICIT_DISCRIMINATOR_COLUMNS_FOR_JOINED_SUBCLASS
The legacy behavior of Hibernate is to not use discriminators for joined inheritance (Hibernate does not need the discriminator...). However, some JPA providers do need the discriminator for handling joined inheritance. In the interest of portability this capability has been added to Hibernate too. Existing applications rely (implicitly or explicitly) on Hibernate ignoring any DiscriminatorColumn declarations on joined inheritance hierarchies. This setting allows these applications to maintain the legacy behavior of DiscriminatorColumn annotations being ignored when paired with joined inheritance. See Hibernate Jira issue HHH-6911 for additional background info.
-
USE_NATIONALIZED_CHARACTER_DATA
static final String USE_NATIONALIZED_CHARACTER_DATA
Enable nationalized character support on all string / clob based attribute ( string, char, clob, text etc ). Default isfalse.
-
SCANNER_DEPRECATED
static final String SCANNER_DEPRECATED
The deprecated name. UseSCANNERorSCANNER_ARCHIVE_INTERPRETERinstead.- See Also:
- Constant Field Values
-
SCANNER
static final String SCANNER
Pass an implementation ofScanner. Accepts either:- an actual instance
- a reference to a Class that implements Scanner
- a fully qualified name (String) of a Class that implements Scanner
-
SCANNER_ARCHIVE_INTERPRETER
static final String SCANNER_ARCHIVE_INTERPRETER
PassArchiveDescriptorFactoryto use in the scanning process. Accepts either:- an ArchiveDescriptorFactory instance
- a reference to a Class that implements ArchiveDescriptorFactory
- a fully qualified name (String) of a Class that implements ArchiveDescriptorFactory
Scannerabout expected constructor forms.
-
SCANNER_DISCOVERY
static final String SCANNER_DISCOVERY
Identifies a comma-separate list of values indicating the types of things we should auto-detect during scanning. Allowable values include:- "class" - discover classes - .class files are discovered as managed classes
- "hbm" - discover hbm mapping files - hbm.xml files are discovered as mapping files
-
IMPLICIT_NAMING_STRATEGY
static final String IMPLICIT_NAMING_STRATEGY
Used to specify theImplicitNamingStrategyclass to use. The following short-names are defined for this setting:- "default" ->
ImplicitNamingStrategyJpaCompliantImpl - "jpa" ->
ImplicitNamingStrategyJpaCompliantImpl - "legacy-jpa" ->
ImplicitNamingStrategyLegacyJpaImpl - "legacy-hbm" ->
ImplicitNamingStrategyLegacyHbmImpl - "component-path" ->
ImplicitNamingStrategyComponentPathImpl
ImplicitNamingStrategyJpaCompliantImpl. - "default" ->
-
PHYSICAL_NAMING_STRATEGY
static final String PHYSICAL_NAMING_STRATEGY
Used to specify thePhysicalNamingStrategyclass to use.
-
ARTIFACT_PROCESSING_ORDER
static final String ARTIFACT_PROCESSING_ORDER
Used to specify the order in which metadata sources should be processed. Value is a delimited-list whose elements are defined byMetadataSourceType. Default is"hbm,class"which indicates to processhbm.xmlfiles followed by annotations (combined withorm.xmlmappings).
-
KEYWORD_AUTO_QUOTING_ENABLED
static final String KEYWORD_AUTO_QUOTING_ENABLED
Specifies whether to automatically quote any names that are deemed keywords. Auto-quoting is disabled by default. Set to true to enable it.- Since:
- 5.0
- See Also:
- Constant Field Values
-
XML_MAPPING_ENABLED
static final String XML_MAPPING_ENABLED
Allows to skip processing of XML Mapping. This is for people using exclusively annotations to define their model, and might be able to improve efficiency of booting Hibernate ORM. By default, the XML mapping is taken into account.- Since:
- 5.4.1
- See Also:
- Constant Field Values
-
SESSION_FACTORY_NAME
static final String SESSION_FACTORY_NAME
Setting used to name the HibernateSessionFactory. Naming the SessionFactory allows for it to be properly serialized across JVMs as long as the same name is used on each JVM. IfSESSION_FACTORY_NAME_IS_JNDIis set totrue, this is also the name under which the SessionFactory is bound into JNDI on startup and from which it can be obtained from JNDI.- See Also:
SESSION_FACTORY_NAME_IS_JNDI,SessionFactoryRegistry, Constant Field Values
-
SESSION_FACTORY_NAME_IS_JNDI
static final String SESSION_FACTORY_NAME_IS_JNDI
Does the value defined bySESSION_FACTORY_NAMErepresent a JNDI namespace into which theSessionFactoryshould be bound and made accessible? Defaults totruefor backwards compatibility. Set this tofalseif naming a SessionFactory is needed for serialization purposes, but no writable JNDI context exists in the runtime environment or if the user simply does not want JNDI to be used.- See Also:
SESSION_FACTORY_NAME, Constant Field Values
-
SHOW_SQL
static final String SHOW_SQL
Enable logging of generated SQL to the console- See Also:
- Constant Field Values
-
FORMAT_SQL
static final String FORMAT_SQL
Enable formatting of SQL logged to the console- See Also:
- Constant Field Values
-
HIGHLIGHT_SQL
static final String HIGHLIGHT_SQL
Enable highlighting of SQL logged to the console using ANSI escape codes- See Also:
- Constant Field Values
-
USE_SQL_COMMENTS
static final String USE_SQL_COMMENTS
Add comments to the generated SQL- See Also:
- Constant Field Values
-
SHOW_HQL_FUNCTIONS
static final String SHOW_HQL_FUNCTIONS
Enable logging of functions registered by the configured SQLDialect.- See Also:
- Constant Field Values
-
MAX_FETCH_DEPTH
static final String MAX_FETCH_DEPTH
Maximum depth of outer join fetching- See Also:
- Constant Field Values
-
DEFAULT_BATCH_FETCH_SIZE
static final String DEFAULT_BATCH_FETCH_SIZE
The default batch size for batch fetching- See Also:
- Constant Field Values
-
USE_STREAMS_FOR_BINARY
static final String USE_STREAMS_FOR_BINARY
Use java.io streams to read / write binary data from / to JDBC- See Also:
- Constant Field Values
-
USE_SCROLLABLE_RESULTSET
static final String USE_SCROLLABLE_RESULTSET
Use JDBC scrollable ResultSets. This property is only necessary when there is no ConnectionProvider, ie. the user is supplying JDBC connections.- See Also:
- Constant Field Values
-
USE_GET_GENERATED_KEYS
static final String USE_GET_GENERATED_KEYS
Tells the JDBC driver to attempt to retrieve row Id with the JDBC 3.0 PreparedStatement.getGeneratedKeys() method. In general, performance will be better if this property is set to true and the underlying JDBC driver supports getGeneratedKeys().- See Also:
- Constant Field Values
-
STATEMENT_FETCH_SIZE
static final String STATEMENT_FETCH_SIZE
Gives the JDBC driver a hint as to the number of rows that should be fetched from the database when more rows are needed. If 0, JDBC driver default settings will be used.- See Also:
- Constant Field Values
-
STATEMENT_BATCH_SIZE
static final String STATEMENT_BATCH_SIZE
Maximum JDBC batch size. A nonzero value enables batch updates.- See Also:
- Constant Field Values
-
BATCH_STRATEGY
static final String BATCH_STRATEGY
Select a custom batcher.- See Also:
- Constant Field Values
-
BATCH_VERSIONED_DATA
static final String BATCH_VERSIONED_DATA
Should versioned data be included in batching?- See Also:
- Constant Field Values
-
JDBC_TIME_ZONE
static final String JDBC_TIME_ZONE
Default JDBC TimeZone. Unless specified, the JVM default TimeZone is going to be used by the underlying JDBC Driver.- Since:
- 5.2.3
- See Also:
- Constant Field Values
-
AUTO_CLOSE_SESSION
static final String AUTO_CLOSE_SESSION
Enable automatic session close at end of transaction- See Also:
- Constant Field Values
-
FLUSH_BEFORE_COMPLETION
static final String FLUSH_BEFORE_COMPLETION
Enable automatic flush during the JTA beforeCompletion() callback- See Also:
- Constant Field Values
-
CONNECTION_HANDLING
static final String CONNECTION_HANDLING
Specifies how Hibernate should manage JDBC connections in terms of acquiring and releasing.- Since:
- 5.2
- See Also:
PhysicalConnectionHandlingMode, Constant Field Values
-
CURRENT_SESSION_CONTEXT_CLASS
static final String CURRENT_SESSION_CONTEXT_CLASS
Context scoping impl forSessionFactory.getCurrentSession()processing.- See Also:
- Constant Field Values
-
USE_IDENTIFIER_ROLLBACK
static final String USE_IDENTIFIER_ROLLBACK
- See Also:
- Constant Field Values
-
USE_REFLECTION_OPTIMIZER
static final String USE_REFLECTION_OPTIMIZER
Use bytecode libraries optimized property access- See Also:
- Constant Field Values
-
ENFORCE_LEGACY_PROXY_CLASSNAMES
static final String ENFORCE_LEGACY_PROXY_CLASSNAMES
Configure the global BytecodeProvider implementation to generate class names matching the existing naming patterns. It is not a good idea to rely on a classname to check if a class is an Hibernate proxy, yet some frameworks are currently relying on this. This option is disabled by default and will log a deprecation warning when enabled.- See Also:
- Constant Field Values
-
NATIVE_QUERY_ORDINAL_PARAMETER_BASE
static final String NATIVE_QUERY_ORDINAL_PARAMETER_BASE
Controls the base integer for binding JDBC-style (?) ordinal parameters when the Hibernate SessionFactory is bootstrapped via the native bootstrapping API. JPA says that all non-named parameter binding is explicitly 1-based; so when bootstrapped via JPA, Hibernate always treats these as 1-based. Note that this affects only ordinal parameters. Positional parameters (e.g.?1) explicitly define the binding position (1) in their declaration, whereas the binding position is implicit with ordinal parameters based on its ordinal position in the query. As of 6.0, support for this ordinal parameter declaration form has been removed from HQL and is now only valid forNativeQuerys. Historically Hibernate followed JDBC conventions for ordinal parameter binding such that the implied positions were 0-based. This presents a mismatch between how to bind ordinal parameters based on how the SessionFactory was bootstrapped, which is not ideal. This setting then seeks to allow unifying how these are handled regardless of the bootstrap method. The expected value of this setting is an integer value of either 0 (the default) or 1. The default follows the legacy expectations and allows legacy Hibernate apps to continue to work. Setting this to 1 (one) allows all non-named parameter binding to be unified as 1-based.- Since:
- 6.0
- See Also:
- Constant Field Values
-
CALLABLE_NAMED_PARAMS_ENABLED
static final String CALLABLE_NAMED_PARAMS_ENABLED
Global setting name for controlling whether Hibernate should try to map named parameter names specified in aProcedureCallorStoredProcedureQueryto named parameters in the JDBCCallableStatement.- Since:
- 6.0
- See Also:
SessionFactoryOptions.isUseOfJdbcNamedParametersEnabled(), Constant Field Values
-
ALLOW_ENHANCEMENT_AS_PROXY
@Deprecated static final String ALLOW_ENHANCEMENT_AS_PROXY
Deprecated.(as of 5.5) with no replacement. When using enhancement based lazy loading using the enhanced class as proxy is always used when appropriate.Should Hibernate use enhanced entities "as a proxy"? E.g., when an application usesSession.load(java.lang.Class<T>, java.lang.Object, org.hibernate.LockMode)against an enhanced class, enabling this will allow Hibernate to create an "empty" instance of the enhanced class to act as the proxy - it contains just the identifier which is later used to trigger the base initialization but no other data is loaded Not enabling this (the legacy default behavior) would cause the "base" attributes to be loaded. Any lazy-group attributes would not be initialized. Applications using bytecode enhancement and switching to allowing this should be careful in use of the variousHibernatemethods such asHibernate.isInitialized(java.lang.Object),Hibernate.isPropertyInitialized(java.lang.Object, java.lang.String), etc - enabling this setting changes the results of those methods- See Also:
- Constant Field Values
- "Implementation Specification:"
- See
EnhancementAsProxyLazinessInterceptor
-
QUERY_TRANSLATOR
@Deprecated static final String QUERY_TRANSLATOR
Deprecated.The classname of the HQL query parser factory- See Also:
- Constant Field Values
-
SEMANTIC_QUERY_PRODUCER
static final String SEMANTIC_QUERY_PRODUCER
Names theHqlTranslatorclass to use.- See Also:
- Constant Field Values
-
SEMANTIC_QUERY_TRANSLATOR
static final String SEMANTIC_QUERY_TRANSLATOR
Names theSqmTranslatorFactoryclass to use.- See Also:
- Constant Field Values
-
HQL_BULK_ID_STRATEGY
@Deprecated static final String HQL_BULK_ID_STRATEGY
Deprecated.UseQUERY_MULTI_TABLE_MUTATION_STRATEGYinstead- See Also:
- Constant Field Values
-
ID_TABLE_STRATEGY
@Deprecated static final String ID_TABLE_STRATEGY
Deprecated.UseQUERY_MULTI_TABLE_MUTATION_STRATEGYinstead- See Also:
- Constant Field Values
-
QUERY_MULTI_TABLE_MUTATION_STRATEGY
static final String QUERY_MULTI_TABLE_MUTATION_STRATEGY
Defines the "global" strategy to use for handling HQL and Criteria mutation queries. Names theSqmMultiTableMutationStrategyto use.- See Also:
- Constant Field Values
-
QUERY_SUBSTITUTIONS
static final String QUERY_SUBSTITUTIONS
A comma-separated list of token substitutions to use when translating a Hibernate query to SQL- See Also:
- Constant Field Values
-
QUERY_STARTUP_CHECKING
static final String QUERY_STARTUP_CHECKING
Should named queries be checked during startup (the default is enabled). Mainly intended for test environments.- See Also:
- Constant Field Values
-
CONVENTIONAL_JAVA_CONSTANTS
static final String CONVENTIONAL_JAVA_CONSTANTS
Setting which indicates whether or not Java constant follow the Java Naming conventions. Default istrue. Existing applications may want to disable this (set itfalse) if non-conventional Java constants are used. However, there is a significant performance overhead for using non-conventional Java constants since Hibernate cannot determine if aliases should be treated as Java constants or not.- Since:
- 5.2
- See Also:
- Constant Field Values
-
SQL_EXCEPTION_CONVERTER
static final String SQL_EXCEPTION_CONVERTER
TheSQLExceptionConverterto use for converting SQLExceptions to Hibernate's JDBCException hierarchy. The default is to use the configuredDialect's preferred SQLExceptionConverter.- See Also:
- Constant Field Values
-
WRAP_RESULT_SETS
@Deprecated static final String WRAP_RESULT_SETS
Deprecated.(since 5.5) Scheduled for removal in 6.0 as ResultSet wrapping is no longer neededEnable wrapping of JDBC result sets in order to speed up column name lookups for broken JDBC drivers- See Also:
- Constant Field Values
-
NATIVE_EXCEPTION_HANDLING_51_COMPLIANCE
static final String NATIVE_EXCEPTION_HANDLING_51_COMPLIANCE
Indicates if exception handling for a SessionFactory built via Hibernate's native bootstrapping should behave the same as native exception handling in Hibernate ORM 5.1, When set totrue,HibernateExceptionwill not be wrapped or converted according to the JPA specification. This setting will be ignored for a SessionFactory built via JPA bootstrapping. Values aretrueorfalse. Default value isfalse- See Also:
- Constant Field Values
-
ORDER_UPDATES
static final String ORDER_UPDATES
Enable ordering of update statements by primary key value- See Also:
- Constant Field Values
-
ORDER_INSERTS
static final String ORDER_INSERTS
Enable ordering of insert statements for the purpose of more efficient JDBC batching.- See Also:
- Constant Field Values
-
JPA_CALLBACKS_ENABLED
static final String JPA_CALLBACKS_ENABLED
JPA Callbacks are enabled by default. Set this tofalseto disable them. Mostly useful to save a bit of memory when they are not used. Experimental and will likely be removed as soon as the memory overhead is resolved.- Since:
- 5.4
- See Also:
- Constant Field Values
-
DEFAULT_NULL_ORDERING
static final String DEFAULT_NULL_ORDERING
Default precedence of null values inORDER BYclause. Supported options:none(default),first,last.- See Also:
- Constant Field Values
-
LOG_JDBC_WARNINGS
static final String LOG_JDBC_WARNINGS
Enable fetching JDBC statement warning for logging. Values aretrueorfalse. Default value isDialect.isJdbcLogWarningsEnabledByDefault()- Since:
- 5.1
- See Also:
- Constant Field Values
-
BEAN_CONTAINER
static final String BEAN_CONTAINER
Identifies an explicitBeanContainerto be used. Note that for CDI-based containers setting this is not necessary - simply pass the BeanManager to use viaCDI_BEAN_MANAGERand optionally specifyDELAY_CDI_ACCESS. This setting is more meant to integrate non-CDI bean containers such as Spring.- Since:
- 5.3
- See Also:
- Constant Field Values
-
DELAY_CDI_ACCESS
static final String DELAY_CDI_ACCESS
Used in conjunction with "hibernate.resource.beans.container" where CDI is being used. By default, to be JPA spec compliant, Hibernate should access the CDIBeanManagerwhile bootstrapping the SessionFactory. In some cases however this can lead to a chicken-egg situation where JPA provider immediately accessed the BeanManager where managed-beans are waiting for JPA PU injection. This setting tells Hibernate to delay accessing until first use. This setting has the decided downside that bean config problems will not be done at deployment time, but will instead manifest at runtime. For this reason, the preferred means for supplying a CDI BeanManager is to provide an implementation ofExtendedBeanManagerwhich gives Hibernate a callback when the BeanManager is ready for use.- Since:
- 5.0.8
- See Also:
- Constant Field Values
-
C3P0_CONFIG_PREFIX
static final String C3P0_CONFIG_PREFIX
A setting prefix used to indicate settings that target the hibernate-c3p0 integration- See Also:
- Constant Field Values
-
C3P0_MAX_SIZE
static final String C3P0_MAX_SIZE
Maximum size of C3P0 connection pool- See Also:
- Constant Field Values
-
C3P0_MIN_SIZE
static final String C3P0_MIN_SIZE
Minimum size of C3P0 connection pool- See Also:
- Constant Field Values
-
C3P0_TIMEOUT
static final String C3P0_TIMEOUT
Maximum idle time for C3P0 connection pool- See Also:
- Constant Field Values
-
C3P0_MAX_STATEMENTS
static final String C3P0_MAX_STATEMENTS
Maximum size of C3P0 statement cache- See Also:
- Constant Field Values
-
C3P0_ACQUIRE_INCREMENT
static final String C3P0_ACQUIRE_INCREMENT
Number of connections acquired when pool is exhausted- See Also:
- Constant Field Values
-
C3P0_IDLE_TEST_PERIOD
static final String C3P0_IDLE_TEST_PERIOD
Idle time before a C3P0 pooled connection is validated- See Also:
- Constant Field Values
-
PROXOOL_CONFIG_PREFIX
static final String PROXOOL_CONFIG_PREFIX
A setting prefix used to indicate settings that target the hibernate-proxool integration- See Also:
- Constant Field Values
-
PROXOOL_XML
static final String PROXOOL_XML
Proxool property to configure the Proxool Provider using an XML (/path/to/file.xml)- See Also:
- Constant Field Values
-
PROXOOL_PROPERTIES
static final String PROXOOL_PROPERTIES
Proxool property to configure the Proxool Provider using a properties file (/path/to/proxool.properties)- See Also:
- Constant Field Values
-
PROXOOL_EXISTING_POOL
static final String PROXOOL_EXISTING_POOL
Proxool property to configure the Proxool Provider from an already existing pool (true / false)- See Also:
- Constant Field Values
-
PROXOOL_POOL_ALIAS
static final String PROXOOL_POOL_ALIAS
Proxool property with the Proxool pool alias to use (Required for PROXOOL_EXISTING_POOL, PROXOOL_PROPERTIES, or PROXOOL_XML)- See Also:
- Constant Field Values
-
CACHE_REGION_FACTORY
static final String CACHE_REGION_FACTORY
TheRegionFactoryimplementation. Can refer to:- an Object implementing
RegionFactory - a Class implementing
RegionFactory - FQN of a Class implementing
RegionFactory
- See Also:
- Constant Field Values
- an Object implementing
-
CACHE_KEYS_FACTORY
static final String CACHE_KEYS_FACTORY
Allow control to specify theCacheKeysFactoryimpl to use. Can refer to:- an Object implementing
CacheKeysFactory - a Class implementing
CacheKeysFactory - FQN of a Class implementing
CacheKeysFactory - 'default' as a short name for
DefaultCacheKeysFactory - 'simple' as a short name for
SimpleCacheKeysFactory
- Since:
- 5.2 - note that currently this is only honored for hibernate-infinispan
- See Also:
- Constant Field Values
- an Object implementing
-
CACHE_PROVIDER_CONFIG
static final String CACHE_PROVIDER_CONFIG
The CacheProvider implementation class- See Also:
- Constant Field Values
-
USE_SECOND_LEVEL_CACHE
static final String USE_SECOND_LEVEL_CACHE
Enable the second-level cache.By default, if the currently configured
RegionFactoryis not theNoCachingRegionFactory, then the second-level cache is going to be enabled. Otherwise, the second-level cache is disabled.- See Also:
- Constant Field Values
-
USE_QUERY_CACHE
static final String USE_QUERY_CACHE
Enable the query cache (disabled by default)- See Also:
- Constant Field Values
-
QUERY_CACHE_FACTORY
static final String QUERY_CACHE_FACTORY
TheTimestampsCacheFactoryimplementation class.- See Also:
- Constant Field Values
-
CACHE_REGION_PREFIX
static final String CACHE_REGION_PREFIX
The CacheProvider region name prefix- See Also:
- Constant Field Values
-
USE_MINIMAL_PUTS
static final String USE_MINIMAL_PUTS
Optimize the cache for minimal puts instead of minimal gets- See Also:
- Constant Field Values
-
USE_STRUCTURED_CACHE
static final String USE_STRUCTURED_CACHE
Enable use of structured second-level cache entries- See Also:
- Constant Field Values
-
AUTO_EVICT_COLLECTION_CACHE
static final String AUTO_EVICT_COLLECTION_CACHE
Enables the automatic eviction of a bi-directional association's collection cache when an element in the ManyToOne collection is added/updated/removed without properly managing the change on the OneToMany side.- See Also:
- Constant Field Values
-
USE_DIRECT_REFERENCE_CACHE_ENTRIES
static final String USE_DIRECT_REFERENCE_CACHE_ENTRIES
Enable direct storage of entity references into the second level cache when applicable (immutable data, etc). Default is to not store direct references.- See Also:
- Constant Field Values
-
GLOBALLY_QUOTED_IDENTIFIERS
static final String GLOBALLY_QUOTED_IDENTIFIERS
Should all database identifiers be quoted. Atrue/falseoption.- See Also:
- Constant Field Values
-
GLOBALLY_QUOTED_IDENTIFIERS_SKIP_COLUMN_DEFINITIONS
static final String GLOBALLY_QUOTED_IDENTIFIERS_SKIP_COLUMN_DEFINITIONS
AssumingGLOBALLY_QUOTED_IDENTIFIERS, this allows such global quoting to skip column-definitions as defined byColumn,JoinColumn, etc. JPA states that column-definitions are subject to global quoting, so by default this setting isfalsefor JPA compliance. Set totrueto avoid column-definitions being quoted due to global quoting (they will still be quoted if explicitly quoted in the annotation/xml).- See Also:
- Constant Field Values
-
CHECK_NULLABILITY
static final String CHECK_NULLABILITY
Enable nullability checking. Raises an exception if a property marked as not-null is null. Default to false if Bean Validation is present in the classpath and Hibernate Annotations is used, true otherwise.- See Also:
- Constant Field Values
-
BYTECODE_PROVIDER
static final String BYTECODE_PROVIDER
Pick which bytecode enhancing library to use. Currently supports only bytebuddy, bytebuddy being the default since version 5.3.- See Also:
- Constant Field Values
-
JPAQL_STRICT_COMPLIANCE
static final String JPAQL_STRICT_COMPLIANCE
- See Also:
- Constant Field Values
-
PREFERRED_POOLED_OPTIMIZER
static final String PREFERRED_POOLED_OPTIMIZER
When a generator specified an increment-size and an optimizer was not explicitly specified, which of the "pooled" optimizers should be preferred? Can specify an optimizer short name or an Optimizer impl FQN.- See Also:
- Constant Field Values
-
QUERY_PLAN_CACHE_ENABLED
static final String QUERY_PLAN_CACHE_ENABLED
Should query plan caching be enabled at all? Default isfalseunless one ofQUERY_PLAN_CACHE_MAX_SIZEorQUERY_PLAN_CACHE_PARAMETER_METADATA_MAX_SIZEis specified- See Also:
- Constant Field Values
-
QUERY_PLAN_CACHE_MAX_SIZE
static final String QUERY_PLAN_CACHE_MAX_SIZE
The maximum number of entries in the Hibernate "Query Plan Cache". The default size is 2048.- See Also:
QueryPlanCache, Constant Field Values
-
QUERY_PLAN_CACHE_PARAMETER_METADATA_MAX_SIZE
static final String QUERY_PLAN_CACHE_PARAMETER_METADATA_MAX_SIZE
The maximum number ofParameterMetadataImplmaintained byQueryInterpretationCache. Default is 128.- See Also:
- Constant Field Values
-
NON_CONTEXTUAL_LOB_CREATION
static final String NON_CONTEXTUAL_LOB_CREATION
Should we not use contextual LOB creation (aka based onConnection.createBlob()et al).- See Also:
- Constant Field Values
-
HBM2DDL_AUTO
static final String HBM2DDL_AUTO
Setting to perform SchemaManagementTool actions automatically as part of the SessionFactory lifecycle. Valid options are defined by theActionenum. Interpreted in combination withHBM2DDL_DATABASE_ACTIONandHBM2DDL_SCRIPTS_ACTION. If no value is specified, the default is "none" (Action.NONE).- See Also:
Action, Constant Field Values
-
HBM2DDL_DATABASE_ACTION
@Deprecated static final String HBM2DDL_DATABASE_ACTION
Deprecated.UseJAKARTA_HBM2DDL_SCRIPTS_ACTIONinstead- See Also:
- Constant Field Values
-
HBM2DDL_SCRIPTS_ACTION
@Deprecated static final String HBM2DDL_SCRIPTS_ACTION
Deprecated.UseJAKARTA_HBM2DDL_SCRIPTS_ACTIONinstead- See Also:
- Constant Field Values
-
HBM2DDL_CONNECTION
@Deprecated static final String HBM2DDL_CONNECTION
Deprecated.UseJAKARTA_HBM2DDL_CONNECTIONinstead- See Also:
- Constant Field Values
-
HBM2DDL_CREATE_SOURCE
static final String HBM2DDL_CREATE_SOURCE
Specifies whether schema generation commands for schema creation are to be determined based on object/relational mapping metadata, DDL scripts, or a combination of the two. SeeSourceTypefor valid set of values. If no value is specified, a default is assumed as follows:- if source scripts are specified (per "javax.persistence.schema-generation.create-script-source"),then "scripts" is assumed
- otherwise, "metadata" is assumed
- See Also:
SourceType, Constant Field Values
-
HBM2DDL_DROP_SOURCE
static final String HBM2DDL_DROP_SOURCE
Specifies whether schema generation commands for schema dropping are to be determined based on object/relational mapping metadata, DDL scripts, or a combination of the two. SeeSourceTypefor valid set of values. If no value is specified, a default is assumed as follows:- if source scripts are specified (per "javax.persistence.schema-generation.drop-script-source"),then "scripts" is assumed
- otherwise, "metadata" is assumed
- See Also:
SourceType, Constant Field Values
-
HBM2DDL_CREATE_SCRIPT_SOURCE
static final String HBM2DDL_CREATE_SCRIPT_SOURCE
Specifies the CREATE script file as either aReaderconfigured for reading of the DDL script file or a string designating a fileURLfor the DDL script. Hibernate historically also acceptedHBM2DDL_IMPORT_FILESfor a similar purpose. This setting should be preferred overHBM2DDL_IMPORT_FILESmoving forward
-
HBM2DDL_DROP_SCRIPT_SOURCE
static final String HBM2DDL_DROP_SCRIPT_SOURCE
Specifies the DROP script file as either aReaderconfigured for reading of the DDL script file or a string designating a fileURLfor the DDL script.- See Also:
HBM2DDL_DROP_SOURCE, Constant Field Values
-
HBM2DDL_SCRIPTS_CREATE_TARGET
static final String HBM2DDL_SCRIPTS_CREATE_TARGET
For cases where the "javax.persistence.schema-generation.scripts.action" value indicates that schema creation commands should be written to DDL script file, "javax.persistence.schema-generation.scripts.create-target" specifies either aWriterconfigured for output of the DDL script or a string specifying the file URL for the DDL script.- See Also:
HBM2DDL_SCRIPTS_ACTION, Constant Field Values
-
HBM2DDL_SCRIPTS_CREATE_APPEND
static final String HBM2DDL_SCRIPTS_CREATE_APPEND
For cases where the "javax.persistence.schema-generation.scripts.action" value indicates that schema commands should be written to DDL script file, specifies if schema commands should be appended to the end of the file rather than written at the beginning of the file. Values are:truefor appending schema commands to the end of the file,falsefor writing schema commands at the beginning. The default value istrue- See Also:
- Constant Field Values
-
HBM2DDL_SCRIPTS_DROP_TARGET
static final String HBM2DDL_SCRIPTS_DROP_TARGET
For cases where the "javax.persistence.schema-generation.scripts.action" value indicates that schema drop commands should be written to DDL script file, "javax.persistence.schema-generation.scripts.drop-target" specifies either aWriterconfigured for output of the DDL script or a string specifying the file URL for the DDL script.- See Also:
HBM2DDL_SCRIPTS_ACTION, Constant Field Values
-
HBM2DDL_IMPORT_FILES
static final String HBM2DDL_IMPORT_FILES
Comma-separated names of the optional files containing SQL DML statements executed during the SessionFactory creation. File order matters, the statements of a give file are executed before the statements of the following files. These statements are only executed if the schema is created ie if hibernate.hbm2ddl.auto is set to create or create-drop. The default value is /import.sqlHBM2DDL_CREATE_SCRIPT_SOURCE/HBM2DDL_DROP_SCRIPT_SOURCEshould be preferred moving forward- See Also:
- Constant Field Values
-
HBM2DDL_LOAD_SCRIPT_SOURCE
@Deprecated static final String HBM2DDL_LOAD_SCRIPT_SOURCE
Deprecated.UseJAKARTA_HBM2DDL_LOAD_SCRIPT_SOURCEinstead- See Also:
- Constant Field Values
-
HBM2DDL_IMPORT_FILES_SQL_EXTRACTOR
static final String HBM2DDL_IMPORT_FILES_SQL_EXTRACTOR
Reference to theorg.hibernate.tool.hbm2ddl.ImportSqlCommandExtractorimplementation class to use for parsing source/import files as defined byHBM2DDL_CREATE_SCRIPT_SOURCE,HBM2DDL_DROP_SCRIPT_SOURCEorHBM2DDL_IMPORT_FILES. Reference may refer to an instance, a Class implementing ImportSqlCommandExtractor of the FQN of the ImportSqlCommandExtractor implementation. If the FQN is given, the implementation must provide a no-arg constructor. The default value isorg.hibernate.tool.hbm2ddl.SingleLineSqlCommandExtractor.- See Also:
- Constant Field Values
-
HBM2DDL_CREATE_NAMESPACES
static final String HBM2DDL_CREATE_NAMESPACES
Specifies whether to automatically create also the database schema/catalog. The default is false.- Since:
- 5.0
- See Also:
- Constant Field Values
-
HBM2DDL_CREATE_SCHEMAS
@Deprecated static final String HBM2DDL_CREATE_SCHEMAS
Deprecated.UseJAKARTA_HBM2DDL_CREATE_SCHEMASinstead- See Also:
- Constant Field Values
-
JAKARTA_HBM2DDL_DATABASE_ACTION
static final String JAKARTA_HBM2DDL_DATABASE_ACTION
Specifies what type (including none) of schema-tooling should be performed against the database specified using either "jakarta.persistence.schema-generation-connection" or the configuredConnectionProviderfor the SessionFactory. Valid options are defined by theActionenum. Works in conjunction with "hibernate.hbm2ddl.auto", with "jakarta.persistence.schema-generation.database.action" having precedence. If no value is specified, the default is "none" (Action.NONE).
-
JAKARTA_HBM2DDL_SCRIPTS_ACTION
static final String JAKARTA_HBM2DDL_SCRIPTS_ACTION
Specifies what type (including none) of schema-tooling should be written to script files. Valid options are defined by theActionenum. The script file is identified using "jakarta.persistence.schema-generation.scripts.create-target" If no value is specified, the default is "none" (Action.NONE).
-
JAKARTA_HBM2DDL_CONNECTION
static final String JAKARTA_HBM2DDL_CONNECTION
Allows passing a specificConnectioninstance to be used by SchemaManagementTool for the purpose of Dialect determination as well as {@value #JAKARTA_HBM2DDL_DATABASE_ACTION database actions} if requested. For Dialect resolution, "jakarta.persistence.database-product-name" and optionally "jakarta.persistence.database-product-version", "jakarta.persistence.database-major-version" and "jakarta.persistence.database-minor-version" can be used instead
-
JAKARTA_HBM2DDL_DB_NAME
static final String JAKARTA_HBM2DDL_DB_NAME
Specifies the name of the database vendor (as would be reported byDatabaseMetaData.getDatabaseProductName()) for the purpose of determining the Dialect to use. For cases when the name of the database vendor is not enough alone, a combination of "jakarta.persistence.database-product-version", "jakarta.persistence.database-major-version" "jakarta.persistence.database-minor-version" can be used instead- See Also:
JAKARTA_HBM2DDL_DB_VERSION,JAKARTA_HBM2DDL_DB_MAJOR_VERSION,JAKARTA_HBM2DDL_DB_MINOR_VERSION, Constant Field Values- "Implementation Specification:"
- {@value #JAKARTA_HBM2DDL_DATABASE_ACTION database actions} are not available when supplying just the name and versions
-
JAKARTA_HBM2DDL_DB_VERSION
static final String JAKARTA_HBM2DDL_DB_VERSION
Used in conjunction with "jakarta.persistence.database-product-name" for the purpose of determining the Dialect to use when the name does not provide enough detail. The value is expected to match what would be returned fromDatabaseMetaData.getDatabaseProductVersion()) for the underlying database.- See Also:
JAKARTA_HBM2DDL_DB_NAME, Constant Field Values
-
JAKARTA_HBM2DDL_DB_MAJOR_VERSION
static final String JAKARTA_HBM2DDL_DB_MAJOR_VERSION
Used in conjunction with "jakarta.persistence.database-product-name" for the purpose of determining the Dialect to use when the name does not provide enough detail. The value is expected to match what would be returned fromDatabaseMetaData.getDatabaseMajorVersion()) for the underlying database.- See Also:
JAKARTA_HBM2DDL_DB_NAME, Constant Field Values
-
JAKARTA_HBM2DDL_DB_MINOR_VERSION
static final String JAKARTA_HBM2DDL_DB_MINOR_VERSION
Used in conjunction with "jakarta.persistence.database-product-name" for the purpose of determining the Dialect to use when the name does not provide enough detail. The value is expected to match what would be returned fromDatabaseMetaData.getDatabaseMinorVersion()) for the underlying database.- See Also:
JAKARTA_HBM2DDL_DB_NAME, Constant Field Values
-
JAKARTA_HBM2DDL_CREATE_SOURCE
static final String JAKARTA_HBM2DDL_CREATE_SOURCE
Specifies whether schema generation commands for schema creation are to be determined based on object/relational mapping metadata, DDL scripts, or a combination of the two. SeeSourceTypefor valid set of values. If no value is specified, a default is assumed as follows:- if source scripts are specified (per "javax.persistence.schema-generation.create-script-source"),then "scripts" is assumed
- otherwise, "metadata" is assumed
- See Also:
SourceType, Constant Field Values
-
JAKARTA_HBM2DDL_DROP_SOURCE
static final String JAKARTA_HBM2DDL_DROP_SOURCE
Specifies whether schema generation commands for schema dropping are to be determined based on object/relational mapping metadata, DDL scripts, or a combination of the two. SeeSourceTypefor valid set of values. If no value is specified, a default is assumed as follows:- if source scripts are specified (per "javax.persistence.schema-generation.drop-script-source"),then "scripts" is assumed
- otherwise, "metadata" is assumed
- See Also:
SourceType, Constant Field Values
-
JAKARTA_HBM2DDL_CREATE_SCRIPT_SOURCE
static final String JAKARTA_HBM2DDL_CREATE_SCRIPT_SOURCE
Specifies the CREATE script file as either aReaderconfigured for reading of the DDL script file or a string designating a fileURLfor the DDL script. Hibernate historically also acceptedHBM2DDL_IMPORT_FILESfor a similar purpose. This setting should be preferred overHBM2DDL_IMPORT_FILESmoving forward
-
JAKARTA_HBM2DDL_DROP_SCRIPT_SOURCE
static final String JAKARTA_HBM2DDL_DROP_SCRIPT_SOURCE
Specifies the DROP script file as either aReaderconfigured for reading of the DDL script file or a string designating a fileURLfor the DDL script.- See Also:
HBM2DDL_DROP_SOURCE, Constant Field Values
-
JAKARTA_HBM2DDL_SCRIPTS_CREATE_TARGET
static final String JAKARTA_HBM2DDL_SCRIPTS_CREATE_TARGET
For cases where "jakarta.persistence.schema-generation.scripts.action" indicates that schema creation commands should be written to a script file, this setting specifies either aWriterconfigured for output of the DDL script or a string specifying the file URL for the DDL script.
-
JAKARTA_HBM2DDL_SCRIPTS_DROP_TARGET
static final String JAKARTA_HBM2DDL_SCRIPTS_DROP_TARGET
For cases where "jakarta.persistence.schema-generation.scripts.action" indicates that schema drop commands should be written to a script file, this setting specifies either aWriterconfigured for output of the DDL script or a string specifying the file URL for the DDL script.
-
JAKARTA_HBM2DDL_LOAD_SCRIPT_SOURCE
static final String JAKARTA_HBM2DDL_LOAD_SCRIPT_SOURCE
JPA variant ofHBM2DDL_IMPORT_FILESfor specifying a database initialization script to be run as part of schema-export Specifies aReaderconfigured for reading of the SQL load script or a string designating theURLfor the SQL load script.- See Also:
- Constant Field Values
-
JAKARTA_HBM2DDL_CREATE_SCHEMAS
static final String JAKARTA_HBM2DDL_CREATE_SCHEMAS
The JPA variant ofHBM2DDL_CREATE_NAMESPACESused to specify whether database schemas used in the mapping model should be created on export in addition to creating the tables, sequences, etc. The default isfalse, meaning to not create schemas- See Also:
- Constant Field Values
-
HBM2DDL_FILTER_PROVIDER
static final String HBM2DDL_FILTER_PROVIDER
Used to specify theSchemaFilterProviderto be used by create, drop, migrate and validate operations on the database schema. SchemaFilterProvider provides filters that can be used to limit the scope of these operations to specific namespaces, tables and sequences. All objects are included by default.- Since:
- 5.1
- See Also:
- Constant Field Values
-
HBM2DDL_JDBC_METADATA_EXTRACTOR_STRATEGY
static final String HBM2DDL_JDBC_METADATA_EXTRACTOR_STRATEGY
Setting to choose the strategy used to access the JDBC Metadata. Valid options are defined by theJdbcMetadaAccessStrategyenum.JdbcMetadaAccessStrategy.GROUPEDis the default value.- See Also:
JdbcMetadaAccessStrategy, Constant Field Values
-
HBM2DDL_DELIMITER
static final String HBM2DDL_DELIMITER
Identifies the delimiter to use to separate schema management statements in script outputs. The default value is;.- See Also:
- Constant Field Values
-
HBM2DDL_CHARSET_NAME
static final String HBM2DDL_CHARSET_NAME
The name of the charset used by the schema generation resource. Without specifying this configuration property, the JVM default charset is used.- Since:
- 5.2.3
- See Also:
- Constant Field Values
-
HBM2DDL_HALT_ON_ERROR
static final String HBM2DDL_HALT_ON_ERROR
Whether the schema migration tool should halt on error, therefore terminating the bootstrap process.- Since:
- 5.2.4
- See Also:
- Constant Field Values
-
HBM2DDL_DEFAULT_CONSTRAINT_MODE
static final String HBM2DDL_DEFAULT_CONSTRAINT_MODE
This setting is used when you use
ConstraintMode.PROVIDER_DEFAULTstrategy for foreign key mapping. valid value isCONSTRAINTandNO_CONSTRAINT.The default value is CONSTRAINT.
- Since:
- 5.4
- See Also:
- Constant Field Values
-
CUSTOM_ENTITY_DIRTINESS_STRATEGY
static final String CUSTOM_ENTITY_DIRTINESS_STRATEGY
Setting to identify aCustomEntityDirtinessStrategyto use. May point to either a class name or instance.- See Also:
- Constant Field Values
-
USE_ENTITY_WHERE_CLAUSE_FOR_COLLECTIONS
static final String USE_ENTITY_WHERE_CLAUSE_FOR_COLLECTIONS
Controls whether an entity's "where" clause, mapped using@Where(clause="....")or<entity ... where="...">, is taken into account when loading one-to-many or many-to-many collections of that type of entity. This setting has no affect on collections of embeddable values containing an association to that type of entity. When `true` (the default), the entity's "where" clause will be taken into account when loading one-to-many or many-to-many collections of that type of entity. `false` indicates that the entity's "where" clause will be ignored when loading one-to-many or many-to-many collections of that type of entity.- See Also:
- Constant Field Values
-
MULTI_TENANT
static final String MULTI_TENANT
Strategy for multi-tenancy.- Since:
- 4.0
- See Also:
MultiTenancyStrategy, Constant Field Values
-
MULTI_TENANT_CONNECTION_PROVIDER
static final String MULTI_TENANT_CONNECTION_PROVIDER
Names aMultiTenantConnectionProviderimplementation to use. As MultiTenantConnectionProvider is also a service, can be configured directly through theStandardServiceRegistryBuilder- Since:
- 4.1
- See Also:
- Constant Field Values
-
MULTI_TENANT_IDENTIFIER_RESOLVER
static final String MULTI_TENANT_IDENTIFIER_RESOLVER
Names aCurrentTenantIdentifierResolverimplementation to use. Can be- CurrentTenantIdentifierResolver instance
- CurrentTenantIdentifierResolver implementation
Classreference - CurrentTenantIdentifierResolver implementation class name
- Since:
- 4.1
- See Also:
- Constant Field Values
-
INTERCEPTOR
static final String INTERCEPTOR
Names aInterceptorimplementation to be applied to theSessionFactoryand propagated to each Session created from the SessionFactory. This setting identifies an Interceptor which is effectively a singleton across all the Sessions opened from the SessionFactory to which it is applied; the same instance will be passed to each Session. SeeSESSION_SCOPED_INTERCEPTORfor an approach to create unique Interceptor instances for each Session Can reference- Interceptor instance
- Interceptor implementation
Classreference - Interceptor implementation class name
- Since:
- 5.0
- See Also:
- Constant Field Values
-
SESSION_SCOPED_INTERCEPTOR
static final String SESSION_SCOPED_INTERCEPTOR
Names aInterceptorimplementation to be applied to theSessionFactoryand propagated to each Session created from the SessionFactory. This setting identifies an Interceptor implementation that is to be applied to every Session opened from the SessionFactory, but unlikeINTERCEPTORa unique instance of the Interceptor is used for each Session. Can reference Note specifically that this setting cannot name an Interceptor instance.- Since:
- 5.2
- See Also:
- Constant Field Values
-
STATEMENT_INSPECTOR
static final String STATEMENT_INSPECTOR
Names aStatementInspectorimplementation to be applied to theSessionFactory. Can reference- StatementInspector instance
- StatementInspector implementation
Classreference - StatementInspector implementation class name (FQN)
- Since:
- 5.0
- See Also:
- Constant Field Values
-
ENABLE_LAZY_LOAD_NO_TRANS
static final String ENABLE_LAZY_LOAD_NO_TRANS
- See Also:
- Constant Field Values
-
BATCH_FETCH_STYLE
@Deprecated static final String BATCH_FETCH_STYLE
Deprecated.(since 6.0) : An appropriate batch-fetch style is selected automaticallyNames theBatchFetchStyleto use. Can specify either theBatchFetchStylename (insensitively), or aBatchFetchStyleinstance.LEGACYis the default value.- See Also:
- Constant Field Values
-
DELAY_ENTITY_LOADER_CREATIONS
static final String DELAY_ENTITY_LOADER_CREATIONS
Controls how the individual Loaders for an entity 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 forLockMode.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:
- Constant Field Values
-
JTA_TRACK_BY_THREAD
static final String JTA_TRACK_BY_THREAD
A transaction can be rolled back by another thread ("tracking by thread") -- not the original application. Examples of this include a JTA transaction timeout handled by a background reaper thread. The ability to handle this situation requires checking the Thread ID every time Session is called. This can certainly have performance considerations. Default istrue(enabled).- See Also:
- Constant Field Values
-
ENABLE_SYNONYMS
static final String ENABLE_SYNONYMS
If enabled, allows schema update and validation to support synonyms. Due to the possibility that this would return duplicate tables (especially in Oracle), this is disabled by default.- See Also:
- Constant Field Values
-
EXTRA_PHYSICAL_TABLE_TYPES
static final String EXTRA_PHYSICAL_TABLE_TYPES
Identifies a comma-separate list of values to specify extra table types, other than the default "TABLE" value, to recognize as defining a physical table by schema update, creation and validation.- Since:
- 5.0
- See Also:
- Constant Field Values
-
UNIQUE_CONSTRAINT_SCHEMA_UPDATE_STRATEGY
static final String UNIQUE_CONSTRAINT_SCHEMA_UPDATE_STRATEGY
Unique columns and unique keys both use unique constraints in most dialects. SchemaUpdate needs to create these constraints, but DB's support for finding existing constraints is extremely inconsistent. Further, non-explicitly-named unique constraints use randomly generated characters. Therefore, select from these strategies.UniqueConstraintSchemaUpdateStrategy.DROP_RECREATE_QUIETLY(DEFAULT): Attempt to drop, then (re-)create each unique constraint. Ignore any exceptions thrown.UniqueConstraintSchemaUpdateStrategy.RECREATE_QUIETLY: attempt to (re-)create unique constraints, ignoring exceptions thrown if the constraint already existedUniqueConstraintSchemaUpdateStrategy.SKIP: do not attempt to create unique constraints on a schema update- See Also:
- Constant Field Values
-
GENERATE_STATISTICS
static final String GENERATE_STATISTICS
Enable statistics collection- See Also:
- Constant Field Values
-
LOG_SESSION_METRICS
static final String LOG_SESSION_METRICS
A setting to control whether toStatisticalLoggingSessionEventListeneris enabled on all Sessions (unless explicitly disabled for a given Session). The default value of this setting is determined by the value forGENERATE_STATISTICS, meaning that if collection of statistics is enabled logging of Session metrics is enabled by default too.- See Also:
- Constant Field Values
-
LOG_SLOW_QUERY
static final String LOG_SLOW_QUERY
Setting that logs query which executed slower than specified milliseconds. Default is 0 (disabled).- See Also:
- Constant Field Values
-
AUTO_SESSION_EVENTS_LISTENER
static final String AUTO_SESSION_EVENTS_LISTENER
Defines a defaultSessionEventListenerto be applied to opened Sessions.- See Also:
- Constant Field Values
-
CREATE_EMPTY_COMPOSITES_ENABLED
static final String CREATE_EMPTY_COMPOSITES_ENABLED
[EXPERIMENTAL] Enable instantiation of composite/embedded objects when all of its attribute values arenull. The default (and historical) behavior is that anullreference will be used to represent the composite when all of its attributes arenullThis is an experimental feature that has known issues. It should not be used in production until it is stabilized. See Hibernate Jira issue HHH-11936 for details.- Since:
- 5.1
- See Also:
- Constant Field Values
-
ALLOW_JTA_TRANSACTION_ACCESS
static final String ALLOW_JTA_TRANSACTION_ACCESS
Setting that allows access to the underlyingTransaction, even when using a JTA since normal JPA operations prohibit this behavior. Values aretruegrants access,falsedoes not. The default behavior is to allow access unless the session is bootstrapped via JPA.- See Also:
- Constant Field Values
-
ALLOW_UPDATE_OUTSIDE_TRANSACTION
static final String ALLOW_UPDATE_OUTSIDE_TRANSACTION
Setting that allows to perform update operations outside of a transaction boundary. Since version 5.2 Hibernate conforms with the JPA specification and does not allow anymore to flush any update out of a transaction boundary. Values are:trueto allow flush operations out of a transaction,falseto disallow. The default behavior isfalse- Since:
- 5.2
- See Also:
- Constant Field Values
-
COLLECTION_JOIN_SUBQUERY
static final String COLLECTION_JOIN_SUBQUERY
Setting which indicates whether or not the new JOINS over collection tables should be rewritten to subqueries. Default istrue. Existing applications may want to disable this (set itfalse) for upgrade compatibility.- Since:
- 5.2
- See Also:
- Constant Field Values
-
ALLOW_REFRESH_DETACHED_ENTITY
static final String ALLOW_REFRESH_DETACHED_ENTITY
Setting that allows to callEntityManager.refresh(Object)orSession.refresh(Object)on a detached entity instance when theSessionis obtained from a JPAEntityManager).
Values are:truepermits the refresh,falsedoes not permit the detached instance refresh and anIllegalArgumentExceptionis thrown. The default value isfalsewhen the Session is bootstrapped via JPAEntityManagerFactory, otherwise istrue- 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") is detected while merging. The possible values are:- disallow (the default): throws
IllegalStateExceptionif 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.
EntityCopyObserverand settinghibernate.event.merge.entity_copy_observerto the class name. When this property is set toalloworlog, 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:
- Constant Field Values
- disallow (the default): throws
-
USE_LEGACY_LIMIT_HANDLERS
@Deprecated static final String USE_LEGACY_LIMIT_HANDLERS
Deprecated.this setting now has no effectSetting which indicates whether or not to useLimitHandlerimplementations that sacrifices performance optimizations to allow legacy 4.x limit behavior. Legacy 4.x behavior favored performing pagination in-memory by avoiding the use of the offset value, which is overall poor performance. In 5.x, the limit handler behavior favors performance thus if the dialect doesn't support offsets, an exception is thrown instead. Default isfalse.- Since:
- 5.2.5
- See Also:
- Constant Field Values
-
VALIDATE_QUERY_PARAMETERS
static final String VALIDATE_QUERY_PARAMETERS
Setting which indicates ifQuery.setParameter(org.hibernate.query.QueryParameter<T>, T)should not perform parameters validation This setting is applied only when the Session is bootstrapped via JPAEntityManagerFactoryValues are:trueindicates the validation should be performed,falseotherwiseThe default value is
truewhen the Session is bootstrapped via JPAEntityManagerFactory, otherwise isfalse- See Also:
- Constant Field Values
-
CRITERIA_VALUE_HANDLING_MODE
static final String CRITERIA_VALUE_HANDLING_MODE
By default, Criteria queries uses bind parameters for any value passed through the JPA Criteria API. TheValueHandlingMode.BINDmode (default) will use bind variables for any value. TheValueHandlingMode.INLINEmode will inline values as literals. The default value isValueHandlingMode.BIND- Since:
- 6.0.0
- See Also:
ValueHandlingMode, Constant Field Values
-
JPA_COMPLIANCE
static final String JPA_COMPLIANCE
Allows setting default value for allJpaComplianceflags. Individual flags can still be overridden individually using its specific setting
-
JPA_TRANSACTION_COMPLIANCE
static final String JPA_TRANSACTION_COMPLIANCE
Should Hibernate'sTransactionbehave as defined by the spec for JPA'sEntityTransactionsince it extends the JPA one.- Since:
- 5.3
- See Also:
JpaCompliance.isJpaTransactionComplianceEnabled(), Constant Field Values
-
JPA_QUERY_COMPLIANCE
static final String JPA_QUERY_COMPLIANCE
Controls whether Hibernate's handling ofQuery(JPQL, Criteria and native-query) should strictly follow the JPA spec. This includes both in terms of parsing or translating a query as well as calls to theQuerymethods throwing spec defined exceptions where as Hibernate might not. Deviations result in an exception if enabled- Since:
- 5.3
- See Also:
JpaCompliance.isJpaQueryComplianceEnabled(), Constant Field Values
-
JPA_LIST_COMPLIANCE
static final String JPA_LIST_COMPLIANCE
Controls whether Hibernate should recognize what it considers a "bag" (PersistentBag) as a List (PersistentList) or as a bag. If enabled, we will recognize it as a List whereOrderColumnis just missing (and its defaults will apply).- Since:
- 5.3
- See Also:
JpaCompliance.isJpaListComplianceEnabled(), Constant Field Values
-
JPA_ORDER_BY_MAPPING_COMPLIANCE
static final String JPA_ORDER_BY_MAPPING_COMPLIANCE
Controls whether Hibernate should recognize what it considers a "bag" (PersistentBag) as a List (PersistentList) or as a bag. If enabled, we will recognize it as a List whereOrderColumnis just missing (and its defaults will apply).- Since:
- 6.0
- See Also:
(), Constant Field Values
-
JPA_CLOSED_COMPLIANCE
static final String JPA_CLOSED_COMPLIANCE
JPA defines specific exceptions on specific methods when called onEntityManagerandEntityManagerFactorywhen those objects have been closed. This setting controls whether the spec defined behavior or Hibernate's behavior will be used. If enabled Hibernate will operate in the JPA specified way throwing exceptions when the spec says it should.- Since:
- 5.3
- See Also:
JpaCompliance.isJpaClosedComplianceEnabled(), Constant Field Values
-
JPA_PROXY_COMPLIANCE
static final String JPA_PROXY_COMPLIANCE
The JPA spec says that aEntityNotFoundExceptionshould be thrown when accessing an entity Proxy which does not have an associated table row in the database. Traditionally, Hibernate does not initialize an entity Proxy when accessing its identifier since we already know the identifier value, hence we can save a database roundtrip. If enabled Hibernate will initialize the entity Proxy even when accessing its identifier.- Since:
- 5.2.13
- See Also:
JpaCompliance.isJpaProxyComplianceEnabled(), Constant Field Values
-
JPA_CACHING_COMPLIANCE
static final String JPA_CACHING_COMPLIANCE
- Since:
- 5.3
- See Also:
JpaCompliance.isJpaCacheComplianceEnabled(), Constant Field Values
-
JPA_ID_GENERATOR_GLOBAL_SCOPE_COMPLIANCE
static final String JPA_ID_GENERATOR_GLOBAL_SCOPE_COMPLIANCE
Determine if the scope ofTableGenerator.name()andSequenceGenerator.name()should be considered globally or locally defined. If enabled, the names will be considered globally scoped so defining two different generators with the same name will cause a name collision and an exception will be thrown during the bootstrap phase.- Since:
- 5.2.17
- See Also:
JpaCompliance.isGlobalGeneratorScopeEnabled(), Constant Field Values
-
JPA_LOAD_BY_ID_COMPLIANCE
static final String JPA_LOAD_BY_ID_COMPLIANCE
- Since:
- 6.0
- See Also:
JpaCompliance.isLoadByIdComplianceEnabled(), Constant Field Values
-
TABLE_GENERATOR_STORE_LAST_USED
static final String TABLE_GENERATOR_STORE_LAST_USED
True/False setting indicating if the value stored in the table used by theTableGeneratoris the last value generated or the next value to be used. The default value is true.- Since:
- 5.3
- See Also:
- Constant Field Values
-
FAIL_ON_PAGINATION_OVER_COLLECTION_FETCH
static final String FAIL_ON_PAGINATION_OVER_COLLECTION_FETCH
Raises an exception when in-memory pagination over collection fetch is about to be performed. Disabled by default. Set to true to enable.- Since:
- 5.2.13
- See Also:
- Constant Field Values
-
IMMUTABLE_ENTITY_UPDATE_QUERY_HANDLING_MODE
static final String IMMUTABLE_ENTITY_UPDATE_QUERY_HANDLING_MODE
This setting defines howImmutableentities are handled when executing a bulk updateQuery. By default, the (ImmutableEntityUpdateQueryHandlingMode.WARNING) mode is used, meaning that a warning log message is issued when anImmutableentity is to be updated via a bulk update statement. If the (ImmutableEntityUpdateQueryHandlingMode.EXCEPTION) mode is used, then aHibernateExceptionis thrown instead. Valid options are defined by theImmutableEntityUpdateQueryHandlingModeenum. The default value isImmutableEntityUpdateQueryHandlingMode.WARNING- Since:
- 5.2.17
- See Also:
ImmutableEntityUpdateQueryHandlingMode, Constant Field Values
-
IN_CLAUSE_PARAMETER_PADDING
static final String IN_CLAUSE_PARAMETER_PADDING
By default, the IN clause expands to include all bind parameter values. However, for database systems supporting execution plan caching, there's a better chance of hitting the cache if the number of possible IN clause parameters lowers. For this reason, we can expand the bind parameters to power-of-two: 4, 8, 16, 32, 64. This way, an IN clause with 5, 6, or 7 bind parameters will use the 8 IN clause, therefore reusing its execution plan. If you want to activate this feature, you need to set this property totrue. The default value isfalse.- Since:
- 5.2.17
- See Also:
- Constant Field Values
-
QUERY_STATISTICS_MAX_SIZE
static final String QUERY_STATISTICS_MAX_SIZE
This setting controls the number ofQueryStatisticsentries that will be stored by the HibernateStatisticsobject. The default value is given by theStatistics.DEFAULT_QUERY_STATISTICS_MAX_SIZEconstant value.- Since:
- 5.4
- See Also:
- Constant Field Values
-
SEQUENCE_INCREMENT_SIZE_MISMATCH_STRATEGY
static final String SEQUENCE_INCREMENT_SIZE_MISMATCH_STRATEGY
This setting defines theSequenceMismatchStrategyused when Hibernate detects a mismatch between a sequence configuration in an entity mapping and its database sequence object counterpart. Possible values areSequenceMismatchStrategy.EXCEPTION,SequenceMismatchStrategy.LOG,SequenceMismatchStrategy.FIXandSequenceMismatchStrategy.NONE. The default value is given by theSequenceMismatchStrategy.EXCEPTION, meaning that an Exception is thrown when detecting such a conflict.- Since:
- 5.4
- See Also:
- Constant Field Values
-
OMIT_JOIN_OF_SUPERCLASS_TABLES
static final String OMIT_JOIN_OF_SUPERCLASS_TABLES
When you use
InheritanceType.JOINEDstrategy for inheritance mapping and query a value from an entity, all superclass tables are joined in the query regardless you need them. With this setting set to true only superclass tables which are really needed are joined.The default value is true.
- Since:
- 5.4
- See Also:
- Constant Field Values
-
PREFERRED_BOOLEAN_JDBC_TYPE_CODE
static final String PREFERRED_BOOLEAN_JDBC_TYPE_CODE
Global setting identifying the preferred JDBC type code for storing boolean values. The fallback is to ask the Dialect- Since:
- 6.0
- See Also:
- Constant Field Values
-
JSON_FORMAT_MAPPER
static final String JSON_FORMAT_MAPPER
Names aFormatMapperimplementation to be applied to theSessionFactoryfor JSON serialization and deserialization. Can reference- FormatMapper instance
- FormatMapper implementation
Classreference - FormatMapper implementation class name (FQN)
- one of the short hand constants
- jackson
- jsonb
- Since:
- 6.0
- See Also:
- Constant Field Values
-
TIMEZONE_DEFAULT_STORAGE
static final String TIMEZONE_DEFAULT_STORAGE
Global setting for configuring the default storage for the time zone information for time zone based types. Possible values areTimeZoneStorageType.NORMALIZE,TimeZoneStorageType.COLUMN,TimeZoneStorageType.NATIVEandTimeZoneStorageType.AUTO. The default value is given by theTimeZoneStorageType.NORMALIZE, meaning that time zone information is not stored by default, but timestamps are normalized instead.- Since:
- 6.0
- See Also:
- Constant Field Values
-
JPA_PERSISTENCE_PROVIDER
@Deprecated static final String JPA_PERSISTENCE_PROVIDER
Deprecated.UseJAKARTA_PERSISTENCE_PROVIDERinsteadThe name of thePersistenceProviderimplementor See JPA 2 sections 9.4.3 and 8.2.1.4- See Also:
- Constant Field Values
-
JPA_TRANSACTION_TYPE
@Deprecated static final String JPA_TRANSACTION_TYPE
Deprecated.UseJAKARTA_TRANSACTION_TYPEinsteadThe type of transactions supported by the entity managers. See JPA 2 sections 9.4.3 and 8.2.1.2- See Also:
- Constant Field Values
-
JPA_JTA_DATASOURCE
@Deprecated static final String JPA_JTA_DATASOURCE
Deprecated.UseJAKARTA_JTA_DATASOURCEinsteadThe JNDI name of a JTADataSource. See JPA 2 sections 9.4.3 and 8.2.1.5- See Also:
- Constant Field Values
-
JPA_NON_JTA_DATASOURCE
@Deprecated static final String JPA_NON_JTA_DATASOURCE
Deprecated.UseJAKARTA_NON_JTA_DATASOURCEinsteadThe JNDI name of a non-JTADataSource. See JPA 2 sections 9.4.3 and 8.2.1.5- See Also:
- Constant Field Values
-
JPA_JDBC_DRIVER
@Deprecated static final String JPA_JDBC_DRIVER
Deprecated.UseJAKARTA_JDBC_DRIVERinsteadThe name of a JDBC driver to use to connect to the database. Used in conjunction withJPA_JDBC_URL,JPA_JDBC_USERandJPA_JDBC_PASSWORDto define how to make connections to the database in lieu of a datasource (eitherJPA_JTA_DATASOURCEorJPA_NON_JTA_DATASOURCE). See section 8.2.1.9- See Also:
- Constant Field Values
-
JPA_JDBC_URL
@Deprecated static final String JPA_JDBC_URL
Deprecated.UseJAKARTA_JDBC_URLinsteadThe JDBC connection url to use to connect to the database. Used in conjunction withJPA_JDBC_DRIVER,JPA_JDBC_USERandJPA_JDBC_PASSWORDto define how to make connections to the database in lieu of a datasource (eitherJPA_JTA_DATASOURCEorJPA_NON_JTA_DATASOURCE). See section 8.2.1.9- See Also:
- Constant Field Values
-
JPA_JDBC_USER
@Deprecated static final String JPA_JDBC_USER
Deprecated.UseJAKARTA_JDBC_USERinsteadThe JDBC connection user name. Used in conjunction withJPA_JDBC_DRIVER,JPA_JDBC_URLandJPA_JDBC_PASSWORDto define how to make connections to the database in lieu of a datasource (eitherJPA_JTA_DATASOURCEorJPA_NON_JTA_DATASOURCE). See section 8.2.1.9- See Also:
- Constant Field Values
-
JPA_JDBC_PASSWORD
@Deprecated static final String JPA_JDBC_PASSWORD
Deprecated.UseJAKARTA_JDBC_PASSWORDinsteadThe JDBC connection password. Used in conjunction withJPA_JDBC_DRIVER,JPA_JDBC_URLandJPA_JDBC_USERto define how to make connections to the database in lieu of a datasource (eitherJPA_JTA_DATASOURCEorJPA_NON_JTA_DATASOURCE). See JPA 2 section 8.2.1.9- See Also:
- Constant Field Values
-
JPA_SHARED_CACHE_MODE
@Deprecated static final String JPA_SHARED_CACHE_MODE
Deprecated.UseJAKARTA_SHARED_CACHE_MODEinsteadUsed to indicate whether second-level (what JPA terms shared cache) caching is enabled as per the rules defined in JPA 2 section 3.1.7. See JPA 2 sections 9.4.3 and 8.2.1.7- See Also:
SharedCacheMode, Constant Field Values
-
JPA_SHARED_CACHE_RETRIEVE_MODE
@Deprecated static final String JPA_SHARED_CACHE_RETRIEVE_MODE
Deprecated.UseJAKARTA_SHARED_CACHE_RETRIEVE_MODEinsteadNOTE : Not a valid EMF property... Used to indicate if the provider should attempt to retrieve requested data in the shared cache.- See Also:
CacheRetrieveMode, Constant Field Values
-
JPA_SHARED_CACHE_STORE_MODE
@Deprecated static final String JPA_SHARED_CACHE_STORE_MODE
Deprecated.UseJAKARTA_SHARED_CACHE_STORE_MODEinsteadNOTE : Not a valid EMF property... Used to indicate if the provider should attempt to store data loaded from the database in the shared cache.- See Also:
CacheStoreMode, Constant Field Values
-
JPA_VALIDATION_MODE
@Deprecated static final String JPA_VALIDATION_MODE
Deprecated.UseJAKARTA_VALIDATION_MODEinsteadUsed to indicate what form of automatic validation is in effect as per rules defined in JPA 2 section 3.6.1.1 See JPA 2 sections 9.4.3 and 8.2.1.8- See Also:
ValidationMode, Constant Field Values
-
JPA_VALIDATION_FACTORY
@Deprecated static final String JPA_VALIDATION_FACTORY
Deprecated.UseJAKARTA_VALIDATION_FACTORYinsteadUsed to pass along any discovered validator factory.- See Also:
- Constant Field Values
-
JPA_PERSIST_VALIDATION_GROUP
@Deprecated static final String JPA_PERSIST_VALIDATION_GROUP
Deprecated.UseJAKARTA_PERSIST_VALIDATION_GROUPinsteadUsed to coordinate with bean validators See JPA 2 section 8.2.1.9- See Also:
- Constant Field Values
-
JPA_UPDATE_VALIDATION_GROUP
@Deprecated static final String JPA_UPDATE_VALIDATION_GROUP
Deprecated.UseJAKARTA_UPDATE_VALIDATION_GROUPinsteadUsed to coordinate with bean validators See JPA 2 section 8.2.1.9- See Also:
- Constant Field Values
-
JPA_REMOVE_VALIDATION_GROUP
@Deprecated static final String JPA_REMOVE_VALIDATION_GROUP
Deprecated.UseJAKARTA_REMOVE_VALIDATION_GROUPinsteadUsed to coordinate with bean validators See JPA 2 section 8.2.1.9- See Also:
- Constant Field Values
-
JPA_LOCK_SCOPE
@Deprecated static final String JPA_LOCK_SCOPE
Deprecated.UseJAKARTA_LOCK_SCOPEinsteadUsed to request (hint) a pessimistic lock scope. See JPA 2 sections 8.2.1.9 and 3.4.4.3- See Also:
- Constant Field Values
-
JPA_LOCK_TIMEOUT
@Deprecated static final String JPA_LOCK_TIMEOUT
Deprecated.UseJAKARTA_LOCK_TIMEOUTinsteadUsed to request (hint) a pessimistic lock timeout (in milliseconds). See JPA 2 sections 8.2.1.9 and 3.4.4.3- See Also:
- Constant Field Values
-
CDI_BEAN_MANAGER
@Deprecated static final String CDI_BEAN_MANAGER
Deprecated.UseJAKARTA_CDI_BEAN_MANAGERinsteadUsed to pass along the CDI BeanManager, if any, to be used. According to JPA, strictly, the BeanManager should be passed in at boot-time and be ready for use at that time. However not all environments can do this (WildFly e.g.). To accommodate such environments, Hibernate provides 2 options: * a proprietary CDI extension SPI (that we have proposed to the CDI spec group as a standard option) that can be used to provide delayed BeanManager access. To use this solution, the reference passed as the BeanManager during bootstrap should be typed asExtendedBeanManager* delayed access to the BeanManager reference. Here, Hibernate will not access the reference passed as the BeanManager during bootstrap until it is first needed. Note however that this has the effect of delaying any deployment problems until after bootstrapping. This setting is used to configure Hibernate ORM's access to the BeanManager (either directly or viaExtendedBeanManager).- See Also:
- Constant Field Values
-
FLUSH_MODE
static final String FLUSH_MODE
Used to determine flush mode.- 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
-
EVENT_LISTENER_PREFIX
static final String EVENT_LISTENER_PREFIX
Event configuration should follow the following pattern hibernate.event.listener.[eventType] f.q.c.n.EventListener1, f.q.c.n.EventListener12 ...- See Also:
- Constant Field Values
-
CLASS_CACHE_PREFIX
static final String CLASS_CACHE_PREFIX
Caching configuration should follow the following patternhibernate.ejb.classcache.<fully.qualified.Classname> usage[, region]where usage is the cache strategy used and region the cache region name- See Also:
- Constant Field Values
-
COLLECTION_CACHE_PREFIX
static final String COLLECTION_CACHE_PREFIX
Caching configuration should follow the following patternhibernate.ejb.collectioncache.<fully.qualified.Classname>.<role> usage[, region]where usage is the cache strategy used and region the cache region name- See Also:
- Constant Field Values
-
ENHANCER_ENABLE_DIRTY_TRACKING
static final String ENHANCER_ENABLE_DIRTY_TRACKING
Enable dirty tracking feature in runtime bytecode enhancement- See Also:
- Constant Field Values
-
ENHANCER_ENABLE_LAZY_INITIALIZATION
static final String ENHANCER_ENABLE_LAZY_INITIALIZATION
Enable lazy loading feature in runtime bytecode enhancement- See Also:
- Constant Field Values
-
ENHANCER_ENABLE_ASSOCIATION_MANAGEMENT
static final String ENHANCER_ENABLE_ASSOCIATION_MANAGEMENT
Enable association management feature in runtime bytecode enhancement- See Also:
- Constant Field Values
-
PERSISTENCE_UNIT_NAME
static final String PERSISTENCE_UNIT_NAME
Used to pass along the name of the persistence unit.- See Also:
- Constant Field Values
-
SESSION_FACTORY_OBSERVER
static final String SESSION_FACTORY_OBSERVER
SessionFactoryObserver class name, the class must have a no-arg constructor- See Also:
- Constant Field Values
-
IDENTIFIER_GENERATOR_STRATEGY_PROVIDER
static final String IDENTIFIER_GENERATOR_STRATEGY_PROVIDER
IdentifierGeneratorStrategyProvider class name, the class must have a no-arg constructor- See Also:
- Constant Field Values
-
DISCARD_PC_ON_CLOSE
static final String DISCARD_PC_ON_CLOSE
Whether to discard persistent context onSharedSessionContract.close()/EntityManager.close(). The default (and spec compliant behavior) is false- See Also:
- Constant Field Values
-
-