Hibernate ORM - hibernate-core 6.4.4.Final · org.hibernate.boot.spi.SessionFactoryOptions

Method Summary

Modifier and Type	Method and Description
public default boolean	areJPACallbacksEnabled()
public default boolean	doesConnectionProviderDisableAutoCommit()
public BaselineSessionEventsListenerBuilder	getBaselineSessionEventsListenerBuilder()
public BatchFetchStyle	getBatchFetchStyle() Deprecated since 6.0. : No longer used internally
public Object	getBeanManagerReference()
public String	getCacheRegionPrefix()
public default ValueHandlingMode	getCriteriaValueHandlingMode() Implements org.hibernate.query.spi.QueryEngineOptions.getCriteriaValueHandlingMode.
public CurrentTenantIdentifierResolver<Object>	getCurrentTenantIdentifierResolver()
public CustomEntityDirtinessStrategy	getCustomEntityDirtinessStrategy()
public int	getDefaultBatchFetchSize()
public default String	Returns: The default catalog to use. 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).
public NullPrecedence	getDefaultNullPrecedence()
public default String	Returns: The default schema to use. 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).
public default JavaType<Object>	getDefaultTenantIdentifierJavaType() The default tenant identifier java type to use, in case no explicit tenant identifier property is defined.
public TimeZoneStorageStrategy	getDefaultTimeZoneStorageStrategy()
public EntityNameResolver[]	getEntityNameResolvers()
public EntityNotFoundDelegate	Returns: The specific EntityNotFoundDelegate to use, May be `null` getEntityNotFoundDelegate() Get the delegate for handling entity-not-found exception conditions.
public default ImmutableEntityUpdateQueryHandlingMode	getImmutableEntityUpdateQueryHandlingMode()
public Interceptor	Returns: The interceptor to use factory wide. May be `null` getInterceptor() Get the interceptor to use by default for all sessions opened from this factory.
public int	getJdbcBatchSize()
public Integer	getJdbcFetchSize()
public TimeZone	getJdbcTimeZone()
public JpaCompliance	getJpaCompliance() Redeclares org.hibernate.query.spi.QueryEngineOptions.getJpaCompliance.
public FormatMapper	getJsonFormatMapper() The format mapper to use for serializing/deserializing JSON data.
public Integer	getMaximumFetchDepth()
public default boolean	getNativeJdbcParametersIgnored()
public PhysicalConnectionHandlingMode	getPhysicalConnectionHandlingMode()
public int	getPreferredSqlTypeCodeForArray()
public int	getPreferredSqlTypeCodeForBoolean()
public int	getPreferredSqlTypeCodeForDuration()
public int	getPreferredSqlTypeCodeForInstant()
public int	getPreferredSqlTypeCodeForUuid()
public default int	getQueryStatisticsMaxSize()
public SchemaAutoTooling	getSchemaAutoTooling()
public StandardServiceRegistry	Returns: The service registry to use. getServiceRegistry() The service registry to use in building the factory.
public String	Returns: The SessionFactory name getSessionFactoryName() The name to be used for the SessionFactory.
public SessionFactoryObserver[]	getSessionFactoryObservers()
public Supplier<? extends Interceptor>	Returns: The interceptor to use factory wide. May be `null` getStatelessInterceptorImplementorSupplier() Get the interceptor to use by default for all sessions opened from this factory.
public StatementInspector	getStatementInspector()
public TempTableDdlTransactionHandling	getTempTableDdlTransactionHandling()
public TimestampsCacheFactory	getTimestampsCacheFactory()
public String	Returns: The UUID for this SessionFactory. getUuid() Get the UUID unique to this SessionFactoryOptions.
public Object	getValidatorFactoryReference()
public FormatMapper	getXmlFormatMapper() The format mapper to use for serializing/deserializing XML data.
public default boolean	inClauseParameterPaddingEnabled()
public boolean	isAllowOutOfTransactionUpdateOperations()
public default boolean	isAllowRefreshDetachedEntity()
public boolean	isAutoCloseSessionEnabled()
public boolean	isAutoEvictCollectionCache()
public boolean	isCheckNullability()
public default boolean	isCollectionsInDefaultFetchGroupEnabled()
public boolean	isCommentsEnabled()
public default boolean	isCriteriaCopyTreeEnabled()
public boolean	isDelayBatchFetchLoaderCreationsEnabled()
public boolean	isDirectReferenceCacheEntriesEnabled()
public boolean	isFailOnPaginationOverCollectionFetchEnabled()
public boolean	isFlushBeforeCompletionEnabled()
public boolean	isGetGeneratedKeysEnabled()
public boolean	isIdentifierRollbackEnabled()
public boolean	isInitializeLazyStateOutsideTransactionsEnabled()
public boolean	isJdbcBatchVersionedData()
public boolean	Returns: `true` indicates the SessionFactory was built through JPA bootstrapping; `false` indicates it was built through native bootstrapping. isJpaBootstrap() Was building of the SessionFactory initiated through JPA bootstrapping, or through Hibernate's native bootstrapping?
public boolean	isJtaTrackByThread()
public boolean	isJtaTransactionAccessEnabled()
public boolean	isMinimalPutsEnabled()
public boolean	isMultiTenancyEnabled()
public boolean	isNamedQueryStartupCheckingEnabled()
public boolean	isOrderInsertsEnabled()
public boolean	isOrderUpdatesEnabled()
public boolean	isPreferUserTransaction()
public boolean	isQueryCacheEnabled()
public boolean	isReleaseResourcesOnCloseEnabled()
public boolean	isScrollableResultSetsEnabled()
public boolean	isSecondLevelCacheEnabled()
public boolean	Returns: `true` if the SessionFactory name is also a JNDI name; `false` otherwise. isSessionFactoryNameAlsoJndiName() Is the `SesssionFactory name` also a JNDI name, indicating we should bind it into JNDI?
public boolean	isStatisticsEnabled()
public boolean	isStructuredCacheEntriesEnabled()
public boolean	isSubselectFetchEnabled()
public boolean	Returns: `true` indicates we should try to use `java.sql.CallableStatement` named parameters, if the Dialect says it is supported; `false` indicates that we should never try to use `java.sql.CallableStatement` named parameters, regardless of what the Dialect says. isUseOfJdbcNamedParametersEnabled() Controls whether Hibernate should try to map named parameter names specified in a `org.hibernate.procedure.ProcedureCall` or `jakarta.persistence.StoredProcedureQuery` to named parameters in the JDBC `java.sql.CallableStatement`.
public void	setCheckNullability(boolean enabled)

