Package org.hibernate.query.sqm.function

An SPI for defining, registering, and rendering functions in HQL. The SqmFunctionRegistry maintains a list of function descriptors. User-written code may contribute function descriptors by calling Configuration.addSqlFunction(java.lang.String, org.hibernate.query.sqm.function.SqmFunctionDescriptor) or by registering a FunctionContributor.

See Also:

SqmFunctionDescriptor, SqmFunctionRegistry, Configuration.addSqlFunction(java.lang.String, org.hibernate.query.sqm.function.SqmFunctionDescriptor), MetadataBuilder.applySqlFunction(java.lang.String, org.hibernate.query.sqm.function.SqmFunctionDescriptor), FunctionContributor, QueryEngine.getSqmFunctionRegistry()

Interface Summary

Interface	Description
FunctionRenderer	Support for SqmFunctionDescriptors that ultimately want to perform SQL rendering themselves.
FunctionRenderingSupport	Deprecated, for removal: This API element is subject to removal in a future version. Use FunctionRenderer instead
SqmFunctionDescriptor	A factory for SQM nodes representing invocations of a certain named function.

Class Summary

Class	Description
AbstractSqmFunctionDescriptor
AbstractSqmSelfRenderingFunctionDescriptor
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.
MultipatternSqmFunctionDescriptor	Support for overloaded functions defined in terms of a list of patterns, one for each possible function arity.
NamedSqmFunctionDescriptor	Provides a standard implementation that supports the majority of the HQL functions that are translated to SQL.
PatternBasedSqmFunctionDescriptor	Support for HQL functions that have different representations in different SQL dialects, where the difference can be handled via a pattern template.
SelfRenderingAggregateFunctionSqlAstExpression	Representation of an aggregate function call in the SQL AST for impls that know how to render themselves.
SelfRenderingFunctionSqlAstExpression	Representation of a function call in the SQL AST for impls that know how to render themselves.
SelfRenderingOrderedSetAggregateFunctionSqlAstExpression	Representation of an aggregate function call in the SQL AST for impls that know how to render themselves.
SelfRenderingSqmAggregateFunction<T>
SelfRenderingSqmFunction<T>
SelfRenderingSqmOrderedSetAggregateFunction<T>
SelfRenderingSqmWindowFunction<T>
SelfRenderingWindowFunctionSqlAstExpression	Representation of a window function call in the SQL AST for impls that know how to render themselves.
SqmFunctionRegistry	Defines a registry for SqmFunctionDescriptor instances.

Enum Summary

Enum	Description
FunctionKind	The kind of function e.g.