Package org.hibernate.query.spi

Interface QueryEngineOptions

All Known Subinterfaces:

SessionFactoryOptions

All Known Implementing Classes:

AbstractDelegatingSessionFactoryOptions, SessionFactoryOptionsBuilder

public interface QueryEngineOptions

User configuration options related to the QueryEngine.

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	isJsonFunctionsEnabled()
boolean	isPortableIntegerDivisionEnabled()	Should HQL integer division HQL should produce an integer on Oracle, MySQL, and MariaDB, where the / operator produces a non-integer.
boolean	isXmlFunctionsEnabled()
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

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

getCustomSqmTranslatorFactory

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.tree
• QuerySettings.SEMANTIC_QUERY_TRANSLATOR

getCustomSqlFunctionMap

Map<String,SqmFunctionDescriptor> getCustomSqlFunctionMap()

User defined SQM functions available for use in HQL and Criteria.

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

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

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

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

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.

See Also:

• QuerySettings.QUERY_MULTI_TABLE_MUTATION_STRATEGY

resolveCustomSqmMultiTableInsertStrategy

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.

See Also:

• QuerySettings.QUERY_MULTI_TABLE_INSERT_STRATEGY

getJpaCompliance

JpaCompliance getJpaCompliance()

See Also:

• JpaComplianceSettings

getCriteriaValueHandlingMode

ValueHandlingMode getCriteriaValueHandlingMode()

See Also:

• QuerySettings.CRITERIA_VALUE_HANDLING_MODE

getImmutableEntityUpdateQueryHandlingMode

@Deprecated(since="7.0",
            forRemoval=true)
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

isJsonFunctionsEnabled

boolean isJsonFunctionsEnabled()

See Also:

• QuerySettings.JSON_FUNCTIONS_ENABLED

isXmlFunctionsEnabled

boolean isXmlFunctionsEnabled()

See Also:

• QuerySettings.XML_FUNCTIONS_ENABLED

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

String getSessionFactoryName()

getUuid

String getUuid()