Inherited from org.hibernate.query.spi.QueryEngineOptions:: getCustomHqlTranslator getCustomSqlFunctionMap getCustomSqmFunctionRegistry getCustomSqmMultiTableInsertStrategy getCustomSqmMultiTableMutationStrategy getCustomSqmTranslatorFactory

Method Detail

areJPACallbacksEnabled	back to summary
public default boolean areJPACallbacksEnabled()

doesConnectionProviderDisableAutoCommit	back to summary
public default boolean doesConnectionProviderDisableAutoCommit()

getBaselineSessionEventsListenerBuilder	back to summary
public BaselineSessionEventsListenerBuilder getBaselineSessionEventsListenerBuilder()

getBatchFetchStyle	back to summary
public BatchFetchStyle getBatchFetchStyle() Deprecated since 6.0. : No longer used internally Annotations @Deprecated since:6.0

getBeanManagerReference	back to summary
public Object getBeanManagerReference()

getCacheRegionPrefix	back to summary
public String getCacheRegionPrefix()

getCriteriaValueHandlingMode back to summary

getCriteriaValueHandlingMode	back to summary
public default ValueHandlingMode getCriteriaValueHandlingMode() Implements org.hibernate.query.spi.QueryEngineOptions.getCriteriaValueHandlingMode. See Also `org.hibernate.cfg.AvailableSettings#CRITERIA_VALUE_HANDLING_MODE`

public default ValueHandlingMode getCriteriaValueHandlingMode()

