Package org.hibernate.boot.spi

Interface SessionFactoryOptions

All Superinterfaces:

QueryEngineOptions

All Known Implementing Classes:

AbstractDelegatingSessionFactoryOptions, SessionFactoryOptionsBuilder

public interface SessionFactoryOptions
extends QueryEngineOptions

Aggregator of special options used to build the SessionFactory.

Since:

5.0

See Also:

• SessionFactoryImplementor.getSessionFactoryOptions()

API Note:

This type belongs to an SPI package. Due to a historical mistake, it is exposed via the deprecated method SessionFactory.getSessionFactoryOptions().

Method Summary

Modifier and Type	Method	Description
boolean	areJPACallbacksEnabled()	Should JPA entity lifecycle callbacks be processed by the EventEngine and CallbackRegistry?
default SessionEventListener[]	buildSessionEventListeners()	Build an array of baseline SessionEventListeners.
boolean	doesConnectionProviderDisableAutoCommit()	Do newly-obtained JDBC connections come with autocommit already disabled?
BaselineSessionEventsListenerBuilder	getBaselineSessionEventsListenerBuilder()	Deprecated, for removal: This API element is subject to removal in a future version. This operation is a layer-breaker, exposing an internal type.
Object	getBeanManagerReference()
String	getCacheRegionPrefix()	A factory-specific prefix to be applied to all cache region names.
CacheRetrieveMode	getCacheRetrieveMode(Map<String,Object> properties)	Determine the default CacheRetrieveMode, given the current session properties.
CacheStoreMode	getCacheStoreMode(Map<String,Object> properties)	Determine the default CacheStoreMode, given the current session properties.
CurrentTenantIdentifierResolver<Object>	getCurrentTenantIdentifierResolver()	Obtain a reference to the current tenant identifier resolver, if any, or return null is there is no resolver configured.
CustomEntityDirtinessStrategy	getCustomEntityDirtinessStrategy()	A custom strategy for determining if an entity instance is dirty.
int	getDefaultBatchFetchSize()	The default batch size for batch fetching in new sessions.
default String	getDefaultCatalog()	The default catalog to use in generated SQL when a catalog wasn't specified in the mapping, neither explicitly nor implicitly (see the concept of implicit catalog in XML mapping).
LockOptions	getDefaultLockOptions()	The default lock scope and lock timeout.
Nulls	getDefaultNullPrecedence()	The default precedence of null values in sorted query results.
default String	getDefaultSchema()	The default schema to use in generated SQL when a catalog wasn't specified in the mapping, neither explicitly nor implicitly (see the concept of implicit schema in XML mapping).
Map<String,Object>	getDefaultSessionProperties()	Default properties for brand-new sessions.
default JavaType<Object>	getDefaultTenantIdentifierJavaType()	The default tenant identifier java type to use, in case no explicit tenant identifier property is defined.
TimeZoneStorageStrategy	getDefaultTimeZoneStorageStrategy()
EntityNameResolver[]	getEntityNameResolvers()	An array of custom entity name resolvers.
EntityNotFoundDelegate	getEntityNotFoundDelegate()	Get the delegate for handling entity-not-found exception conditions.
CacheMode	getInitialSessionCacheMode()	The default initial CacheMode for new sessions.
FlushMode	getInitialSessionFlushMode()	The default initial FlushMode for new sessions.
Interceptor	getInterceptor()	An interceptor instance shared between all sessions created by this factory.
int	getJdbcBatchSize()	The default JDBC statement batch size for new sessions.
Integer	getJdbcFetchSize()
TimeZone	getJdbcTimeZone()	The timezone to use when interacting with JDBC.
JpaCompliance	getJpaCompliance()
FormatMapper	getJsonFormatMapper()	The format mapper to use for serializing/deserializing JSON data.
Integer	getMaximumFetchDepth()
default boolean	getNativeJdbcParametersIgnored()
PhysicalConnectionHandlingMode	getPhysicalConnectionHandlingMode()
int	getPreferredSqlTypeCodeForArray()
int	getPreferredSqlTypeCodeForBoolean()
int	getPreferredSqlTypeCodeForDuration()
int	getPreferredSqlTypeCodeForInstant()
int	getPreferredSqlTypeCodeForUuid()
CacheLayout	getQueryCacheLayout()	The layout of entries in the query cache.
int	getQueryStatisticsMaxSize()	The number of QueryStatistics entries that should be stored by Statistics.
SchemaAutoTooling	getSchemaAutoTooling()	Deprecated, for removal: This API element is subject to removal in a future version. This is unused and will be removed.
StandardServiceRegistry	getServiceRegistry()	The service registry to use in building the factory.
String	getSessionFactoryName()	The name to be used for the SessionFactory.
SessionFactoryObserver[]	getSessionFactoryObservers()	Observers for events raised by the factory.
Supplier<? extends Interceptor>	getStatelessInterceptorImplementorSupplier()	A stateless Supplier for interceptor instances which are not shared between sessions created by this factory.
StatementInspector	getStatementInspector()	The default StatementInspector for this factory.
TempTableDdlTransactionHandling	getTempTableDdlTransactionHandling()	Deprecated, for removal: This API element is subject to removal in a future version.
TimestampsCacheFactory	getTimestampsCacheFactory()	A factory for the TimestampsCache used to track invalidation of cached query result sets.
String	getUuid()	Get the UUID unique to this SessionFactoryOptions.
Object	getValidatorFactoryReference()
FormatMapper	getXmlFormatMapper()	The format mapper to use for serializing/deserializing XML data.
default boolean	inClauseParameterPaddingEnabled()
boolean	isAllowOutOfTransactionUpdateOperations()
default boolean	isAllowRefreshDetachedEntity()	Deprecated, for removal: This API element is subject to removal in a future version. with no replacement.
boolean	isAutoCloseSessionEnabled()
boolean	isAutoEvictCollectionCache()
boolean	isCheckNullability()	Should Hibernate validate that non-optional attributes have non-null values?
default boolean	isCollectionsInDefaultFetchGroupEnabled()
boolean	isCommentsEnabled()	Should explanatory comment text be added to the generated SQL?
default boolean	isCriteriaCopyTreeEnabled()
default boolean	isCriteriaPlanCacheEnabled()
boolean	isDelayBatchFetchLoaderCreationsEnabled()	Deprecated, for removal: This API element is subject to removal in a future version. This is no longer used
boolean	isDirectReferenceCacheEntriesEnabled()
boolean	isFailOnPaginationOverCollectionFetchEnabled()
boolean	isFlushBeforeCompletionEnabled()
boolean	isGetGeneratedKeysEnabled()
boolean	isIdentifierRollbackEnabled()	Should generated identifiers be reset after entity removal?
boolean	isInitializeLazyStateOutsideTransactionsEnabled()	Are detached proxies and collections fetched in a temporary persistence context?
boolean	isJpaBootstrap()	Was building of the SessionFactory initiated through JPA bootstrapping, or through Hibernate-native bootstrapping?
boolean	isJtaTrackByThread()
boolean	isJtaTransactionAccessEnabled()
boolean	isMinimalPutsEnabled()	Should we avoid overwriting cache entries with identical entries?
boolean	isMultiTenancyEnabled()	Is there a multi-tenant connection provider configured?
boolean	isNamedQueryStartupCheckingEnabled()	Are named queries validated when the factory is created?
boolean	isOrderInsertsEnabled()
boolean	isOrderUpdatesEnabled()
boolean	isPassProcedureParameterNames()
boolean	isPreferJavaTimeJdbcTypesEnabled()
boolean	isPreferJdbcDatetimeTypesInNativeQueriesEnabled()	Should native queries return JDBC datetime types instead of using java.time types.
boolean	isPreferNativeEnumTypesEnabled()
boolean	isPreferUserTransaction()
boolean	isQueryCacheEnabled()	Is the query cache enabled?
boolean	isReleaseResourcesOnCloseEnabled()	Deprecated, for removal: This API element is subject to removal in a future version. since "hibernate.discard_pc_on_close" is deprecated
boolean	isScrollableResultSetsEnabled()
boolean	isSecondLevelCacheEnabled()	Is the second-level cache enabled?
Boolean	isSessionFactoryNameAlsoJndiName()	Is the session factory name also a JNDI name, indicating we should bind it into JNDI?
boolean	isStatisticsEnabled()	Is collection of statistics enabled by default for this factory?
boolean	isStructuredCacheEntriesEnabled()	Are second-level cache entries stored in a human-readable format.
boolean	isSubselectFetchEnabled()	Is subselect fetching enabled by default in new sessions?
boolean	isUnownedAssociationTransientCheck()
boolean	isUseOfJdbcNamedParametersEnabled()	Controls whether Hibernate should try to map named parameter names specified in a ProcedureCall or StoredProcedureQuery to named parameters in the JDBC CallableStatement.
boolean	isXmlFormatMapperLegacyFormatEnabled()	Whether to use the legacy format for serializing/deserializing XML data.
void	setCheckNullability(boolean enabled)	Allows Bean Validation to disable null checking.

