Package org.hibernate.cfg

Interface AvailableSettings

    • Field Detail

      • JPA_TRANSACTION_TYPE

        static final java.lang.String JPA_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

      • JPA_JTA_DATASOURCE

        static final java.lang.String JPA_JTA_DATASOURCE
        The JNDI name of a JTA DataSource.

        See JPA 2 sections 9.4.3 and 8.2.1.5

        See Also:
        Constant Field Values

      • JPA_NON_JTA_DATASOURCE

        static final java.lang.String JPA_NON_JTA_DATASOURCE
        The JNDI name of a non-JTA DataSource.

        See JPA 2 sections 9.4.3 and 8.2.1.5

        See Also:
        Constant Field Values

      • JPA_SHARED_CACHE_MODE

        static final java.lang.String JPA_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

      • JPA_SHARED_CACHE_RETRIEVE_MODE

        static final java.lang.String JPA_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

      • JPA_SHARED_CACHE_STORE_MODE

        static final java.lang.String JPA_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

      • JPA_VALIDATION_MODE

        static final java.lang.String JPA_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

      • JPA_VALIDATION_FACTORY

        static final java.lang.String JPA_VALIDATION_FACTORY
        Used to pass along any discovered validator factory.
        See Also:
        Constant Field Values

      • JPA_PERSIST_VALIDATION_GROUP

        static final java.lang.String JPA_PERSIST_VALIDATION_GROUP
        Used to coordinate with bean validators

        See JPA 2 section 8.2.1.9

        See Also:
        Constant Field Values

      • JPA_UPDATE_VALIDATION_GROUP

        static final java.lang.String JPA_UPDATE_VALIDATION_GROUP
        Used to coordinate with bean validators

        See JPA 2 section 8.2.1.9

        See Also:
        Constant Field Values

      • JPA_REMOVE_VALIDATION_GROUP

        static final java.lang.String JPA_REMOVE_VALIDATION_GROUP
        Used to coordinate with bean validators

        See JPA 2 section 8.2.1.9

        See Also:
        Constant Field Values

      • JPA_LOCK_SCOPE

        static final java.lang.String JPA_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

      • JPA_LOCK_TIMEOUT

        static final java.lang.String JPA_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

      • CDI_BEAN_MANAGER

        static final java.lang.String 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 as ExtendedBeanManager * 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 via ExtendedBeanManager).
        See Also:
        Constant Field Values

      • JAKARTA_JPA_PERSISTENCE_PROVIDER

        static final java.lang.String JAKARTA_JPA_PERSISTENCE_PROVIDER
        The name of the PersistenceProvider implementor

        See JPA 2 sections 9.4.3 and 8.2.1.4

        See Also:
        Constant Field Values

      • JAKARTA_JPA_TRANSACTION_TYPE

        static final java.lang.String JAKARTA_JPA_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_JPA_JTA_DATASOURCE

        static final java.lang.String JAKARTA_JPA_JTA_DATASOURCE
        The JNDI name of a JTA DataSource.

        See JPA 2 sections 9.4.3 and 8.2.1.5

        See Also:
        Constant Field Values

      • JAKARTA_JPA_NON_JTA_DATASOURCE

        static final java.lang.String JAKARTA_JPA_NON_JTA_DATASOURCE
        The JNDI name of a non-JTA DataSource.

        See JPA 2 sections 9.4.3 and 8.2.1.5

        See Also:
        Constant Field Values

      • JAKARTA_JPA_SHARED_CACHE_MODE

        static final java.lang.String JAKARTA_JPA_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_JPA_SHARED_CACHE_RETRIEVE_MODE

        static final java.lang.String JAKARTA_JPA_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_JPA_SHARED_CACHE_STORE_MODE

        static final java.lang.String JAKARTA_JPA_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_JPA_VALIDATION_MODE

        static final java.lang.String JAKARTA_JPA_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_JPA_VALIDATION_FACTORY

        static final java.lang.String JAKARTA_JPA_VALIDATION_FACTORY
        Used to pass along any discovered validator factory.
        See Also:
        Constant Field Values

      • JAKARTA_JPA_PERSIST_VALIDATION_GROUP

        static final java.lang.String JAKARTA_JPA_PERSIST_VALIDATION_GROUP
        Used to coordinate with bean validators

        See JPA 2 section 8.2.1.9

        See Also:
        Constant Field Values

      • JAKARTA_JPA_UPDATE_VALIDATION_GROUP

        static final java.lang.String JAKARTA_JPA_UPDATE_VALIDATION_GROUP
        Used to coordinate with bean validators

        See JPA 2 section 8.2.1.9

        See Also:
        Constant Field Values

      • JAKARTA_JPA_REMOVE_VALIDATION_GROUP

        static final java.lang.String JAKARTA_JPA_REMOVE_VALIDATION_GROUP
        Used to coordinate with bean validators

        See JPA 2 section 8.2.1.9

        See Also:
        Constant Field Values

      • JAKARTA_JPA_LOCK_SCOPE

        static final java.lang.String JAKARTA_JPA_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_JPA_LOCK_TIMEOUT

        static final java.lang.String JAKARTA_JPA_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 java.lang.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 as ExtendedBeanManager * 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 via ExtendedBeanManager).
        See Also:
        Constant Field Values

      • CLASSLOADERS

        static final java.lang.String CLASSLOADERS
        Used to define a Collection of the ClassLoader instances Hibernate should use for class-loading and resource-lookups.
        Since:
        5.0
        See Also:
        Constant Field Values

      • TC_CLASSLOADER

        static final java.lang.String TC_CLASSLOADER
        Used to define how the current thread context ClassLoader must be used for class lookup.
        See Also:
        TcclLookupPrecedence, Constant Field Values

      • APP_CLASSLOADER

        @Deprecated