Implements org.hibernate.query.spi.QueryEngineOptions.getCriteriaValueHandlingMode.

See Also: org.hibernate.cfg.AvailableSettings#CRITERIA_VALUE_HANDLING_MODE

getCurrentTenantIdentifierResolver	back to summary
public CurrentTenantIdentifierResolver<Object> getCurrentTenantIdentifierResolver()

getCustomEntityDirtinessStrategy	back to summary
public CustomEntityDirtinessStrategy getCustomEntityDirtinessStrategy()

getDefaultBatchFetchSize	back to summary
public int getDefaultBatchFetchSize()

getDefaultCatalog	back to summary
public 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:String The default catalog to use.

getDefaultCatalog

back to summary

public 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:String: The default catalog to use.

getDefaultNullPrecedence	back to summary
public NullPrecedence getDefaultNullPrecedence()

getDefaultSchema	back to summary
public 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:String The default schema to use.

getDefaultSchema

back to summary

public 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:String: The default schema to use.

getDefaultTenantIdentifierJavaType	back to summary
public default JavaType<Object> getDefaultTenantIdentifierJavaType() The default tenant identifier java type to use, in case no explicit tenant identifier property is defined. Annotations @Incubating Since 6.4

getDefaultTenantIdentifierJavaType

back to summary

public default JavaType<Object> getDefaultTenantIdentifierJavaType()

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

Annotations

@Incubating

Since

6.4

getDefaultTimeZoneStorageStrategy	back to summary
public TimeZoneStorageStrategy getDefaultTimeZoneStorageStrategy() Annotations @Incubating

getEntityNameResolvers	back to summary
public EntityNameResolver[] getEntityNameResolvers()

getEntityNotFoundDelegate back to summary

getEntityNotFoundDelegate	back to summary
public EntityNotFoundDelegate getEntityNotFoundDelegate() Get the delegate for handling entity-not-found exception conditions. Returns:EntityNotFoundDelegate The specific EntityNotFoundDelegate to use, May be `null`

public EntityNotFoundDelegate getEntityNotFoundDelegate()

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

Returns:EntityNotFoundDelegate: The specific EntityNotFoundDelegate to use, May be null

getImmutableEntityUpdateQueryHandlingMode	back to summary
public default ImmutableEntityUpdateQueryHandlingMode getImmutableEntityUpdateQueryHandlingMode()

getInterceptor back to summary

getInterceptor	back to summary
public Interceptor getInterceptor() Get the interceptor to use by default for all sessions opened from this factory. Returns:Interceptor The interceptor to use factory wide. May be `null`

public Interceptor getInterceptor()

Get the interceptor to use by default for all sessions opened from this factory.

Returns:Interceptor: The interceptor to use factory wide. May be null

getJdbcBatchSize	back to summary
public int getJdbcBatchSize()

getJdbcFetchSize	back to summary
public Integer getJdbcFetchSize()

getJdbcTimeZone	back to summary
public TimeZone getJdbcTimeZone()

getJpaCompliance	back to summary
public JpaCompliance getJpaCompliance() Redeclares org.hibernate.query.spi.QueryEngineOptions.getJpaCompliance.

getJsonFormatMapper	back to summary
public FormatMapper getJsonFormatMapper() The format mapper to use for serializing/deserializing JSON data. Annotations @Incubating Since 6.0

getJsonFormatMapper

back to summary

public FormatMapper getJsonFormatMapper()

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

Annotations

@Incubating

Since

6.0

getMaximumFetchDepth	back to summary
public Integer getMaximumFetchDepth()

getNativeJdbcParametersIgnored	back to summary
public default boolean getNativeJdbcParametersIgnored() See Also `org.hibernate.cfg.AvailableSettings#NATIVE_IGNORE_JDBC_PARAMETERS`

getPhysicalConnectionHandlingMode	back to summary
public PhysicalConnectionHandlingMode getPhysicalConnectionHandlingMode()

getPreferredSqlTypeCodeForArray	back to summary
public int getPreferredSqlTypeCodeForArray() Annotations @Incubating