Methods inherited from interface org.hibernate.query.spi.QueryEngineOptions

allowImmutableEntityUpdate, getCriteriaValueHandlingMode, getCustomHqlTranslator, getCustomSqlFunctionMap, getCustomSqmFunctionRegistry, getCustomSqmMultiTableInsertStrategy, getCustomSqmMultiTableMutationStrategy, getCustomSqmTranslatorFactory, getImmutableEntityUpdateQueryHandlingMode, isJsonFunctionsEnabled, isPortableIntegerDivisionEnabled, isXmlFunctionsEnabled

Method Details

getUuid

String getUuid()

Get the UUID unique to this SessionFactoryOptions. Will be the same value available as SessionFactoryImplementor.getUuid().

Specified by:

getUuid in interface QueryEngineOptions

Returns:

The UUID for this SessionFactory.

See Also:

• SessionFactoryRegistry.getSessionFactory(java.lang.String)
• SessionFactoryImplementor.getUuid()

API Note:

The value is generated as a UUID, but kept as a String.

getServiceRegistry

StandardServiceRegistry getServiceRegistry()

The service registry to use in building the factory.

Returns:

The service registry to use.

getBeanManagerReference

Object getBeanManagerReference()

See Also:

• ManagedBeanSettings.JAKARTA_CDI_BEAN_MANAGER

