Interface QueryEngineOptions

All Known Subinterfaces:

SessionFactoryOptions

All Known Implementing Classes:

AbstractDelegatingSessionFactoryOptions

public interface QueryEngineOptions

User configuration options related to the QueryEngine.

Custom translators, strategies, and the custom function registry are optional. A null value indicates that no custom implementation was supplied.

Method Summary

Modifier and Type	Method	Description
boolean	allowImmutableEntityUpdate()
ValueHandlingMode	getCriteriaValueHandlingMode()
HqlTranslator	getCustomHqlTranslator()	Translator for transforming HQL (as an Antlr parse tree) into an SQM tree.
Map<String, SqmFunctionDescriptor>	getCustomSqlFunctionMap()	User defined SQM functions available for use in HQL and Criteria.
SqmFunctionRegistry	getCustomSqmFunctionRegistry()	User supplied registry of SQM functions available for use in HQL and Criteria
SqmMultiTableInsertStrategy	getCustomSqmMultiTableInsertStrategy()	Contract for handling SQM trees representing insertion (INSERT) queries where the target of the mutation is a multi-table entity.
SqmMultiTableMutationStrategy	getCustomSqmMultiTableMutationStrategy()	Contract for handling SQM trees representing mutation (UPDATE or DELETE) queries where the target of the mutation is a multi-table entity.
SqmTranslatorFactory	getCustomSqmTranslatorFactory()	Factory for translators transforming an SQM tree into a different form.
ImmutableEntityUpdateQueryHandlingMode	getImmutableEntityUpdateQueryHandlingMode()	Deprecated, for removal: This API element is subject to removal in a future version. Since ImmutableEntityUpdateQueryHandlingMode is deprecated.
JpaCompliance	getJpaCompliance()
String	getSessionFactoryName()
String	getUuid()
boolean	isPortableIntegerDivisionEnabled()	Should HQL integer division HQL should produce an integer on Oracle, MySQL, and MariaDB, where the / operator produces a non-integer.
boolean	isSafeModeEnabled()
SqmMultiTableInsertStrategy	resolveCustomSqmMultiTableInsertStrategy(EntityMappingType rootEntityDescriptor, RuntimeModelCreationContext creationContext)	Contract for handling SQM trees representing insertion (INSERT) queries where the target of the mutation is a multi-table entity.
SqmMultiTableMutationStrategy	resolveCustomSqmMultiTableMutationStrategy(EntityMappingType rootEntityDescriptor, RuntimeModelCreationContext creationContext)	Contract for handling SQM trees representing mutation (UPDATE or DELETE) queries where the target of the mutation is a multi-table entity.

Method Details

getCustomHqlTranslator

@SPI(SUPPLY)
@Nullable
HqlTranslator getCustomHqlTranslator()

Translator for transforming HQL (as an Antlr parse tree) into an SQM tree.

See Also:

• org.hibernate.query.hql
• QuerySettings.SEMANTIC_QUERY_PRODUCER
• HqlTranslator

getCustomSqmTranslatorFactory

@SPI(SUPPLY)
@Nullable
SqmTranslatorFactory getCustomSqmTranslatorFactory()

Factory for translators transforming an SQM tree into a different form. For standard ORM implementations this will generally be some form of SQL tree.

See Also:

• org.hibernate.sql.ast.spi.query
• QuerySettings.SEMANTIC_QUERY_TRANSLATOR
• SqmTranslatorFactory

getCustomSqlFunctionMap

@Nonnull
Map<String, SqmFunctionDescriptor> getCustomSqlFunctionMap()

User defined SQM functions available for use in HQL and Criteria. Returns an empty map if no custom functions were supplied.

Ultimately made available to the SqmTranslatorFactory for use in translating an SQM tree.

Can be used in conjunction with getCustomSqmFunctionRegistry(), but generally one or the other will be used.

getCustomSqmFunctionRegistry

@Nullable
SqmFunctionRegistry getCustomSqmFunctionRegistry()

User supplied registry of SQM functions available for use in HQL and Criteria

Can be used in conjunction with getCustomSqlFunctionMap(), but generally one or the other will be used.

getCustomSqmMultiTableMutationStrategy

@Nullable
SqmMultiTableMutationStrategy getCustomSqmMultiTableMutationStrategy()

Contract for handling SQM trees representing mutation (UPDATE or DELETE) queries where the target of the mutation is a multi-table entity.

See Also:

• QuerySettings.QUERY_MULTI_TABLE_MUTATION_STRATEGY

getCustomSqmMultiTableInsertStrategy

@Nullable
SqmMultiTableInsertStrategy getCustomSqmMultiTableInsertStrategy()

Contract for handling SQM trees representing insertion (INSERT) queries where the target of the mutation is a multi-table entity.

See Also:

• QuerySettings.QUERY_MULTI_TABLE_INSERT_STRATEGY

resolveCustomSqmMultiTableMutationStrategy

@Nullable
SqmMultiTableMutationStrategy resolveCustomSqmMultiTableMutationStrategy(@Nonnull
 EntityMappingType rootEntityDescriptor,
 @Nonnull
 RuntimeModelCreationContext creationContext)

Contract for handling SQM trees representing mutation (UPDATE or DELETE) queries where the target of the mutation is a multi-table entity.

See Also:

• QuerySettings.QUERY_MULTI_TABLE_MUTATION_STRATEGY

resolveCustomSqmMultiTableInsertStrategy

@Nullable
SqmMultiTableInsertStrategy resolveCustomSqmMultiTableInsertStrategy(@Nonnull
 EntityMappingType rootEntityDescriptor,
 @Nonnull
 RuntimeModelCreationContext creationContext)

Contract for handling SQM trees representing insertion (INSERT) queries where the target of the mutation is a multi-table entity.

See Also:

• QuerySettings.QUERY_MULTI_TABLE_INSERT_STRATEGY

getJpaCompliance

@Nonnull
JpaCompliance getJpaCompliance()

See Also:

• JpaComplianceSettings

getCriteriaValueHandlingMode

@Nonnull
ValueHandlingMode getCriteriaValueHandlingMode()

See Also:

• QuerySettings.CRITERIA_VALUE_HANDLING_MODE

getImmutableEntityUpdateQueryHandlingMode

@Deprecated(since="7.0",
            forRemoval=true)
@Nonnull
ImmutableEntityUpdateQueryHandlingMode getImmutableEntityUpdateQueryHandlingMode()

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

Since ImmutableEntityUpdateQueryHandlingMode is deprecated. Use allowImmutableEntityUpdate() instead.

See Also:

• QuerySettings.IMMUTABLE_ENTITY_UPDATE_QUERY_HANDLING_MODE

allowImmutableEntityUpdate

boolean allowImmutableEntityUpdate()

See Also:

• QuerySettings.IMMUTABLE_ENTITY_UPDATE_QUERY_HANDLING_MODE

isPortableIntegerDivisionEnabled

boolean isPortableIntegerDivisionEnabled()

Should HQL integer division HQL should produce an integer on Oracle, MySQL, and MariaDB, where the / operator produces a non-integer.

See Also:

• QuerySettings.PORTABLE_INTEGER_DIVISION

getSessionFactoryName

@Nullable
String getSessionFactoryName()

getUuid

@Nonnull
String getUuid()

isSafeModeEnabled

boolean isSafeModeEnabled()