getPreferredSqlTypeCodeForBoolean	back to summary
public int getPreferredSqlTypeCodeForBoolean() Annotations @Incubating

getPreferredSqlTypeCodeForDuration	back to summary
public int getPreferredSqlTypeCodeForDuration() Annotations @Incubating

getPreferredSqlTypeCodeForInstant	back to summary
public int getPreferredSqlTypeCodeForInstant() Annotations @Incubating

getPreferredSqlTypeCodeForUuid	back to summary
public int getPreferredSqlTypeCodeForUuid() Annotations @Incubating

getQueryStatisticsMaxSize	back to summary
public default int getQueryStatisticsMaxSize()

getSchemaAutoTooling	back to summary
public SchemaAutoTooling getSchemaAutoTooling()

getServiceRegistry	back to summary
public StandardServiceRegistry getServiceRegistry() The service registry to use in building the factory. Returns:StandardServiceRegistry The service registry to use.

getServiceRegistry

back to summary

public StandardServiceRegistry getServiceRegistry()

The service registry to use in building the factory.

Returns:StandardServiceRegistry: The service registry to use.

getSessionFactoryName back to summary

getSessionFactoryName	back to summary
public String getSessionFactoryName() The name to be used for the SessionFactory. This is used both in: in-VM serialization JNDI binding, depending on `isSessionFactoryNameAlsoJndiName` Returns:String The SessionFactory name

public String getSessionFactoryName()

The name to be used for the SessionFactory. This is used both in:

in-VM serialization
JNDI binding, depending on isSessionFactoryNameAlsoJndiName

Returns:String: The SessionFactory name

getSessionFactoryObservers	back to summary
public SessionFactoryObserver[] getSessionFactoryObservers()

getStatelessInterceptorImplementorSupplier back to summary

getStatelessInterceptorImplementorSupplier	back to summary
public Supplier<? extends Interceptor> getStatelessInterceptorImplementorSupplier() Get the interceptor to use by default for all sessions opened from this factory. Returns:Supplier<? extends Interceptor> The interceptor to use factory wide. May be `null`

public Supplier<? extends Interceptor> getStatelessInterceptorImplementorSupplier()

Get the interceptor to use by default for all sessions opened from this factory.

Returns:Supplier<? extends Interceptor>: The interceptor to use factory wide. May be null

getStatementInspector	back to summary
public StatementInspector getStatementInspector()

getTempTableDdlTransactionHandling	back to summary
public TempTableDdlTransactionHandling getTempTableDdlTransactionHandling()

getTimestampsCacheFactory	back to summary
public TimestampsCacheFactory getTimestampsCacheFactory()

getUuid back to summary

getUuid	back to summary
public String getUuid() Get the UUID unique to this SessionFactoryOptions. Will be the same value available as `SessionFactoryImplementor#getUuid()`. API Note The value is generated as a `java.util.UUID`, but kept as a String. Returns:String The UUID for this SessionFactory. See Also `org.hibernate.internal.SessionFactoryRegistry#getSessionFactory`, `SessionFactoryImplementor#getUuid`

public String getUuid()

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

API Note

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

Returns:String: The UUID for this SessionFactory.
See Also: org.hibernate.internal.SessionFactoryRegistry#getSessionFactory, SessionFactoryImplementor#getUuid

getValidatorFactoryReference	back to summary
public Object getValidatorFactoryReference()

getXmlFormatMapper	back to summary
public FormatMapper getXmlFormatMapper() The format mapper to use for serializing/deserializing XML data. Annotations @Incubating Since 6.0.1

getXmlFormatMapper

back to summary

public FormatMapper getXmlFormatMapper()

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

Annotations

@Incubating

Since

6.0.1

inClauseParameterPaddingEnabled	back to summary
public default boolean inClauseParameterPaddingEnabled()

isAllowOutOfTransactionUpdateOperations	back to summary
public boolean isAllowOutOfTransactionUpdateOperations()

isAllowRefreshDetachedEntity	back to summary
public default boolean isAllowRefreshDetachedEntity()