getValidatorFactoryReference

Object getValidatorFactoryReference()

See Also:

• ValidationSettings.JAKARTA_VALIDATION_FACTORY

getJpaCompliance

JpaCompliance getJpaCompliance()

Specified by:

getJpaCompliance in interface QueryEngineOptions

See Also:

• JpaComplianceSettings

isJpaBootstrap

boolean isJpaBootstrap()

Was building of the SessionFactory initiated through JPA bootstrapping, or through Hibernate-native bootstrapping?

Returns:

true indicates the SessionFactory was built through JPA bootstrapping; false indicates it was built through native bootstrapping.

isAllowRefreshDetachedEntity

@Deprecated(since="7.0",
            forRemoval=true)
default boolean isAllowRefreshDetachedEntity()

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

with no replacement.

getSessionFactoryName

String getSessionFactoryName()

The name to be used for the SessionFactory. This is used during in-VM serialization; see SessionFactoryRegistry. May also be used as a JNDI name, depending on "hibernate.session_factory_jndi_name" and "hibernate.session_factory_name_is_jndi".

Specified by:

getSessionFactoryName in interface QueryEngineOptions

Returns:

The session factory name

See Also:

• PersistenceSettings.SESSION_FACTORY_NAME

isSessionFactoryNameAlsoJndiName

Boolean isSessionFactoryNameAlsoJndiName()

Is the session factory name also a JNDI name, indicating we should bind it into JNDI?

Returns:

true if the SessionFactory name is also a JNDI name; false otherwise.

