Hibernate ORM - hibernate-core 6.4.4.Final · org.hibernate.query.sqm.function

Package defining support for HQL, including JPQL as a subset of HQL.

Concerns handled by subpackages include:

query language transformation via ANTLR, and
query execution via an instance of org.hibernate.query.Query.

Translation of HQL to SQL involves the following steps:

First, the ANTLR-generated tokenizer and parser work in series to parse the text of the query and produce an AST.
Next, org.hibernate.query.hql.internal.SemanticQueryBuilder translates the AST into an instance of the SQM (Semantic Query Model) defined in org.hibernate.query.sqm.
Next, org.hibernate.query.sqm.sql.internal.StandardSqmTranslator transforms the SQM tree and produces a SQL AST, an instance of the syntax tree defined by org.hibernate.sql.ast.tree.
Finally, a SQL dialect-specific implementation of org.hibernate.sql.ast.SqlAstTranslator produces an executable SQL statement.

Interface Summary

Modifier and Type	Interface and Description
public interface	FunctionRenderer Deprecated as a consequence of `FunctionRenderingSupport` being deprecated. Support for `SqmFunctionDescriptor`s that ultimately want to perform SQL rendering themselves.
public interface	FunctionRenderingSupport Deprecated for removal. Use `FunctionRenderer` instead Support for `SqmFunctionDescriptor`s that ultimately want to perform SQL rendering themselves.
public interface	SqmFunctionDescriptor A factory for SQM nodes representing invocations of a certain named function.

Class Summary

Modifier and Type	Class and Description
public abstract class	AbstractSqmFunctionDescriptor
public abstract class	AbstractSqmSelfRenderingFunctionDescriptor Deprecated as a consequence of `FunctionRenderer` being deprecated.
public class	JdbcEscapeFunctionDescriptor Acts as a wrapper to another `SqmFunctionDescriptor`, rendering the standard JDBC escape sequence `{fn f(x, y)}` around the invocation syntax generated by its delegate.
public class	MultipatternSqmFunctionDescriptor Support for overloaded functions defined in terms of a list of patterns, one for each possible function arity.
public class	NamedSqmFunctionDescriptor Deprecated as a consequence of `AbstractSqmSelfRenderingFunctionDescriptor` being deprecated. Provides a standard implementation that supports the majority of the HQL functions that are translated to SQL.
public class	PatternBasedSqmFunctionDescriptor Deprecated as a consequence of `AbstractSqmSelfRenderingFunctionDescriptor` being deprecated. Support for HQL functions that have different representations in different SQL dialects, where the difference can be handled via a pattern template.
public class	SelfRenderingAggregateFunctionSqlAstExpression Representation of an aggregate function call in the SQL AST for impls that know how to render themselves.
public class	SelfRenderingFunctionSqlAstExpression Representation of a function call in the SQL AST for impls that know how to render themselves.
public class	SelfRenderingOrderedSetAggregateFunctionSqlAstExpression Representation of an aggregate function call in the SQL AST for impls that know how to render themselves.
public class	SelfRenderingSqmAggregateFunction<T>
public class	SelfRenderingSqmFunction<T>
public class	SelfRenderingSqmOrderedSetAggregateFunction<T>
public class	SelfRenderingSqmWindowFunction<T>
public class	SelfRenderingWindowFunctionSqlAstExpression Representation of a window function call in the SQL AST for impls that know how to render themselves.
public class	SqmFunctionRegistry Defines a registry for `SqmFunctionDescriptor` instances.

Package org.hibernate.query.sqm.function

Interface Summary

Class Summary

Enum Summary