static final java.lang.String APP_CLASSLOADER
        Deprecated.
        Use CLASSLOADERS instead
        Names the ClassLoader used to load user application classes.
        Since:
        4.0
        See Also:
        Constant Field Values

      • RESOURCES_CLASSLOADER

        @Deprecated
static final java.lang.String RESOURCES_CLASSLOADER
        Deprecated.
        Use CLASSLOADERS instead
        Names the ClassLoader Hibernate should use to perform resource loading.
        Since:
        4.0
        See Also:
        Constant Field Values

      • HIBERNATE_CLASSLOADER

        @Deprecated
static final java.lang.String HIBERNATE_CLASSLOADER
        Deprecated.
        Use CLASSLOADERS instead
        Names the ClassLoader responsible for loading Hibernate classes. By default this is the ClassLoader that loaded this class.
        Since:
        4.0
        See Also:
        Constant Field Values

      • JPA_METAMODEL_POPULATION

        @Deprecated
static final java.lang.String JPA_METAMODEL_POPULATION
        Deprecated.
        Setting that indicates whether to build the JPA types. Accepts 3 values:
        • enabled - Do the build
        • disabled - Do not do the build
        • ignoreUnsupported - Do the build, but ignore any non-JPA features that would otherwise result in a failure.
        See Also:
        Constant Field Values

      • STATIC_METAMODEL_POPULATION

        static final java.lang.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 java.lang.String CONNECTION_PROVIDER
        Names the ConnectionProvider to use for obtaining JDBC connections. Can reference:
        • an instance of ConnectionProvider
        • a Class<? extends ConnectionProvider> reference
        • a Class<? extends ConnectionProvider> FQN

        The term "class" appears in the setting name due to legacy reasons; however it can accept instances.

        See Also:
        Constant Field Values

      • DRIVER

        static final java.lang.String DRIVER
        Names the JDBC driver class
        See Also:
        Constant Field Values

      • USER

        static final java.lang.String USER
        Names the connection user. This might mean one of 2 things in out-of-the-box Hibernate ConnectionProvider:
        • 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 java.lang.String PASS
        Names the connection password. See usage discussion on USER
        See Also:
        Constant Field Values

      • ISOLATION

        static final java.lang.String ISOLATION
        Names the JDBC transaction isolation level
        See Also:
        Constant Field Values

      • AUTOCOMMIT

        static final java.lang.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 java.lang.String POOL_SIZE
        Maximum number of inactive connections for the built-in Hibernate connection pool.
        See Also:
        Constant Field Values

      • DATASOURCE

        static final java.lang.String DATASOURCE
        Names a DataSource. Can reference:
        • a DataSource instance
        • a JNDI name under which to locate the DataSource
        For JNDI names, ses also JNDI_CLASS, JNDI_URL, JNDI_PREFIX, etc.
        See Also:
        Constant Field Values

      • CONNECTION_PROVIDER_DISABLES_AUTOCOMMIT

        static final java.lang.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 is false - do not skip, aka call setAutocommit

        Since:
        5.2.10
        See Also:
        Constant Field Values

      • CONNECTION_PREFIX

        static final java.lang.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 java.lang.String JNDI_CLASS
        Names the JNDI InitialContext class.
        See Also:
        Context.INITIAL_CONTEXT_FACTORY, Constant Field Values

      • JNDI_URL

        static final java.lang.String JNDI_URL
        Names the JNDI provider/connection url
        See Also:
        Context.PROVIDER_URL, Constant Field Values

      • JNDI_PREFIX

        static final java.lang.String JNDI_PREFIX
        Names a prefix used to define arbitrary JNDI InitialContext properties. These properties are passed along to InitialContext(java.util.Hashtable)
        See Also:
        Constant Field Values

      • STORAGE_ENGINE

        static final java.lang.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 java.lang.String SCHEMA_MANAGEMENT_TOOL
        Used to specify the SchemaManagementTool to use for performing schema management. The default is to use HibernateSchemaManagementTool
        Since:
        5.0
        See Also:
        Constant Field Values

      • TRANSACTION_COORDINATOR_STRATEGY

        static final java.lang.String TRANSACTION_COORDINATOR_STRATEGY
        Names the implementation of TransactionCoordinatorBuilder to use for creating TransactionCoordinator instances.

        Can be

        • TransactionCoordinatorBuilder instance
        • TransactionCoordinatorBuilder implementation Class reference
        • TransactionCoordinatorBuilder implementation class name (FQN) or short-name
        Since:
        5.0
        See Also:
        Constant Field Values

      • JTA_PLATFORM

        static final java.lang.String JTA_PLATFORM
        Names the JtaPlatform implementation to use for integrating with JTA systems. Can reference either a JtaPlatform instance or the name of the JtaPlatform implementation class
        Since:
        4.0
        See Also:
        Constant Field Values

      • JTA_CACHE_TM

        static final java.lang.String JTA_CACHE_TM
        A configuration value key used to indicate that it is safe to cache TransactionManager references.
        Since:
        4.0
        See Also:
        Constant Field Values

      • JTA_CACHE_UT

        static final java.lang.String JTA_CACHE_UT
        A configuration value key used to indicate that it is safe to cache UserTransaction references.
        Since:
        4.0
        See Also:
        Constant Field Values

      • JDBC_TYLE_PARAMS_ZERO_BASE

        @Deprecated