See Also:

• PersistenceSettings.SESSION_FACTORY_NAME_IS_JNDI

isStatisticsEnabled

boolean isStatisticsEnabled()

Is collection of statistics enabled by default for this factory?

See Also:

• StatisticsSettings.GENERATE_STATISTICS
• Statistics.setStatisticsEnabled(boolean)

getInterceptor

Interceptor getInterceptor()

An interceptor instance shared between all sessions created by this factory. Such an interceptor must be thread-safe and may not hold state associated with any given session.

Returns:

The interceptor instance to use factory-wide by default. May be null.

See Also:

• SessionEventSettings.INTERCEPTOR
• SessionBuilder.interceptor(Interceptor)

getStatelessInterceptorImplementorSupplier

Supplier<? extends Interceptor> getStatelessInterceptorImplementorSupplier()

A stateless Supplier for interceptor instances which are not shared between sessions created by this factory. This allows each Interceptor instances itself to hold state associated with its session.

Returns:

The interceptor supplier to use by default. May be null.

See Also:

• SessionEventSettings.SESSION_SCOPED_INTERCEPTOR
• SessionBuilder.interceptor(Interceptor)

getStatementInspector

StatementInspector getStatementInspector()

The default StatementInspector for this factory.

See Also:

• JdbcSettings.STATEMENT_INSPECTOR
• SessionBuilder.statementInspector(StatementInspector)

getSessionFactoryObservers

SessionFactoryObserver[] getSessionFactoryObservers()

Observers for events raised by the factory.

See Also:

• PersistenceSettings.SESSION_FACTORY_OBSERVER

getBaselineSessionEventsListenerBuilder

@Deprecated(since="7.0",
            forRemoval=true)
BaselineSessionEventsListenerBuilder getBaselineSessionEventsListenerBuilder()

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

This operation is a layer-breaker, exposing an internal type. It will be removed. Use buildSessionEventListeners() instead.

buildSessionEventListeners

default SessionEventListener[] buildSessionEventListeners()

Build an array of baseline SessionEventListeners.

Since:

7.0

See Also:

• SessionBuilder.eventListeners(SessionEventListener...)

isIdentifierRollbackEnabled

boolean isIdentifierRollbackEnabled()

Should generated identifiers be reset after entity removal?

See Also:

• AvailableSettings.USE_IDENTIFIER_ROLLBACK
• SessionBuilder.identifierRollback(boolean)

isCheckNullability

boolean isCheckNullability()

Should Hibernate validate that non-optional attributes have non-null values?

See Also:

• ValidationSettings.CHECK_NULLABILITY

setCheckNullability

@Internal
void setCheckNullability(boolean enabled)

Allows Bean Validation to disable null checking.

API Note:

It's quite ugly to have a setter method on this SPI. This operation is for internal use by Bean Validation integration logic.

isInitializeLazyStateOutsideTransactionsEnabled

boolean isInitializeLazyStateOutsideTransactionsEnabled()

Are detached proxies and collections fetched in a temporary persistence context?

See Also:

• TransactionSettings.ENABLE_LAZY_LOAD_NO_TRANS

API Note:

The naming here is very misleading. This behavior has little to do with transactions.

getTempTableDdlTransactionHandling

@Deprecated(since="7.0",
            forRemoval=true)
TempTableDdlTransactionHandling getTempTableDdlTransactionHandling()

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

This is unused and will be removed.

isDelayBatchFetchLoaderCreationsEnabled

@Deprecated(since="7",
            forRemoval=true)
boolean isDelayBatchFetchLoaderCreationsEnabled()

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

This is no longer used

See Also:

• AvailableSettings.DELAY_ENTITY_LOADER_CREATIONS

getDefaultBatchFetchSize

int getDefaultBatchFetchSize()

The default batch size for batch fetching in new sessions.

See Also:

• FetchSettings.DEFAULT_BATCH_FETCH_SIZE
• Session.setFetchBatchSize(int)

getMaximumFetchDepth