isAutoCloseSessionEnabled	back to summary
public boolean isAutoCloseSessionEnabled()

isAutoEvictCollectionCache	back to summary
public boolean isAutoEvictCollectionCache()

isCheckNullability	back to summary
public boolean isCheckNullability()

isCollectionsInDefaultFetchGroupEnabled	back to summary
public default boolean isCollectionsInDefaultFetchGroupEnabled()

isCommentsEnabled	back to summary
public boolean isCommentsEnabled()

isCriteriaCopyTreeEnabled	back to summary
public default boolean isCriteriaCopyTreeEnabled() See Also `org.hibernate.cfg.AvailableSettings#CRITERIA_COPY_TREE`

isDelayBatchFetchLoaderCreationsEnabled	back to summary
public boolean isDelayBatchFetchLoaderCreationsEnabled()

isDirectReferenceCacheEntriesEnabled	back to summary
public boolean isDirectReferenceCacheEntriesEnabled()

isFailOnPaginationOverCollectionFetchEnabled	back to summary
public boolean isFailOnPaginationOverCollectionFetchEnabled()

isFlushBeforeCompletionEnabled	back to summary
public boolean isFlushBeforeCompletionEnabled()

isGetGeneratedKeysEnabled	back to summary
public boolean isGetGeneratedKeysEnabled()

isIdentifierRollbackEnabled	back to summary
public boolean isIdentifierRollbackEnabled()

isInitializeLazyStateOutsideTransactionsEnabled	back to summary
public boolean isInitializeLazyStateOutsideTransactionsEnabled()

isJdbcBatchVersionedData	back to summary
public boolean isJdbcBatchVersionedData()

isJpaBootstrap back to summary

public boolean isJpaBootstrap()

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

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

isJtaTrackByThread	back to summary
public boolean isJtaTrackByThread()

isJtaTransactionAccessEnabled	back to summary
public boolean isJtaTransactionAccessEnabled()

isMinimalPutsEnabled	back to summary
public boolean isMinimalPutsEnabled()

isMultiTenancyEnabled	back to summary
public boolean isMultiTenancyEnabled()

isNamedQueryStartupCheckingEnabled	back to summary
public boolean isNamedQueryStartupCheckingEnabled()

isOrderInsertsEnabled	back to summary
public boolean isOrderInsertsEnabled()

isOrderUpdatesEnabled	back to summary
public boolean isOrderUpdatesEnabled()

isPreferUserTransaction	back to summary
public boolean isPreferUserTransaction()

isQueryCacheEnabled	back to summary
public boolean isQueryCacheEnabled()

isReleaseResourcesOnCloseEnabled	back to summary
public boolean isReleaseResourcesOnCloseEnabled()

isScrollableResultSetsEnabled	back to summary
public boolean isScrollableResultSetsEnabled()

isSecondLevelCacheEnabled	back to summary
public boolean isSecondLevelCacheEnabled()

isSessionFactoryNameAlsoJndiName back to summary

public boolean isSessionFactoryNameAlsoJndiName()

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

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

isStatisticsEnabled	back to summary
public boolean isStatisticsEnabled()

isStructuredCacheEntriesEnabled	back to summary
public boolean isStructuredCacheEntriesEnabled()

isSubselectFetchEnabled	back to summary
public boolean isSubselectFetchEnabled()

isUseOfJdbcNamedParametersEnabled back to summary

public boolean isUseOfJdbcNamedParametersEnabled()

Controls whether Hibernate should try to map named parameter names specified in a org.hibernate.procedure.ProcedureCall or jakarta.persistence.StoredProcedureQuery to named parameters in the JDBC java.sql.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:boolean: true indicates we should try to use java.sql.CallableStatement named parameters, if the Dialect says it is supported; false indicates that we should never try to use java.sql.CallableStatement named parameters, regardless of what the Dialect says.
See Also: org.hibernate.cfg.AvailableSettings#CALLABLE_NAMED_PARAMS_ENABLED

setCheckNullability	back to summary
public void setCheckNullability(boolean enabled)

public Interface SessionFactoryOptions

Method Summary

Method Detail