static final java.lang.String JDBC_TYLE_PARAMS_ZERO_BASE
        Deprecated.
        This is a temporary backwards-compatibility setting to help applications using versions prior to 5.3 in upgrading. Deprecation warnings are issued when this is set to `true`.
        `true` / `false - should zero be used as the base for JDBC-style parameters found in native-queries?
        Since:
        5.3
        See Also:
        DeprecationLogger.logUseOfDeprecatedZeroBasedJdbcStyleParams(), Constant Field Values

      • IMPLICIT_DISCRIMINATOR_COLUMNS_FOR_JOINED_SUBCLASS

        static final java.lang.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.

        See Also:
        MetadataBuilder.enableImplicitDiscriminatorsForJoinedSubclassSupport(boolean), IGNORE_EXPLICIT_DISCRIMINATOR_COLUMNS_FOR_JOINED_SUBCLASS, Constant Field Values

      • IGNORE_EXPLICIT_DISCRIMINATOR_COLUMNS_FOR_JOINED_SUBCLASS

        static final java.lang.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.

        See Also:
        MetadataBuilder.enableExplicitDiscriminatorsForJoinedSubclassSupport(boolean), IMPLICIT_DISCRIMINATOR_COLUMNS_FOR_JOINED_SUBCLASS, Constant Field Values

      • KEYWORD_AUTO_QUOTING_ENABLED

        static final java.lang.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 java.lang.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

      • EVENT_LISTENER_PREFIX

        static final java.lang.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

      • PERSISTENCE_UNIT_NAME

        static final java.lang.String PERSISTENCE_UNIT_NAME
        Used to pass along the name of the persistence unit.
        See Also:
        Constant Field Values

      • SESSION_FACTORY_OBSERVER

        static final java.lang.String SESSION_FACTORY_OBSERVER
        SessionFactoryObserver class name, the class must have a no-arg constructor
        See Also:
        Constant Field Values

      • IDENTIFIER_GENERATOR_STRATEGY_PROVIDER

        @Deprecated
static final java.lang.String IDENTIFIER_GENERATOR_STRATEGY_PROVIDER
        Deprecated.
        with no replacement. Hooking in to Hibernate's id-generator determination will be done very differently in Hibernate 6
        IdentifierGeneratorStrategyProvider class name, the class must have a no-arg constructor
        See Also:
        Constant Field Values

      • SESSION_FACTORY_NAME

        static final java.lang.String SESSION_FACTORY_NAME
        Setting used to name the Hibernate SessionFactory. Naming the SessionFactory allows for it to be properly serialized across JVMs as long as the same name is used on each JVM. If SESSION_FACTORY_NAME_IS_JNDI is set to true, 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 java.lang.String SESSION_FACTORY_NAME_IS_JNDI
        Does the value defined by SESSION_FACTORY_NAME represent a JNDI namespace into which the SessionFactory should be bound and made accessible? Defaults to true for backwards compatibility. Set this to false if 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

      • CFG_XML_FILE

        static final java.lang.String CFG_XML_FILE
        Used to specify a Hibernate cfg.xml config file
        See Also:
        Constant Field Values

      • CLASS_CACHE_PREFIX

        static final java.lang.String CLASS_CACHE_PREFIX
        Caching configuration should follow the following pattern hibernate.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 java.lang.String COLLECTION_CACHE_PREFIX
        Caching configuration should follow the following pattern hibernate.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

      • SHOW_SQL

        static final java.lang.String SHOW_SQL
        Enable logging of generated SQL to the console
        See Also:
        Constant Field Values

      • FORMAT_SQL

        static final java.lang.String FORMAT_SQL
        Enable formatting of SQL logged to the console
        See Also:
        Constant Field Values

      • HIGHLIGHT_SQL

        static final java.lang.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 java.lang.String USE_SQL_COMMENTS
        Add comments to the generated SQL
        See Also:
        Constant Field Values

      • MAX_FETCH_DEPTH

        static final java.lang.String MAX_FETCH_DEPTH
        Maximum depth of outer join fetching
        See Also:
        Constant Field Values

      • DEFAULT_BATCH_FETCH_SIZE

        static final java.lang.String DEFAULT_BATCH_FETCH_SIZE
        The default batch size for batch fetching
        See Also:
        Constant Field Values

      • USE_STREAMS_FOR_BINARY

        static final java.lang.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 java.lang.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 java.lang.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 java.lang.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 java.lang.String STATEMENT_BATCH_SIZE
        Maximum JDBC batch size. A nonzero value enables batch updates.
        See Also:
        Constant Field Values

      • BATCH_STRATEGY

        static final java.lang.String BATCH_STRATEGY
        Select a custom batcher.
        See Also:
        Constant Field Values

      • BATCH_VERSIONED_DATA

        static final java.lang.String BATCH_VERSIONED_DATA
        Should versioned data be included in batching?
        See Also:
        Constant Field Values

      • JDBC_TIME_ZONE

        static final java.lang.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 java.lang.String AUTO_CLOSE_SESSION
        Enable automatic session close at end of transaction
        See Also:
        Constant Field Values

      • FLUSH_BEFORE_COMPLETION

        static final java.lang.String FLUSH_BEFORE_COMPLETION
        Enable automatic flush during the JTA beforeCompletion() callback
        See Also:
        Constant Field Values

      • USE_IDENTIFIER_ROLLBACK

        static final java.lang.String USE_IDENTIFIER_ROLLBACK
        See Also:
        Constant Field Values

      • USE_REFLECTION_OPTIMIZER

        static final java.lang.String USE_REFLECTION_OPTIMIZER
        Use bytecode libraries optimized property access
        See Also:
        Constant Field Values

      • ENFORCE_LEGACY_PROXY_CLASSNAMES

        static final java.lang.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

      • ALLOW_ENHANCEMENT_AS_PROXY

        @Deprecated
static final java.lang.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 uses Session.load(java.lang.Class<T>, java.io.Serializable, 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 various Hibernate methods such as Hibernate.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

      • QUERY_TRANSLATOR

        static final java.lang.String QUERY_TRANSLATOR
        The classname of the HQL query parser factory
        See Also:
        Constant Field Values

      • QUERY_SUBSTITUTIONS

        static final java.lang.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 java.lang.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 java.lang.String CONVENTIONAL_JAVA_CONSTANTS
        Setting which indicates whether or not Java constant follow the Java Naming conventions.

        Default is true. Existing applications may want to disable this (set it false) 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 java.lang.String SQL_EXCEPTION_CONVERTER
        The SQLExceptionConverter to use for converting SQLExceptions to Hibernate's JDBCException hierarchy. The default is to use the configured Dialect's preferred SQLExceptionConverter.
        See Also:
        Constant Field Values

      • WRAP_RESULT_SETS

        @Deprecated
static final java.lang.String WRAP_RESULT_SETS
        Deprecated.
        (since 5.5) Scheduled for removal in 6.0 as ResultSet wrapping is no longer needed
        Enable 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 java.lang.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 to true, HibernateException will not be wrapped or converted according to the JPA specification.

        This setting will be ignored for a SessionFactory built via JPA bootstrapping.

        Values are true or false. Default value is false

        See Also:
        Constant Field Values

      • ORDER_UPDATES

        static final java.lang.String ORDER_UPDATES
        Enable ordering of update statements by primary key value
        See Also:
        Constant Field Values

      • ORDER_INSERTS

        static final java.lang.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 java.lang.String JPA_CALLBACKS_ENABLED
        JPA Callbacks are enabled by default. Set this to false to 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 java.lang.String DEFAULT_NULL_ORDERING
        Default precedence of null values in ORDER BY clause. Supported options: none (default), first, last.
        See Also:
        Constant Field Values

      • C3P0_CONFIG_PREFIX

        static final java.lang.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 java.lang.String C3P0_MAX_SIZE
        Maximum size of C3P0 connection pool
        See Also:
        Constant Field Values

      • C3P0_MIN_SIZE

        static final java.lang.String C3P0_MIN_SIZE
        Minimum size of C3P0 connection pool
        See Also:
        Constant Field Values

      • C3P0_TIMEOUT

        static final java.lang.String C3P0_TIMEOUT
        Maximum idle time for C3P0 connection pool
        See Also:
        Constant Field Values

      • C3P0_MAX_STATEMENTS

        static final java.lang.String C3P0_MAX_STATEMENTS
        Maximum size of C3P0 statement cache
        See Also:
        Constant Field Values

      • C3P0_ACQUIRE_INCREMENT

        static final java.lang.String C3P0_ACQUIRE_INCREMENT
        Number of connections acquired when pool is exhausted
        See Also:
        Constant Field Values

      • C3P0_IDLE_TEST_PERIOD

        static final java.lang.String C3P0_IDLE_TEST_PERIOD
        Idle time before a C3P0 pooled connection is validated
        See Also:
        Constant Field Values

      • PROXOOL_CONFIG_PREFIX

        static final java.lang.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 java.lang.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 java.lang.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 java.lang.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 java.lang.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_KEYS_FACTORY

        static final java.lang.String CACHE_KEYS_FACTORY
        Allow control to specify the CacheKeysFactory impl to use. Can refer to:
        Since:
        5.2 - note that currently this is only honored for hibernate-infinispan
        See Also:
        Constant Field Values

      • CACHE_PROVIDER_CONFIG

        static final java.lang.String CACHE_PROVIDER_CONFIG
        The CacheProvider implementation class
        See Also:
        Constant Field Values

      • USE_SECOND_LEVEL_CACHE

        static final java.lang.String USE_SECOND_LEVEL_CACHE
        Enable the second-level cache.

        By default, if the currently configured RegionFactory is not the NoCachingRegionFactory, 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 java.lang.String USE_QUERY_CACHE
        Enable the query cache (disabled by default)
        See Also:
        Constant Field Values

      • CACHE_REGION_PREFIX

        static final java.lang.String CACHE_REGION_PREFIX
        The CacheProvider region name prefix
        See Also:
        Constant Field Values

      • USE_MINIMAL_PUTS

        static final java.lang.String USE_MINIMAL_PUTS
        Optimize the cache for minimal puts instead of minimal gets
        See Also:
        Constant Field Values

      • USE_STRUCTURED_CACHE

        static final java.lang.String USE_STRUCTURED_CACHE
        Enable use of structured second-level cache entries
        See Also:
        Constant Field Values

      • AUTO_EVICT_COLLECTION_CACHE

        static final java.lang.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 java.lang.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

      • DEFAULT_ENTITY_MODE

        static final java.lang.String DEFAULT_ENTITY_MODE
        The EntityMode in which set the Session opened from the SessionFactory.
        See Also:
        Constant Field Values

      • GLOBALLY_QUOTED_IDENTIFIERS

        static final java.lang.String GLOBALLY_QUOTED_IDENTIFIERS
        Should all database identifiers be quoted. A true/false option.
        See Also:
        Constant Field Values

      • GLOBALLY_QUOTED_IDENTIFIERS_SKIP_COLUMN_DEFINITIONS

        static final java.lang.String GLOBALLY_QUOTED_IDENTIFIERS_SKIP_COLUMN_DEFINITIONS
        Assuming GLOBALLY_QUOTED_IDENTIFIERS, this allows such global quoting to skip column-definitions as defined by Column, JoinColumn, etc.

        JPA states that column-definitions are subject to global quoting, so by default this setting is false for JPA compliance. Set to true to 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 java.lang.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 java.lang.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 java.lang.String JPAQL_STRICT_COMPLIANCE
        See Also:
        Constant Field Values

      • PREFER_POOLED_VALUES_LO

        @Deprecated
static final java.lang.String PREFER_POOLED_VALUES_LO
        Deprecated.
        Use PREFERRED_POOLED_OPTIMIZER instead
        When using pooled optimizers, prefer interpreting the database value as the lower (lo) boundary. The default is to interpret it as the high boundary.
        See Also:
        Constant Field Values

      • PREFERRED_POOLED_OPTIMIZER

        static final java.lang.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_PARAMETER_METADATA_MAX_SIZE

        static final java.lang.String QUERY_PLAN_CACHE_PARAMETER_METADATA_MAX_SIZE
        The maximum number of ParameterMetadataImpl maintained by QueryPlanCache. Default is 128.
        See Also:
        Constant Field Values

      • NON_CONTEXTUAL_LOB_CREATION

        static final java.lang.String NON_CONTEXTUAL_LOB_CREATION
        Should we not use contextual LOB creation (aka based on Connection.createBlob() et al).
        See Also:
        Constant Field Values

      • HBM2DDL_DATABASE_ACTION

        static final java.lang.String HBM2DDL_DATABASE_ACTION
        Setting to perform SchemaManagementTool actions against the database directly via JDBC automatically as part of the SessionFactory lifecycle. Valid options are defined by the Action enum.

        Interpreted in combination with HBM2DDL_AUTO. If no value is specified, the default is "none" (Action.NONE).

        See Also:
        Action, Constant Field Values

      • HBM2DDL_SCRIPTS_ACTION

        static final java.lang.String HBM2DDL_SCRIPTS_ACTION
        Setting to perform SchemaManagementTool actions writing the commands into a DDL script file. Valid options are defined by the Action enum.

        Interpreted in combination with HBM2DDL_AUTO. If no value is specified, the default is "none" (Action.NONE).

        See Also:
        Action, Constant Field Values

      • HBM2DDL_DB_MAJOR_VERSION

        static final java.lang.String HBM2DDL_DB_MAJOR_VERSION
        Specifies the major version of the underlying database, as would be returned by DatabaseMetaData.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.
        See Also:
        HBM2DDL_DB_NAME, HBM2DDL_DB_MINOR_VERSION, Constant Field Values

      • HBM2DDL_CREATE_SOURCE

        static final java.lang.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. See SourceType for valid set of values. If no value is specified, a default is assumed as follows:
        See Also:
        SourceType, Constant Field Values

      • HBM2DDL_DROP_SOURCE

        static final java.lang.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. See SourceType for valid set of values. If no value is specified, a default is assumed as follows:
        See Also:
        SourceType, Constant Field Values

      • HBM2DDL_DROP_SCRIPT_SOURCE

        static final java.lang.String HBM2DDL_DROP_SCRIPT_SOURCE
        Specifies the DROP script file as either a Reader configured for reading of the DDL script file or a string designating a file URL for the DDL script.
        See Also:
        HBM2DDL_DROP_SOURCE, Constant Field Values

      • HBM2DDL_SCRIPTS_CREATE_TARGET

        static final java.lang.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 a Writer configured 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 java.lang.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: true for appending schema commands to the end of the file, false for writing schema commands at the beginning. The default value is true
        See Also:
        Constant Field Values

      • HBM2DDL_SCRIPTS_DROP_TARGET

        static final java.lang.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 a Writer configured 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 java.lang.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.sql

        HBM2DDL_CREATE_SCRIPT_SOURCE / HBM2DDL_DROP_SCRIPT_SOURCE should be preferred moving forward

        See Also:
        Constant Field Values

      • HBM2DDL_LOAD_SCRIPT_SOURCE

        static final java.lang.String HBM2DDL_LOAD_SCRIPT_SOURCE
        JPA variant of HBM2DDL_IMPORT_FILES

        Specifies a Reader configured for reading of the SQL load script or a string designating the file URL for the SQL load script.

        A "SQL load script" is a script that performs some database initialization (INSERT, etc).

        See Also:
        Constant Field Values

      • HBM2DDL_CREATE_NAMESPACES

        static final java.lang.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

      • HBM2DLL_CREATE_NAMESPACES

        @Deprecated
static final java.lang.String HBM2DLL_CREATE_NAMESPACES
        Deprecated.
        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

        static final java.lang.String HBM2DDL_CREATE_SCHEMAS
        The JPA variant of HBM2DDL_CREATE_NAMESPACES

        Specifies whether the persistence provider is to create the database schema(s) in addition to creating database objects (tables, sequences, constraints, etc). The value of this boolean property should be set to true if the persistence provider is to create schemas in the database or to generate DDL that contains "CREATE SCHEMA" commands. If this property is not supplied (or is explicitly false), the provider should not attempt to create database schemas.

        See Also:
        Constant Field Values

      • JAKARTA_HBM2DDL_DATABASE_ACTION

        static final java.lang.String JAKARTA_HBM2DDL_DATABASE_ACTION
        Setting to perform SchemaManagementTool actions against the database directly via JDBC automatically as part of the SessionFactory lifecycle. Valid options are defined by the Action enum.

        Interpreted in combination with HBM2DDL_AUTO. If no value is specified, the default is "none" (Action.NONE).

        See Also:
        Action, Constant Field Values

      • JAKARTA_HBM2DDL_SCRIPTS_ACTION

        static final java.lang.String JAKARTA_HBM2DDL_SCRIPTS_ACTION
        Setting to perform SchemaManagementTool actions writing the commands into a DDL script file. Valid options are defined by the Action enum.

        Interpreted in combination with HBM2DDL_AUTO. If no value is specified, the default is "none" (Action.NONE).

        See Also:
        Action, Constant Field Values

      • JAKARTA_HBM2DDL_DB_MAJOR_VERSION

        static final java.lang.String JAKARTA_HBM2DDL_DB_MAJOR_VERSION
        Specifies the major version of the underlying database, as would be returned by DatabaseMetaData.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.
        See Also:
        HBM2DDL_DB_NAME, HBM2DDL_DB_MINOR_VERSION, Constant Field Values

      • JAKARTA_HBM2DDL_CREATE_SOURCE

        static final java.lang.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. See SourceType for valid set of values. If no value is specified, a default is assumed as follows:
        See Also:
        SourceType, Constant Field Values

      • JAKARTA_HBM2DDL_DROP_SOURCE

        static final java.lang.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. See SourceType for valid set of values. If no value is specified, a default is assumed as follows:
        See Also:
        SourceType, Constant Field Values

      • JAKARTA_HBM2DDL_DROP_SCRIPT_SOURCE

        static final java.lang.String JAKARTA_HBM2DDL_DROP_SCRIPT_SOURCE
        Specifies the DROP script file as either a Reader configured for reading of the DDL script file or a string designating a file URL for the DDL script.
        See Also:
        HBM2DDL_DROP_SOURCE, Constant Field Values

      • JAKARTA_HBM2DDL_LOAD_SCRIPT_SOURCE

        static final java.lang.String JAKARTA_HBM2DDL_LOAD_SCRIPT_SOURCE
        JPA variant of HBM2DDL_IMPORT_FILES

        Specifies a Reader configured for reading of the SQL load script or a string designating the file URL for the SQL load script.

        A "SQL load script" is a script that performs some database initialization (INSERT, etc).

        See Also:
        Constant Field Values

      • JAKARTA_HBM2DDL_CREATE_SCHEMAS

        static final java.lang.String JAKARTA_HBM2DDL_CREATE_SCHEMAS
        The JPA variant of HBM2DDL_CREATE_NAMESPACES

        Specifies whether the persistence provider is to create the database schema(s) in addition to creating database objects (tables, sequences, constraints, etc). The value of this boolean property should be set to true if the persistence provider is to create schemas in the database or to generate DDL that contains "CREATE SCHEMA" commands. If this property is not supplied (or is explicitly false), the provider should not attempt to create database schemas.

        See Also:
        Constant Field Values

      • HBM2DDL_FILTER_PROVIDER

        static final java.lang.String HBM2DDL_FILTER_PROVIDER
        Used to specify the SchemaFilterProvider to 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_DELIMITER

        static final java.lang.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 java.lang.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 java.lang.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 java.lang.String HBM2DDL_DEFAULT_CONSTRAINT_MODE

        This setting is used when you use ConstraintMode.PROVIDER_DEFAULT strategy for foreign key mapping. valid value is CONSTRAINT and NO_CONSTRAINT.

        The default value is CONSTRAINT.

        Since:
        5.4
        See Also:
        Constant Field Values

      • USE_ENTITY_WHERE_CLAUSE_FOR_COLLECTIONS

        static final java.lang.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_IDENTIFIER_RESOLVER

        static final java.lang.String MULTI_TENANT_IDENTIFIER_RESOLVER
        Names a CurrentTenantIdentifierResolver implementation to use.

        Can be

        • CurrentTenantIdentifierResolver instance
        • CurrentTenantIdentifierResolver implementation Class reference
        • CurrentTenantIdentifierResolver implementation class name
        Since:
        4.1
        See Also:
        Constant Field Values

      • INTERCEPTOR

        static final java.lang.String INTERCEPTOR
        Names a Interceptor implementation to be applied to the SessionFactory and 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.

        See SESSION_SCOPED_INTERCEPTOR for an approach to create unique Interceptor instances for each Session

        Can reference

        • Interceptor instance
        • Interceptor implementation Class reference
        • Interceptor implementation class name
        Since:
        5.0
        See Also:
        Constant Field Values

      • SESSION_SCOPED_INTERCEPTOR

        static final java.lang.String SESSION_SCOPED_INTERCEPTOR
        Names a Interceptor implementation to be applied to the SessionFactory and 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 unlike INTERCEPTOR a unique instance of the Interceptor is used for each Session.

        Can reference

        • Interceptor implementation Class reference
        • Interceptor implementation class name
        • Supplier instance which is used to retrieve the interceptor
        Note specifically that this setting cannot name an Interceptor instance.
        Since:
        5.2
        See Also:
        Constant Field Values

      • STATEMENT_INSPECTOR

        static final java.lang.String STATEMENT_INSPECTOR
        Names a StatementInspector implementation to be applied to the SessionFactory. Can reference
        • StatementInspector instance
        • StatementInspector implementation Class reference
        • StatementInspector implementation class name (FQN)
        Since:
        5.0
        See Also:
        Constant Field Values

      • ENABLE_LAZY_LOAD_NO_TRANS

        static final java.lang.String ENABLE_LAZY_LOAD_NO_TRANS
        See Also:
        Constant Field Values

      • HQL_BULK_ID_STRATEGY

        static final java.lang.String HQL_BULK_ID_STRATEGY
        See Also:
        Constant Field Values

      • DELAY_ENTITY_LOADER_CREATIONS

        static final java.lang.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 for LockMode.NONE, which will always be eagerly initialized; this is necessary to detect mapping errors. `false` indicates that all loaders should be created up front; this will consume more memory but ensures all necessary memory is allocated right away.
        Since:
        5.3
        See Also:
        Constant Field Values

      • JTA_TRACK_BY_THREAD

        static final java.lang.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 is true (enabled).
        See Also:
        Constant Field Values

      • ENABLE_SYNONYMS

        static final java.lang.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 java.lang.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 java.lang.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 existed UniqueConstraintSchemaUpdateStrategy.SKIP: do not attempt to create unique constraints on a schema update
        See Also:
        Constant Field Values

      • GENERATE_STATISTICS

        static final java.lang.String GENERATE_STATISTICS
        Enable statistics collection
        See Also:
        Constant Field Values

      • LOG_SESSION_METRICS

        static final java.lang.String LOG_SESSION_METRICS
        A setting to control whether to StatisticalLoggingSessionEventListener is enabled on all Sessions (unless explicitly disabled for a given Session). The default value of this setting is determined by the value for GENERATE_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 java.lang.String LOG_SLOW_QUERY
        Setting that logs query which executed slower than specified milliseconds. Default is 0 (disabled).
        See Also:
        Constant Field Values

      • PROCEDURE_NULL_PARAM_PASSING

        @Deprecated
static final java.lang.String PROCEDURE_NULL_PARAM_PASSING
        Deprecated.
        (5.3) Hibernate determines it implicitly
        Global setting for whether NULL parameter bindings should be passed to database procedure/function calls as part of ProcedureCall handling. Implicitly Hibernate will not pass the NULL, the intention being to allow any default argument values to be applied.

        This defines a global setting, which can then be controlled per parameter via ParameterRegistration.enablePassingNulls(boolean)

        Values are true (pass the NULLs) or false (do not pass the NULLs).

        See Also:
        Constant Field Values

      • CREATE_EMPTY_COMPOSITES_ENABLED

        static final java.lang.String CREATE_EMPTY_COMPOSITES_ENABLED
        [EXPERIMENTAL] Enable instantiation of composite/embedded objects when all of its attribute values are null. The default (and historical) behavior is that a null reference will be used to represent the composite when all of its attributes are null

        This 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 java.lang.String ALLOW_JTA_TRANSACTION_ACCESS
        Setting that allows access to the underlying Transaction, even when using a JTA since normal JPA operations prohibit this behavior.

        Values are true grants access, false does 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 java.lang.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: true to allow flush operations out of a transaction, false to disallow.

        The default behavior is false

        Since:
        5.2
        See Also:
        Constant Field Values

      • COLLECTION_JOIN_SUBQUERY

        static final java.lang.String COLLECTION_JOIN_SUBQUERY
        Setting which indicates whether or not the new JOINS over collection tables should be rewritten to subqueries.

        Default is true. Existing applications may want to disable this (set it false) for upgrade compatibility.

        Since:
        5.2
        See Also:
        Constant Field Values

      • MERGE_ENTITY_COPY_OBSERVER

        static final java.lang.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 IllegalStateException if an entity copy is detected
        • allow: performs the merge operation on each entity copy that is detected
        • log: (provided for testing only) performs the merge operation on each entity copy that is detected and logs information about the entity copies. This setting requires DEBUG logging be enabled for EntityCopyAllowedLoggedObserver.

        In addition, the application may customize the behavior by providing an implementation of EntityCopyObserver and setting hibernate.event.merge.entity_copy_observer to the class name. When this property is set to allow or log, Hibernate will merge each entity copy detected while cascading the merge operation. In the process of merging each entity copy, Hibernate will cascade the merge operation from each entity copy to its associations with CascadeType.MERGE or CascadeType.ALL. The entity state resulting from merging an entity copy will be overwritten when another entity copy is merged.

        Since:
        4.3
        See Also:
        Constant Field Values

      • USE_LEGACY_LIMIT_HANDLERS

        static final java.lang.String USE_LEGACY_LIMIT_HANDLERS
        Setting which indicates whether or not to use LimitHandler implementations 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 is false.
        Since:
        5.2.5
        See Also:
        Constant Field Values

      • PREFER_GENERATOR_NAME_AS_DEFAULT_SEQUENCE_NAME

        static final java.lang.String PREFER_GENERATOR_NAME_AS_DEFAULT_SEQUENCE_NAME
        True/false setting indicating whether the value specified for GeneratedValue.generator() should be used as the sequence/table name when no matching SequenceGenerator or TableGenerator is found. The default value is `true` meaning that GeneratedValue.generator() will be used as the sequence/table name by default. Users migrating from earlier versions using the legacy `hibernate_sequence` name should disable this setting.
        See Also:
        Constant Field Values

      • JPA_QUERY_COMPLIANCE

        static final java.lang.String JPA_QUERY_COMPLIANCE
        Controls whether Hibernate's handling of Query (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 the Query methods 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 java.lang.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 where OrderColumn is just missing (and its defaults will apply).
        Since:
        5.3
        See Also:
        JpaCompliance.isJpaListComplianceEnabled(), Constant Field Values

      • JPA_CLOSED_COMPLIANCE

        static final java.lang.String JPA_CLOSED_COMPLIANCE
        JPA defines specific exceptions on specific methods when called on EntityManager and EntityManagerFactory when 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 java.lang.String JPA_PROXY_COMPLIANCE
        The JPA spec says that a EntityNotFoundException should 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

      • TABLE_GENERATOR_STORE_LAST_USED

        static final java.lang.String TABLE_GENERATOR_STORE_LAST_USED
        True/False setting indicating if the value stored in the table used by the TableGenerator is 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 java.lang.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

      • IN_CLAUSE_PARAMETER_PADDING

        static final java.lang.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 to true.

        The default value is false.
        Since:
        5.2.17
        See Also:
        Constant Field Values

      • OMIT_JOIN_OF_SUPERCLASS_TABLES

        static final java.lang.String OMIT_JOIN_OF_SUPERCLASS_TABLES

        When you use InheritanceType.JOINED strategy 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

      • JACC_CONTEXT_ID

        @Deprecated
static final java.lang.String JACC_CONTEXT_ID
        Deprecated.
        Support for JACC will be removed in 6.0
        See Also:
        Constant Field Values

      • JACC_PREFIX

        @Deprecated
static final java.lang.String JACC_PREFIX
        Deprecated.
        Support for JACC will be removed in 6.0
        See Also:
        Constant Field Values

      • JACC_ENABLED

        @Deprecated
static final java.lang.String JACC_ENABLED
        Deprecated.
        Support for JACC will be removed in 6.0
        See Also:
        Constant Field Values

      • JMX_ENABLED

        @Deprecated
static final java.lang.String JMX_ENABLED
        Deprecated.
        Scheduled for removal in 6.0; see https://hibernate.atlassian.net/browse/HHH-14847 and https://hibernate.atlassian.net/browse/HHH-14846
        See Also:
        Constant Field Values

      • JMX_PLATFORM_SERVER

        @Deprecated
static final java.lang.String JMX_PLATFORM_SERVER
        Deprecated.
        Scheduled for removal in 6.0; see https://hibernate.atlassian.net/browse/HHH-14847 and https://hibernate.atlassian.net/browse/HHH-14846
        See Also:
        Constant Field Values

      • JMX_AGENT_ID

        @Deprecated
static final java.lang.String JMX_AGENT_ID
        Deprecated.
        Scheduled for removal in 6.0; see https://hibernate.atlassian.net/browse/HHH-14847 and https://hibernate.atlassian.net/browse/HHH-14846
        See Also:
        Constant Field Values

      • JMX_DOMAIN_NAME

        @Deprecated
static final java.lang.String JMX_DOMAIN_NAME
        Deprecated.
        Scheduled for removal in 6.0; see https://hibernate.atlassian.net/browse/HHH-14847 and https://hibernate.atlassian.net/browse/HHH-14846
        See Also:
        Constant Field Values

      • JMX_SF_NAME

        @Deprecated
static final java.lang.String JMX_SF_NAME
        Deprecated.
        Scheduled for removal in 6.0; see https://hibernate.atlassian.net/browse/HHH-14847 and https://hibernate.atlassian.net/browse/HHH-14846
        See Also:
        Constant Field Values

      • JMX_DEFAULT_OBJ_NAME_DOMAIN

        @Deprecated
static final java.lang.String JMX_DEFAULT_OBJ_NAME_DOMAIN
        Deprecated.
        Scheduled for removal in 6.0; see https://hibernate.atlassian.net/browse/HHH-14847 and https://hibernate.atlassian.net/browse/HHH-14846
        See Also:
        Constant Field Values