Integer getMaximumFetchDepth()

See Also:

• FetchSettings.MAX_FETCH_DEPTH

isSubselectFetchEnabled

boolean isSubselectFetchEnabled()

Is subselect fetching enabled by default in new sessions?

See Also:

• FetchSettings.USE_SUBSELECT_FETCH
• Session.setSubselectFetchingEnabled(boolean)

getDefaultNullPrecedence

Nulls getDefaultNullPrecedence()

The default precedence of null values in sorted query results.

See Also:

• QuerySettings.DEFAULT_NULL_ORDERING

isOrderUpdatesEnabled

boolean isOrderUpdatesEnabled()

See Also:

• BatchSettings.ORDER_UPDATES

isOrderInsertsEnabled

boolean isOrderInsertsEnabled()

See Also:

• BatchSettings.ORDER_INSERTS

isMultiTenancyEnabled

boolean isMultiTenancyEnabled()

Is there a multi-tenant connection provider configured?

See Also:

• MultiTenancySettings.MULTI_TENANT_CONNECTION_PROVIDER

getCurrentTenantIdentifierResolver

CurrentTenantIdentifierResolver<Object> getCurrentTenantIdentifierResolver()

Obtain a reference to the current tenant identifier resolver, if any, or return null is there is no resolver configured.

See Also:

• MultiTenancySettings.MULTI_TENANT_IDENTIFIER_RESOLVER

isJtaTrackByThread

boolean isJtaTrackByThread()

See Also:

• TransactionSettings.JTA_TRACK_BY_THREAD

isNamedQueryStartupCheckingEnabled

boolean isNamedQueryStartupCheckingEnabled()

Are named queries validated when the factory is created?

See Also:

• QuerySettings.QUERY_STARTUP_CHECKING

isSecondLevelCacheEnabled

boolean isSecondLevelCacheEnabled()

Is the second-level cache enabled?

See Also:

• CacheSettings.USE_SECOND_LEVEL_CACHE

isQueryCacheEnabled

boolean isQueryCacheEnabled()

Is the query cache enabled?

See Also:

• CacheSettings.USE_QUERY_CACHE

getQueryCacheLayout

@Incubating
CacheLayout getQueryCacheLayout()

The layout of entries in the query cache.

See Also:

• CacheSettings.QUERY_CACHE_LAYOUT

getTimestampsCacheFactory

TimestampsCacheFactory getTimestampsCacheFactory()

A factory for the TimestampsCache used to track invalidation of cached query result sets.

See Also:

• CacheSettings.QUERY_CACHE_FACTORY

getCacheRegionPrefix

String getCacheRegionPrefix()

A factory-specific prefix to be applied to all cache region names.

See Also:

• CacheSettings.CACHE_REGION_PREFIX

isMinimalPutsEnabled

boolean isMinimalPutsEnabled()

Should we avoid overwriting cache entries with identical entries?

This is useful if cache writes are much more expensive than cache reads.

See Also:

• CacheSettings.USE_MINIMAL_PUTS

API Note:

This is currently unused.

isStructuredCacheEntriesEnabled

boolean isStructuredCacheEntriesEnabled()

Are second-level cache entries stored in a human-readable format.

See Also:

• CacheSettings.USE_STRUCTURED_CACHE

isDirectReferenceCacheEntriesEnabled

boolean isDirectReferenceCacheEntriesEnabled()

See Also:

• CacheSettings.USE_DIRECT_REFERENCE_CACHE_ENTRIES

isAutoEvictCollectionCache

boolean isAutoEvictCollectionCache()

See Also:

• CacheSettings.AUTO_EVICT_COLLECTION_CACHE

getSchemaAutoTooling

@Deprecated(since="7.0",
            forRemoval=true)
SchemaAutoTooling getSchemaAutoTooling()

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

This is unused and will be removed.

See Also:

• SchemaToolingSettings.HBM2DDL_AUTO

getJdbcBatchSize

int getJdbcBatchSize()

The default JDBC statement batch size for new sessions.

See Also:

• BatchSettings.STATEMENT_BATCH_SIZE
• SharedSessionContract.setJdbcBatchSize(Integer)

isScrollableResultSetsEnabled

boolean isScrollableResultSetsEnabled()

See Also:

• JdbcSettings.USE_SCROLLABLE_RESULTSET

isGetGeneratedKeysEnabled

boolean isGetGeneratedKeysEnabled()

See Also:

• JdbcSettings.USE_GET_GENERATED_KEYS

getJdbcFetchSize

Integer getJdbcFetchSize()

See Also:

• JdbcSettings.STATEMENT_FETCH_SIZE

getPhysicalConnectionHandlingMode

PhysicalConnectionHandlingMode getPhysicalConnectionHandlingMode()

See Also:

• JdbcSettings.CONNECTION_HANDLING
• SessionBuilder.connectionHandlingMode(PhysicalConnectionHandlingMode)

doesConnectionProviderDisableAutoCommit

boolean doesConnectionProviderDisableAutoCommit()

Do newly-obtained JDBC connections come with autocommit already disabled?

See Also:

• JdbcSettings.CONNECTION_PROVIDER_DISABLES_AUTOCOMMIT

isCommentsEnabled

boolean isCommentsEnabled()

Should explanatory comment text be added to the generated SQL?

See Also:

• JdbcSettings.USE_SQL_COMMENTS

getCustomEntityDirtinessStrategy

CustomEntityDirtinessStrategy getCustomEntityDirtinessStrategy()

A custom strategy for determining if an entity instance is dirty.

See Also:

• AvailableSettings.CUSTOM_ENTITY_DIRTINESS_STRATEGY

getEntityNameResolvers

EntityNameResolver[] getEntityNameResolvers()

An array of custom entity name resolvers.

See Also:

• Configuration.addEntityNameResolver(EntityNameResolver)

getEntityNotFoundDelegate

EntityNotFoundDelegate getEntityNotFoundDelegate()

Get the delegate for handling entity-not-found exception conditions.

Returns StandardEntityNotFoundDelegate by default.

Returns:

The specific EntityNotFoundDelegate to use, may be null

See Also:

• Configuration.setEntityNotFoundDelegate(org.hibernate.proxy.EntityNotFoundDelegate)

isFlushBeforeCompletionEnabled

boolean isFlushBeforeCompletionEnabled()

See Also:

• TransactionSettings.FLUSH_BEFORE_COMPLETION

isAutoCloseSessionEnabled

boolean isAutoCloseSessionEnabled()

See Also:

• TransactionSettings.AUTO_CLOSE_SESSION

isJtaTransactionAccessEnabled

boolean isJtaTransactionAccessEnabled()

See Also:

• TransactionSettings.ALLOW_JTA_TRANSACTION_ACCESS

isPreferUserTransaction

boolean isPreferUserTransaction()

See Also:

• TransactionSettings.PREFER_USER_TRANSACTION

isAllowOutOfTransactionUpdateOperations

boolean isAllowOutOfTransactionUpdateOperations()

See Also:

• TransactionSettings.ALLOW_UPDATE_OUTSIDE_TRANSACTION

isReleaseResourcesOnCloseEnabled

@Deprecated(since="7.0",
            forRemoval=true)
boolean isReleaseResourcesOnCloseEnabled()

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

since "hibernate.discard_pc_on_close" is deprecated

See Also:

• AvailableSettings.DISCARD_PC_ON_CLOSE

getJdbcTimeZone

TimeZone getJdbcTimeZone()

The timezone to use when interacting with JDBC.

See Also:

• JdbcSettings.JDBC_TIME_ZONE
• SessionBuilder.jdbcTimeZone(TimeZone)

isCriteriaCopyTreeEnabled

default boolean isCriteriaCopyTreeEnabled()

See Also:

• QuerySettings.CRITERIA_COPY_TREE

isCriteriaPlanCacheEnabled

default boolean isCriteriaPlanCacheEnabled()

See Also:

• QuerySettings.CRITERIA_PLAN_CACHE_ENABLED

getNativeJdbcParametersIgnored

default boolean getNativeJdbcParametersIgnored()

See Also:

• QuerySettings.NATIVE_IGNORE_JDBC_PARAMETERS

isFailOnPaginationOverCollectionFetchEnabled

boolean isFailOnPaginationOverCollectionFetchEnabled()

See Also:

• QuerySettings.FAIL_ON_PAGINATION_OVER_COLLECTION_FETCH

getDefaultCatalog

default String getDefaultCatalog()

The default catalog to use in generated SQL when a catalog wasn't specified in the mapping, neither explicitly nor implicitly (see the concept of implicit catalog in XML mapping).

Returns:

The default catalog to use.

See Also:

• MappingSettings.DEFAULT_CATALOG

getDefaultSchema

default String getDefaultSchema()

The default schema to use in generated SQL when a catalog wasn't specified in the mapping, neither explicitly nor implicitly (see the concept of implicit schema in XML mapping).

Returns:

The default schema to use.

See Also:

• MappingSettings.DEFAULT_SCHEMA

inClauseParameterPaddingEnabled

default boolean inClauseParameterPaddingEnabled()

See Also:

• QuerySettings.IN_CLAUSE_PARAMETER_PADDING

getQueryStatisticsMaxSize

int getQueryStatisticsMaxSize()

The number of QueryStatistics entries that should be stored by Statistics.

See Also:

• StatisticsSettings.QUERY_STATISTICS_MAX_SIZE

areJPACallbacksEnabled

boolean areJPACallbacksEnabled()

Should JPA entity lifecycle callbacks be processed by the EventEngine and CallbackRegistry?

See Also:

• PersistenceSettings.JPA_CALLBACKS_ENABLED

isUseOfJdbcNamedParametersEnabled

boolean isUseOfJdbcNamedParametersEnabled()

Controls whether Hibernate should try to map named parameter names specified in a ProcedureCall or StoredProcedureQuery to named parameters in the JDBC CallableStatement.

As JPA is defined, the use of named parameters is essentially of dubious value since by spec the parameters have to be defined in the order they are defined in the procedure/function declaration - we can always bind them positionally. The whole idea of named parameters for CallableStatement is the ability to bind these in any order, but since we unequivocally know the order anyway binding them via name really gains nothing.

If this is true, we still need to make sure the Dialect supports named binding. Setting this to false simply circumvents that check and always performs positional binding.

Returns:

true indicates we should try to use CallableStatement named parameters, if the Dialect says it is supported; false indicates that we should never try to use CallableStatement named parameters, regardless of what the Dialect says.

See Also:

• QuerySettings.CALLABLE_NAMED_PARAMS_ENABLED

isCollectionsInDefaultFetchGroupEnabled

default boolean isCollectionsInDefaultFetchGroupEnabled()

isUnownedAssociationTransientCheck

boolean isUnownedAssociationTransientCheck()

See Also:

• PersistenceSettings.UNOWNED_ASSOCIATION_TRANSIENT_CHECK

getPreferredSqlTypeCodeForBoolean

@Incubating
int getPreferredSqlTypeCodeForBoolean()

See Also:

• MappingSettings.PREFERRED_BOOLEAN_JDBC_TYPE

getPreferredSqlTypeCodeForDuration

@Incubating
int getPreferredSqlTypeCodeForDuration()

See Also:

• MappingSettings.PREFERRED_DURATION_JDBC_TYPE

getPreferredSqlTypeCodeForUuid

@Incubating
int getPreferredSqlTypeCodeForUuid()

See Also:

• MappingSettings.PREFERRED_UUID_JDBC_TYPE

getPreferredSqlTypeCodeForInstant

@Incubating
int getPreferredSqlTypeCodeForInstant()

See Also:

• MappingSettings.PREFERRED_INSTANT_JDBC_TYPE

getPreferredSqlTypeCodeForArray

@Incubating
int getPreferredSqlTypeCodeForArray()

