Package org.hibernate.sql.ast.spi

Interface SqlAstCreationContext

All Superinterfaces:

BindingContext

All Known Subinterfaces:

SqlTranslationEngine

All Known Implementing Classes:

SqlTranslationEngineImpl

public interface SqlAstCreationContext
extends BindingContext

The "context" in which creation of SQL AST occurs. Provides access to stuff generally needed when creating SQL AST nodes

Because we would like to be able to render SQL during the startup cycle, before the SessionFactory is completely initialized, code involved in SQL AST creation and rendering should avoid making use of the SessionFactory. Instead, use the objects exposed by this creation context.

Method Summary

Modifier and Type	Method	Description
default Dialect	getDialect()	Obtain the Dialect.
FetchProfile	getFetchProfile(String name)	Obtain the definition of a named FetchProfile.
MappingMetamodelImplementor	getMappingMetamodel()	The runtime MappingMetamodelImplementor
Integer	getMaximumFetchDepth()	When creating Fetch references, defines a limit to how deep we should join for fetches.
SessionFactoryImplementor	getSessionFactory()	Deprecated.
default SqmFunctionRegistry	getSqmFunctionRegistry()	Obtain the SqmFunctionRegistry.
default WrapperOptions	getWrapperOptions()	Obtain the "incomplete" WrapperOptions that would be returned by SessionFactoryImplementor.getWrapperOptions().
boolean	isJpaQueryComplianceEnabled()

Methods inherited from interface org.hibernate.query.BindingContext

getJpaMetamodel, getTypeConfiguration

Method Details

getSessionFactory

@Deprecated
SessionFactoryImplementor getSessionFactory()

Deprecated.

Avoid calling this method directly, as much as possible. SQL AST creation should not depend on the existence of a session factory, so if you need to obtain this object, there's something wrong with the design.

Currently this is only called when creating a TableGroup, but we will introduce a new sort of creation context for that, probably.

getMappingMetamodel

MappingMetamodelImplementor getMappingMetamodel()

The runtime MappingMetamodelImplementor

Specified by:

getMappingMetamodel in interface BindingContext

getMaximumFetchDepth

Integer getMaximumFetchDepth()

When creating Fetch references, defines a limit to how deep we should join for fetches.

isJpaQueryComplianceEnabled

boolean isJpaQueryComplianceEnabled()

See Also:

• JpaCompliance.isJpaQueryComplianceEnabled()

getFetchProfile

FetchProfile getFetchProfile(String name)

Obtain the definition of a named FetchProfile.

Parameters:

name - The name of the fetch profile

getSqmFunctionRegistry

default SqmFunctionRegistry getSqmFunctionRegistry()

Obtain the SqmFunctionRegistry.

getDialect

default Dialect getDialect()

Obtain the Dialect.

getWrapperOptions

default WrapperOptions getWrapperOptions()

Obtain the "incomplete" WrapperOptions that would be returned by SessionFactoryImplementor.getWrapperOptions().