Interface SqmTranslationRequest<S extends SqmStatement<?>>

Type Parameters:

S - the SQM statement type

All Known Implementing Classes:

SqmTranslationRequest.Mutation, SqmTranslationRequest.Select

@SPI(USE)
public sealed interface SqmTranslationRequest<S extends SqmStatement<?>>
permits SqmTranslationRequest.Select, SqmTranslationRequest.Mutation

The complete supported input for creating one SQM-to-SQL-AST translator.

A SqmTranslatorFactory consumes the matching request subtype and returns a fresh translator for it. Factories and translators must not retain a request after that translation.

Since:

8.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final record	SqmTranslationRequest.Mutation	Request to translate an SQM mutation statement.
static final record	SqmTranslationRequest.Select	Request to translate an SQM select statement.

Method Summary

Modifier and Type	Method	Description
SqlAstCreationContext	creationContext()	Mapping-model and SessionFactory services used to create the SQL AST.
default boolean	deduplicateSelectionItems()	Whether duplicate select items may be removed during translation.
LoadQueryInfluencers	loadQueryInfluencers()	Load and fetch-plan influences effective for this translation.
QueryParameterBindings	parameterBindings()	The current domain query parameter bindings.
SqmParameterMapping	parameterMapping()	The parameter correlations belonging to the SQM statement.
QueryOptions	queryOptions()	Query options effective for this translation.
S	statement()	The SQM statement to translate.

Method Details

statement

S statement()

The SQM statement to translate.

queryOptions

QueryOptions queryOptions()

Query options effective for this translation.

parameterMapping

SqmParameterMapping parameterMapping()

The parameter correlations belonging to the SQM statement.

parameterBindings

QueryParameterBindings parameterBindings()

The current domain query parameter bindings.

loadQueryInfluencers

LoadQueryInfluencers loadQueryInfluencers()

Load and fetch-plan influences effective for this translation.

creationContext

SqlAstCreationContext creationContext()

Mapping-model and SessionFactory services used to create the SQL AST.

deduplicateSelectionItems

default boolean deduplicateSelectionItems()

Whether duplicate select items may be removed during translation.