See Also:

• MappingSettings.PREFERRED_ARRAY_JDBC_TYPE

getDefaultTimeZoneStorageStrategy

@Incubating
TimeZoneStorageStrategy getDefaultTimeZoneStorageStrategy()

See Also:

• MappingSettings.TIMEZONE_DEFAULT_STORAGE

isPreferJavaTimeJdbcTypesEnabled

boolean isPreferJavaTimeJdbcTypesEnabled()

See Also:

• MappingSettings.JAVA_TIME_USE_DIRECT_JDBC

isPreferNativeEnumTypesEnabled

boolean isPreferNativeEnumTypesEnabled()

See Also:

• MappingSettings.PREFER_NATIVE_ENUM_TYPES

getJsonFormatMapper

@Incubating
FormatMapper getJsonFormatMapper()

The format mapper to use for serializing/deserializing JSON data.

Since:

6.0

See Also:

• MappingSettings.JSON_FORMAT_MAPPER

getXmlFormatMapper

@Incubating
FormatMapper getXmlFormatMapper()

The format mapper to use for serializing/deserializing XML data.

Since:

6.0.1

See Also:

• MappingSettings.XML_FORMAT_MAPPER

isXmlFormatMapperLegacyFormatEnabled

@Incubating
boolean isXmlFormatMapperLegacyFormatEnabled()

Whether to use the legacy format for serializing/deserializing XML data.

Since:

7.0

See Also:

• MappingSettings.XML_FORMAT_MAPPER_LEGACY_FORMAT

getDefaultTenantIdentifierJavaType

@Incubating
default JavaType<Object> getDefaultTenantIdentifierJavaType()

The default tenant identifier java type to use, in case no explicit tenant identifier property is defined.

Since:

6.4

isPassProcedureParameterNames

boolean isPassProcedureParameterNames()

See Also:

• QuerySettings.QUERY_PASS_PROCEDURE_PARAMETER_NAMES

isPreferJdbcDatetimeTypesInNativeQueriesEnabled

boolean isPreferJdbcDatetimeTypesInNativeQueriesEnabled()

Should native queries return JDBC datetime types instead of using java.time types.

Since:

7.0

See Also:

• QuerySettings.NATIVE_PREFER_JDBC_DATETIME_TYPES

getCacheStoreMode

CacheStoreMode getCacheStoreMode(Map<String,Object> properties)

Determine the default CacheStoreMode, given the current session properties.

Parameters:

properties - the Session properties

Returns:

either the CacheStoreMode as defined in the session-specific properties, or as defined in the properties shared across all sessions (the defaults).

getCacheRetrieveMode

CacheRetrieveMode getCacheRetrieveMode(Map<String,Object> properties)

Determine the default CacheRetrieveMode, given the current session properties.

Parameters:

properties - the Session properties

Returns:

either the CacheRetrieveMode as defined in the session-specific properties, or as defined in the properties shared across all sessions (the defaults).

getInitialSessionCacheMode

CacheMode getInitialSessionCacheMode()

The default initial CacheMode for new sessions.

See Also:

• CacheSettings.JAKARTA_SHARED_CACHE_RETRIEVE_MODE
• CacheSettings.JAKARTA_SHARED_CACHE_STORE_MODE
• Session.setCacheMode(CacheMode)

getInitialSessionFlushMode

FlushMode getInitialSessionFlushMode()

The default initial FlushMode for new sessions.

See Also:

• HibernateHints.HINT_FLUSH_MODE
• SessionBuilder.flushMode(FlushMode)
• Session.setHibernateFlushMode(FlushMode)

getDefaultLockOptions

LockOptions getDefaultLockOptions()

The default lock scope and lock timeout.

See Also:

• AvailableSettings.JAKARTA_LOCK_TIMEOUT
• AvailableSettings.JAKARTA_LOCK_SCOPE

getDefaultSessionProperties

Map<String,Object> getDefaultSessionProperties()

Default properties for brand-new sessions.

See Also:

• Session.setProperty(String, Object)