Uses of Interface
org.hibernate.query.sqm.function.SqmFunctionDescriptor

Packages that use SqmFunctionDescriptor

Package	Description
org.hibernate.boot	This package contains the interfaces that make up the bootstrap API for Hibernate.
org.hibernate.boot.internal
org.hibernate.boot.spi	A range of SPIs allowing integration with—and customization of—the process of building metadata.
org.hibernate.cfg	This package defines APIs for configuring Hibernate.
org.hibernate.dialect.function	Contains implementations of SqmFunctionDescriptor describing a range of relatively-sophisticated SQL functions available in various dialects.
org.hibernate.dialect.function.array
org.hibernate.dialect.function.json
org.hibernate.dialect.function.xml
org.hibernate.envers.function
org.hibernate.query.spi	Contains a range of internal abstractions for dealing with query execution, query plans, query options, and query parameters.
org.hibernate.query.sqm.function	An SPI for defining, registering, and rendering functions in HQL.
org.hibernate.query.sqm.produce.function	Package defining support for SqmFunctionDescriptor handling.
org.hibernate.query.sqm.tree.expression	Nodes representing expressions in the SQM tree.
org.hibernate.spatial	This package defines the central Hibernate Spatial types and functions.
org.hibernate.spatial.dialect.hana
org.hibernate.spatial.dialect.oracle	This package contains the spatial extensions for the OracleDialect.

Uses of SqmFunctionDescriptor in org.hibernate.boot

Methods in org.hibernate.boot that return types with arguments of type SqmFunctionDescriptor

Modifier and Type	Method	Description
Map<String,SqmFunctionDescriptor>	Metadata.getSqlFunctionMap()

Methods in org.hibernate.boot with parameters of type SqmFunctionDescriptor

Modifier and Type	Method	Description
MetadataBuilder	MetadataBuilder.applySqlFunction(String functionName, SqmFunctionDescriptor function)	Contribute a SqmFunctionDescriptor to HQL.
SessionFactoryBuilder	SessionFactoryBuilder.applySqlFunction(String registrationName, SqmFunctionDescriptor functionDescriptor)	Register a SQL function with the underlying SqmFunctionRegistry.

Uses of SqmFunctionDescriptor in org.hibernate.boot.internal

Methods in org.hibernate.boot.internal that return types with arguments of type SqmFunctionDescriptor

Modifier and Type	Method	Description
Map<String,SqmFunctionDescriptor>	SessionFactoryOptionsBuilder.getCustomSqlFunctionMap()
Map<String,SqmFunctionDescriptor>	InFlightMetadataCollectorImpl.getSqlFunctionMap()
Map<String,SqmFunctionDescriptor>	MetadataImpl.getSqlFunctionMap()
Map<String,SqmFunctionDescriptor>	BootstrapContextImpl.getSqlFunctions()

Methods in org.hibernate.boot.internal with parameters of type SqmFunctionDescriptor

Modifier and Type	Method	Description
void	BootstrapContextImpl.addSqlFunction(String functionName, SqmFunctionDescriptor function)
MetadataBuilder	MetadataBuilderImpl.applySqlFunction(String functionName, SqmFunctionDescriptor function)
SessionFactoryBuilder	SessionFactoryBuilderImpl.applySqlFunction(String registrationName, SqmFunctionDescriptor functionDescriptor)
void	SessionFactoryOptionsBuilder.applySqlFunction(String registrationName, SqmFunctionDescriptor sqlFunction)

Uses of SqmFunctionDescriptor in org.hibernate.boot.spi

Methods in org.hibernate.boot.spi that return types with arguments of type SqmFunctionDescriptor

Modifier and Type	Method	Description
Map<String,SqmFunctionDescriptor>	AbstractDelegatingSessionFactoryOptions.getCustomSqlFunctionMap()
Map<String,SqmFunctionDescriptor>	AbstractDelegatingMetadata.getSqlFunctionMap()
Map<String,SqmFunctionDescriptor>	BootstrapContext.getSqlFunctions()	Access to any SQL functions explicitly registered with the MetadataBuilder.

Methods in org.hibernate.boot.spi with parameters of type SqmFunctionDescriptor

Modifier and Type	Method	Description
MetadataBuilder	AbstractDelegatingMetadataBuilderImplementor.applySqlFunction(String functionName, SqmFunctionDescriptor function)
T	AbstractDelegatingSessionFactoryBuilder.applySqlFunction(String registrationName, SqmFunctionDescriptor sqlFunction)

Uses of SqmFunctionDescriptor in org.hibernate.cfg

Methods in org.hibernate.cfg with parameters of type SqmFunctionDescriptor

Modifier and Type	Method	Description
Configuration	Configuration.addSqlFunction(String functionName, SqmFunctionDescriptor function)	Adds a function descriptor to this configuration.

Uses of SqmFunctionDescriptor in org.hibernate.dialect.function

Classes in org.hibernate.dialect.function that implement SqmFunctionDescriptor

Modifier and Type	Class	Description
class	AvgFunction
class	CaseLeastGreatestEmulation	Some databases don't have a function like least() or greatest(), and on those platforms we emulate the function using case.
class	CastFunction	ANSI SQL-inspired cast() function, where the target types are enumerated by CastType, and portability is achieved by delegating to Dialect.castPattern(CastType, CastType).
class	CastingConcatFunction
class	CastStrEmulation	The HQL str() function is now considered a synonym for cast(x as String).
class	ChrLiteralEmulation	A chr implementation that translates integer literals to string literals.
class	CoalesceIfnullEmulation
class	ConcatPipeFunction	A concat function with a pattern for clob arguments.
class	CountFunction
class	CurrentFunction	A "function" with no parameters that returns the current date, time, or timestamp.
class	DateTruncEmulation	Emulation of trunc(datetime, temporal_unit) function that leverages formatting the datetime to string and back to truncate it
class	DB2FormatEmulation	DB2's varchar_format() can't handle quoted literal strings in the format pattern.
class	DB2PositionFunction	DB2's position() function always requires a code unit before version 11.
class	DB2SubstringFunction	DB2's substring() function requires a code unit and substr() can't optionally take it, so we render substr() by default.
class	DynamicDispatchFunction	A function that dynamically dispatches to other functions, depending on which function validates successfully first.
class	EveryAnyEmulation	Most databases don't have a function like every() or any().
class	ExtractFunction	ANSI SQL-inspired extract() function, where the date/time fields are enumerated by TemporalUnit, and portability is achieved by delegating to Dialect.extractPattern(TemporalUnit).
class	FormatFunction	A format function with support for composite temporal expressions.
class	HypotheticalSetFunction
class	HypotheticalSetWindowEmulation
class	InsertSubstringOverlayEmulation	Emulates the ANSI SQL-standard overlay() function using insert() substring(), and concat().
class	IntegralTimestampaddFunction	Used in place of TimestampaddFunction for databases which don't support fractional seconds in the timestampadd() function.
class	InverseDistributionFunction
class	InverseDistributionWindowEmulation
class	LengthFunction	A length function with separate patterns for string and clob argument.
class	ListaggFunction
class	ListaggGroupConcatEmulation
class	ListaggStringAggEmulation
class	LocatePositionEmulation	Emulates the ANSI SQL-standard position() function using locate().
class	LpadRpadPadEmulation	HQL function inspired by the ANSI SQL trim function, with a funny syntax involving a TrimSpec.
class	MinMaxCaseEveryAnyEmulation	Most databases don't have a function like every() or any().
class	ModeStatsModeEmulation
class	NvlCoalesceEmulation	Oracle 8i had no coalesce() function, so we emulate it using chained nvl()s.
class	OracleExtractFunction
class	OracleTruncFunction	Custom TruncFunction for Oracle which uses emulation when truncating datetimes to seconds
class	OrdinalFunction	The HQL ordinal() function returns the ordinal value of an enum
class	PostgreSQLMinMaxFunction	PostgreSQL doesn't support min/max for uuid yet, but since that type is comparable we want to support this operation.
class	PostgreSQLTruncFunction	Custom TruncFunction for PostgreSQL which uses the dialect-specific function for numeric truncation
class	PostgreSQLTruncRoundFunction	PostgreSQL only supports the two-argument trunc and round functions with the following signatures: trunc(numeric, integer) round(numeric, integer)
class	QuantifiedLeastGreatestEmulation
class	SqlColumn
class	SqlFunction	A function to pass through a SQL fragment.
class	SqlServerConvertTruncFunction	Custom TruncFunction for SQL Server versions before 16, which uses the custom SqlServerConvertTruncFunction.DateTruncConvertEmulation
class	SQLServerEveryAnyEmulation	SQL Server doesn't have a function like every() or any().
class	SQLServerFormatEmulation	SQL Server behaves strangely when the first argument to format is of the type time, so we cast to datetime.
class	StandardSQLFunction	Simplified API allowing users to contribute SqmFunctionDescriptors to HQL.
class	SybaseTruncFunction	Custom TruncFunction for Sybase which uses a dialect-specific emulation function for datetimes
class	TimestampaddFunction	The timestampadd() or dateadd() function has a funny syntax which accepts a TemporalUnit as the first argument, and the actual set of accepted units varies widely.
class	TimestampdiffFunction	The timestampdiff() or datediff() function has a funny syntax which accepts a TemporalUnit as the first argument, and the actual set of accepted units varies widely.
class	TransactSQLStrFunction	A special function that renders a T-SQL str() function if more than a single argument is given, or otherwise renders a cast() expression just like CastStrEmulation.
class	TrimFunction	ANSI SQL-standard trim() function, which has a funny syntax involving a TrimSpec, and portability is achieved using Dialect.trimPattern(TrimSpec, boolean).
class	TruncFunction	Custom function that manages both numeric and datetime truncation

Constructors in org.hibernate.dialect.function with parameters of type SqmFunctionDescriptor

Modifier	Constructor	Description
	FormatSqmFunction(SqmFunctionDescriptor descriptor, FunctionRenderer renderer, List<? extends SqmTypedNode<?>> arguments, ReturnableType<T> impliedResultType, ArgumentsValidator argumentsValidator, FunctionReturnTypeResolver returnTypeResolver, boolean supportsPatternLiterals, QueryEngine queryEngine)

Uses of SqmFunctionDescriptor in org.hibernate.dialect.function.array

Classes in org.hibernate.dialect.function.array that implement SqmFunctionDescriptor

Modifier and Type	Class	Description
class	AbstractArrayContainsFunction	Encapsulates the validator, return type and argument type resolvers for the array_contains function.
class	AbstractArrayFillFunction	Encapsulates the validator, return type and argument type resolvers for the array_contains function.
class	AbstractArrayIncludesFunction	Encapsulates the validator, return type and argument type resolvers for the array_includes function.
class	AbstractArrayIntersectsFunction	Encapsulates the validator, return type and argument type resolvers for the array_intersects function.
class	AbstractArrayPositionFunction	Encapsulates the validator, return type and argument type resolvers for the array_position functions.
class	AbstractArrayPositionsFunction	Encapsulates the validator, return type and argument type resolvers for the array_positions functions.
class	AbstractArrayRemoveFunction	Encapsulates the validator, return type and argument type resolvers for the array_remove functions.
class	AbstractArrayTrimFunction	Encapsulates the validator, return type and argument type resolvers for the array_remove functions.
class	ArrayAggFunction
class	ArrayConcatElementFunction	Concatenation function for array and an element.
class	ArrayConcatFunction	Concatenation function for arrays.
class	ArrayConstructorFunction
class	ArrayContainsOperatorFunction	Special array contains function that also applies a cast to the element argument.
class	ArrayContainsUnnestFunction	Implement the array contains function by using unnest.
class	ArrayGetUnnestFunction	Implement the array get function by using unnest.
class	ArrayIncludesOperatorFunction	Special array includes implementation that uses the PostgreSQL @> operator.
class	ArrayIncludesUnnestFunction	Implement the array includes function by using unnest.
class	ArrayIntersectsOperatorFunction	Array intersects function that uses the PostgreSQL && operator.
class	ArrayIntersectsUnnestFunction	Implement the intersects function by using unnest.
class	ArrayRemoveIndexUnnestFunction	Implement the array remove index function by using unnest.
class	ArrayReplaceUnnestFunction	Implement the array replace function by using unnest.
class	ArraySetUnnestFunction	Implement the array set function by using unnest.
class	ArraySliceUnnestFunction	Implement the array slice function by using unnest.
class	ArrayToStringFunction
class	CockroachArrayFillFunction	Implement the array fill function by using generate_series.
class	H2ArrayContainsFunction	H2 requires a very special emulation, because unnest is pretty much useless, due to https://github.com/h2database/h2database/issues/1815.
class	H2ArrayFillFunction	Implement the array fill function by using system_range.
class	H2ArrayIncludesFunction	H2 requires a very special emulation, because unnest is pretty much useless, due to https://github.com/h2database/h2database/issues/1815.
class	H2ArrayIntersectsFunction	H2 requires a very special emulation, because unnest is pretty much useless, due to https://github.com/h2database/h2database/issues/1815.
class	H2ArrayPositionFunction	H2 requires a very special emulation, because unnest is pretty much useless, due to https://github.com/h2database/h2database/issues/1815.
class	H2ArrayPositionsFunction	H2 requires a very special emulation, because unnest is pretty much useless, due to https://github.com/h2database/h2database/issues/1815.
class	H2ArrayRemoveFunction	H2 requires a very special emulation, because unnest is pretty much useless, due to https://github.com/h2database/h2database/issues/1815.
class	H2ArrayRemoveIndexFunction	H2 requires a very special emulation, because unnest is pretty much useless, due to https://github.com/h2database/h2database/issues/1815.
class	H2ArrayReplaceFunction	H2 requires a very special emulation, because unnest is pretty much useless, due to https://github.com/h2database/h2database/issues/1815.
class	H2ArraySetFunction	H2 requires a very special emulation, because unnest is pretty much useless, due to https://github.com/h2database/h2database/issues/1815.
class	H2ArrayToStringFunction	H2 requires a very special emulation, because unnest is pretty much useless, due to https://github.com/h2database/h2database/issues/1815.
class	HSQLArrayConstructorFunction
class	HSQLArrayFillFunction	Implement the array fill function by using sequence_array.
class	HSQLArrayPositionFunction	HSQLDB has a special syntax.
class	HSQLArrayPositionsFunction	HSQLDB has a special syntax.
class	HSQLArrayRemoveFunction	HSQLDB array_remove function.
class	HSQLArraySetFunction	HSQLDB array_set function.
class	HSQLArrayToStringFunction	HSQLDB has a special syntax.
class	OracleArrayAggEmulation
class	OracleArrayConcatElementFunction	Oracle concatenation function for array and an element.
class	OracleArrayConcatFunction	Oracle concatenation function for arrays.
class	OracleArrayConstructorFunction
class	OracleArrayContainsFunction
class	OracleArrayFillFunction	Oracle array_fill function.
class	OracleArrayGetFunction	Oracle array_get function.
class	OracleArrayIncludesFunction
class	OracleArrayIntersectsFunction
class	OracleArrayLengthFunction
class	OracleArrayPositionFunction
class	OracleArrayPositionsFunction
class	OracleArrayRemoveFunction	Oracle array_remove function.
class	OracleArrayRemoveIndexFunction	Oracle array_remove_index function.
class	OracleArrayReplaceFunction	Oracle array_replace function.
class	OracleArraySetFunction	Oracle array_set function.
class	OracleArraySliceFunction	Oracle array_slice function.
class	OracleArrayToStringFunction	Oracle array_to_string function.
class	OracleArrayTrimFunction	Oracle array_trim function.
class	PostgreSQLArrayConcatElementFunction	PostgreSQL variant of the function to properly return null when the array argument is null.
class	PostgreSQLArrayConcatFunction	PostgreSQL variant of the function to properly return null when one of the arguments is null.
class	PostgreSQLArrayConstructorFunction	Special array constructor function that also applies a cast to the array literal, based on the inferred result type.
class	PostgreSQLArrayFillFunction	Custom casting for the array fill function.
class	PostgreSQLArrayPositionFunction	PostgreSQL variant of the function.
class	PostgreSQLArrayPositionsFunction	PostgreSQL variant of the function.
class	PostgreSQLArrayTrimEmulation	PostgreSQL array_trim emulation, since the function was only introduced in version 14.

Uses of SqmFunctionDescriptor in org.hibernate.dialect.function.json

Classes in org.hibernate.dialect.function.json that implement SqmFunctionDescriptor

Modifier and Type	Class	Description
class	AbstractJsonArrayAppendFunction	Standard json_array_append function.
class	AbstractJsonArrayInsertFunction	Standard json_array_insert function.
class	AbstractJsonInsertFunction	Standard json_insert function.
class	AbstractJsonMergepatchFunction	Standard json_mergepatch function.
class	AbstractJsonRemoveFunction	Standard json_remove function.
class	AbstractJsonReplaceFunction	Standard json_replace function.
class	AbstractJsonSetFunction	Standard json_set function.
class	CockroachDBJsonExistsFunction	CockroachDB json_exists function.
class	CockroachDBJsonQueryFunction	CockroachDB json_query function.
class	CockroachDBJsonRemoveFunction	CockroachDB json_remove function.
class	CockroachDBJsonValueFunction	CockroachDB json_value function.
class	DB2JsonArrayAggFunction	DB2 json_arrayagg function.
class	DB2JsonArrayFunction	DB2 json_array function.
class	DB2JsonObjectAggFunction	DB2 json_objectagg function.
class	DB2JsonObjectFunction	DB2 json_object function.
class	DB2JsonValueFunction	DB2 json_value function.
class	H2JsonArrayAggFunction	H2 json_arrayagg function.
class	H2JsonExistsFunction	H2 json_exists function.
class	H2JsonObjectAggFunction	Standard json_objectagg function that uses no returning clause.
class	H2JsonQueryFunction	H2 json_query function.
class	H2JsonValueFunction	H2 json_value function.
class	HANAJsonArrayAggFunction	SAP HANA json_arrayagg function.
class	HANAJsonArrayFunction	SAP HANA json_array function.
class	HANAJsonExistsFunction	SAP HANA json_exists function.
class	HANAJsonObjectAggFunction	SAP HANA json_objectagg function.
class	HANAJsonObjectFunction	SAP HANA json_object function.
class	HANAJsonValueFunction	HANA json_value function.
class	HSQLJsonArrayAggFunction	HSQLDB json_arrayagg function.
class	HSQLJsonArrayFunction	HSQLDB json_array function.
class	HSQLJsonObjectFunction	HSQLDB json_object function.
class	JsonArrayAggFunction	Standard json_arrayagg function.
class	JsonArrayFunction	Standard json_array function.
class	JsonExistsFunction	Standard json_exists function.
class	JsonObjectAggFunction	Standard json_objectagg function.
class	JsonObjectFunction	Standard json_object function.
class	JsonQueryFunction	Standard json_query function.
class	JsonValueFunction	Standard json_value function.
class	MariaDBJsonArrayAggFunction	MariaDB json_arrayagg function.
class	MariaDBJsonArrayAppendFunction	MariaDB json_array_append function.
class	MariaDBJsonArrayFunction	MariaDB json_array function.
class	MariaDBJsonObjectAggFunction	MariaDB json_objectagg function.
class	MariaDBJsonQueryFunction	MariaDB json_query function.
class	MariaDBJsonValueFunction	MariaDB json_value function.
class	MySQLJsonArrayAggFunction	MySQL json_arrayagg function.
class	MySQLJsonArrayFunction	MySQL json_array function.
class	MySQLJsonExistsFunction	MySQL json_exists function.
class	MySQLJsonObjectAggFunction	MySQL json_objectagg function.
class	MySQLJsonObjectFunction	MySQL json_object function.
class	MySQLJsonQueryFunction	MySQL json_query function.
class	MySQLJsonValueFunction	MySQL json_value function.
class	OracleJsonArrayAggFunction	Oracle json_arrayagg function.
class	OracleJsonArrayAppendFunction	Oracle json_array_append function.
class	OracleJsonArrayFunction	Oracle json_array function.
class	OracleJsonArrayInsertFunction	Oracle json_array_insert function.
class	OracleJsonInsertFunction	Oracle json_insert function.
class	OracleJsonMergepatchFunction	Oracle json_mergepatch function.
class	OracleJsonObjectAggFunction	Oracle json_objectagg function.
class	OracleJsonObjectFunction	Oracle json_object function.
class	OracleJsonRemoveFunction	Oracle json_remove function.
class	OracleJsonReplaceFunction	Oracle json_replace function.
class	OracleJsonSetFunction	Oracle json_set function.
class	OracleJsonValueFunction	Oracle json_value function.
class	PostgreSQLJsonArrayAggFunction	PostgreSQL json_arrayagg function.
class	PostgreSQLJsonArrayAppendFunction	PostgreSQL json_array_append function.
class	PostgreSQLJsonArrayFunction	PostgreSQL json_array function.
class	PostgreSQLJsonArrayInsertFunction	PostgreSQL json_array_insert function.
class	PostgreSQLJsonExistsFunction	PostgreSQL json_exists function.
class	PostgreSQLJsonInsertFunction	PostgreSQL json_insert function.
class	PostgreSQLJsonMergepatchFunction	PostgreSQL json_mergepatch function.
class	PostgreSQLJsonObjectAggFunction	PostgreSQL json_objectagg function.
class	PostgreSQLJsonObjectFunction	PostgreSQL json_object function.
class	PostgreSQLJsonQueryFunction	PostgreSQL json_query function.
class	PostgreSQLJsonRemoveFunction	PostgreSQL json_remove function.
class	PostgreSQLJsonReplaceFunction	PostgreSQL json_replace function.
class	PostgreSQLJsonSetFunction	PostgreSQL json_set function.
class	PostgreSQLJsonValueFunction	PostgreSQL json_value function.
class	SQLServerJsonArrayAggFunction	SQL Server json_arrayagg function.
class	SQLServerJsonArrayAppendFunction	SQL Server json_array_append function.
class	SQLServerJsonArrayFunction	SQL Server json_array function.
class	SQLServerJsonArrayInsertFunction	SQL Server json_array_insert function.
class	SQLServerJsonExistsFunction	SQL Server json_exists function.
class	SQLServerJsonInsertFunction	SQL Server json_insert function.
class	SQLServerJsonObjectAggFunction	SQL Server json_objectagg function.
class	SQLServerJsonObjectFunction	SQL Server json_object function.
class	SQLServerJsonQueryFunction	SQL Server json_query function.
class	SQLServerJsonRemoveFunction	SQL Server json_remove function.
class	SQLServerJsonReplaceFunction	SQL Server json_replace function.
class	SQLServerJsonSetFunction	SQL Server json_set function.
class	SQLServerJsonValueFunction	SQL Server json_value function.

Uses of SqmFunctionDescriptor in org.hibernate.dialect.function.xml

Classes in org.hibernate.dialect.function.xml that implement SqmFunctionDescriptor

Modifier and Type	Class	Description
class	H2XmlConcatFunction	H2 xmlconcat function.
class	H2XmlElementFunction	H2 xmlelement function.
class	H2XmlForestFunction	H2 xmlforest function.
class	H2XmlPiFunction	H2 xmlpi function.
class	LegacyDB2XmlExistsFunction	DB2 10.5 xmlexists function.
class	LegacyDB2XmlQueryFunction	DB2 10.5 xmlquery function.
class	PostgreSQLXmlQueryFunction	PostgreSQL xmlquery function.
class	SQLServerXmlAggFunction	SQL Server xmlagg function.
class	SQLServerXmlConcatFunction	SQL Server xmlconcat function.
class	SQLServerXmlElementFunction	SQL Server xmlelement function.
class	SQLServerXmlExistsFunction	SQL Server xmlexists function.
class	SQLServerXmlForestFunction	SQL Server xmlforest function.
class	SQLServerXmlPiFunction	SQL Server xmlpi function.
class	SQLServerXmlQueryFunction	SQL Server xmlquery function.
class	XmlAggFunction	Standard xmlagg function.
class	XmlConcatFunction	Standard xmlconcat function.
class	XmlElementFunction	Standard xmlelement function.
class	XmlExistsFunction	Standard xmlexists function.
class	XmlForestFunction	Standard xmlforest function.
class	XmlPiFunction	Standard xmlpi function.
class	XmlQueryFunction	Standard xmlquery function.

Uses of SqmFunctionDescriptor in org.hibernate.envers.function

Classes in org.hibernate.envers.function that implement SqmFunctionDescriptor

Modifier and Type	Class	Description
class	OrderByFragmentFunction	Envers specific FunctionContributor

Uses of SqmFunctionDescriptor in org.hibernate.query.spi

Methods in org.hibernate.query.spi that return types with arguments of type SqmFunctionDescriptor

Modifier and Type	Method	Description
Map<String,SqmFunctionDescriptor>	QueryEngineOptions.getCustomSqlFunctionMap()	User defined SQM functions available for use in HQL and Criteria.

Uses of SqmFunctionDescriptor in org.hibernate.query.sqm.function

Classes in org.hibernate.query.sqm.function that implement SqmFunctionDescriptor

Modifier and Type	Class	Description
class	AbstractSqmFunctionDescriptor
class	AbstractSqmSelfRenderingFunctionDescriptor
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.
class	MultipatternSqmFunctionDescriptor	Support for overloaded functions defined in terms of a list of patterns, one for each possible function arity.
class	NamedSqmFunctionDescriptor	Provides a standard implementation that supports the majority of the HQL functions that are translated to SQL.
class	PatternBasedSqmFunctionDescriptor	Support for HQL functions that have different representations in different SQL dialects, where the difference can be handled via a pattern template.

Methods in org.hibernate.query.sqm.function that return SqmFunctionDescriptor

Modifier and Type	Method	Description
@Nullable SqmFunctionDescriptor	SqmFunctionRegistry.findFunctionDescriptor(String functionName)	Find a SqmFunctionDescriptor by name.
SqmFunctionDescriptor	MultipatternSqmFunctionDescriptor.getFunction(int argumentCount)
SqmFunctionDescriptor	SqmFunctionRegistry.register(String registrationKey, SqmFunctionDescriptor function)	Register a function descriptor by name
SqmFunctionDescriptor	SqmFunctionRegistry.registerNamed(String name)	Register a named descriptor by name.
SqmFunctionDescriptor	SqmFunctionRegistry.registerNamed(String name, BasicType returnType)	Register a named descriptor by name and invariant return type.
SqmFunctionDescriptor	SqmFunctionRegistry.registerNoArgs(String name)	Specialized registration method for registering a named descriptor for functions expecting zero arguments.
SqmFunctionDescriptor	SqmFunctionRegistry.registerNoArgs(String registrationKey, String name)
SqmFunctionDescriptor	SqmFunctionRegistry.registerNoArgs(String registrationKey, String name, BasicType returnType)
SqmFunctionDescriptor	SqmFunctionRegistry.registerNoArgs(String name, BasicType returnType)
SqmFunctionDescriptor	SqmFunctionRegistry.registerPattern(String name, String pattern)	Register a pattern-based descriptor by name.
SqmFunctionDescriptor	SqmFunctionRegistry.registerPattern(String name, String pattern, BasicType returnType)	Register a pattern-based descriptor by name and invariant return type.
SqmFunctionDescriptor	SqmFunctionRegistry.wrapInJdbcEscape(String name, SqmFunctionDescriptor wrapped)

Methods in org.hibernate.query.sqm.function that return types with arguments of type SqmFunctionDescriptor

Modifier and Type	Method	Description
Stream<Map.Entry<String,SqmFunctionDescriptor>>	SqmFunctionRegistry.getFunctionsByName()	Useful for diagnostics - not efficient: do not use in production code.

Methods in org.hibernate.query.sqm.function with parameters of type SqmFunctionDescriptor

Modifier and Type	Method	Description
SqmFunctionDescriptor	SqmFunctionRegistry.register(String registrationKey, SqmFunctionDescriptor function)	Register a function descriptor by name
SqmFunctionDescriptor	SqmFunctionRegistry.wrapInJdbcEscape(String name, SqmFunctionDescriptor wrapped)

Constructors in org.hibernate.query.sqm.function with parameters of type SqmFunctionDescriptor

Modifier	Constructor	Description
	JdbcEscapeFunctionDescriptor(String name, SqmFunctionDescriptor wrapped)
	MultipatternSqmFunctionDescriptor(String name, SqmFunctionDescriptor[] functions, BasicType<?> type, TypeConfiguration typeConfiguration, FunctionParameterType... parameterTypes)	Construct an instance with the given function templates where the position of each function template in the given array corresponds to the arity of the function template.
	MultipatternSqmFunctionDescriptor(String name, SqmFunctionDescriptor[] functions, TypeConfiguration typeConfiguration, FunctionParameterType... parameterTypes)	Construct an instance with the given function templates where the position of each function template in the given array corresponds to the arity of the function template.
	SelfRenderingSqmAggregateFunction(SqmFunctionDescriptor descriptor, FunctionRenderer renderer, List<? extends SqmTypedNode<?>> arguments, SqmPredicate filter, ReturnableType<T> impliedResultType, ArgumentsValidator argumentsValidator, FunctionReturnTypeResolver returnTypeResolver, NodeBuilder nodeBuilder, String name)
	SelfRenderingSqmFunction(SqmFunctionDescriptor descriptor, FunctionRenderer renderer, List<? extends SqmTypedNode<?>> arguments, @Nullable ReturnableType<T> impliedResultType, @Nullable ArgumentsValidator argumentsValidator, FunctionReturnTypeResolver returnTypeResolver, NodeBuilder nodeBuilder, String name)
	SelfRenderingSqmOrderedSetAggregateFunction(SqmFunctionDescriptor descriptor, FunctionRenderer renderer, List<? extends SqmTypedNode<?>> arguments, SqmPredicate filter, SqmOrderByClause withinGroupClause, ReturnableType<T> impliedResultType, ArgumentsValidator argumentsValidator, FunctionReturnTypeResolver returnTypeResolver, NodeBuilder nodeBuilder, String name)
	SelfRenderingSqmWindowFunction(SqmFunctionDescriptor descriptor, FunctionRenderer renderer, List<? extends SqmTypedNode<?>> arguments, SqmPredicate filter, Boolean respectNulls, Boolean fromFirst, ReturnableType<T> impliedResultType, ArgumentsValidator argumentsValidator, FunctionReturnTypeResolver returnTypeResolver, NodeBuilder nodeBuilder, String name)

Uses of SqmFunctionDescriptor in org.hibernate.query.sqm.produce.function

Methods in org.hibernate.query.sqm.produce.function that return SqmFunctionDescriptor

Modifier and Type	Method	Description
SqmFunctionDescriptor	NamedFunctionDescriptorBuilder.descriptor()
SqmFunctionDescriptor	PatternFunctionDescriptorBuilder.descriptor()
SqmFunctionDescriptor	NamedFunctionDescriptorBuilder.register()
SqmFunctionDescriptor	PatternFunctionDescriptorBuilder.register()

Uses of SqmFunctionDescriptor in org.hibernate.query.sqm.tree.expression

Methods in org.hibernate.query.sqm.tree.expression that return SqmFunctionDescriptor

Modifier and Type	Method	Description
SqmFunctionDescriptor	SqmCoalesce.getFunctionDescriptor()
SqmFunctionDescriptor	SqmFunction.getFunctionDescriptor()

Constructors in org.hibernate.query.sqm.tree.expression with parameters of type SqmFunctionDescriptor

Modifier	Constructor	Description
	AbstractSqmJsonPathExpression(SqmFunctionDescriptor descriptor, FunctionRenderer renderer, List<? extends SqmTypedNode<?>> arguments, @Nullable ReturnableType<T> impliedResultType, @Nullable ArgumentsValidator argumentsValidator, FunctionReturnTypeResolver returnTypeResolver, NodeBuilder nodeBuilder, String name)
protected	AbstractSqmJsonPathExpression(SqmFunctionDescriptor descriptor, FunctionRenderer renderer, List<? extends SqmTypedNode<?>> arguments, @Nullable ReturnableType<T> impliedResultType, @Nullable ArgumentsValidator argumentsValidator, FunctionReturnTypeResolver returnTypeResolver, NodeBuilder nodeBuilder, String name, @Nullable Map<String,SqmExpression<?>> passingExpressions)
	SqmFunction(String functionName, SqmFunctionDescriptor functionDescriptor, @Nullable SqmBindableType<T> type, List<? extends SqmTypedNode<?>> arguments, NodeBuilder criteriaBuilder)
	SqmJsonExistsExpression(SqmFunctionDescriptor descriptor, FunctionRenderer renderer, List<? extends SqmTypedNode<?>> arguments, @Nullable ReturnableType<Boolean> impliedResultType, @Nullable ArgumentsValidator argumentsValidator, FunctionReturnTypeResolver returnTypeResolver, NodeBuilder nodeBuilder, String name)
	SqmJsonQueryExpression(SqmFunctionDescriptor descriptor, FunctionRenderer renderer, List<? extends SqmTypedNode<?>> arguments, @Nullable ReturnableType<String> impliedResultType, @Nullable ArgumentsValidator argumentsValidator, FunctionReturnTypeResolver returnTypeResolver, NodeBuilder nodeBuilder, String name)
	SqmJsonValueExpression(SqmFunctionDescriptor descriptor, FunctionRenderer renderer, List<? extends SqmTypedNode<?>> arguments, @Nullable ReturnableType<T> impliedResultType, @Nullable ArgumentsValidator argumentsValidator, FunctionReturnTypeResolver returnTypeResolver, NodeBuilder nodeBuilder, String name)
	SqmXmlElementExpression(SqmFunctionDescriptor descriptor, FunctionRenderer renderer, List<? extends SqmTypedNode<?>> arguments, @Nullable ReturnableType<String> impliedResultType, @Nullable ArgumentsValidator argumentsValidator, FunctionReturnTypeResolver returnTypeResolver, NodeBuilder nodeBuilder, String name)

Uses of SqmFunctionDescriptor in org.hibernate.spatial

Fields in org.hibernate.spatial with type parameters of type SqmFunctionDescriptor

Modifier and Type	Field	Description
protected final Map<FunctionKey,SqmFunctionDescriptor>	BaseSqmFunctionDescriptors.map

Methods in org.hibernate.spatial that return types with arguments of type SqmFunctionDescriptor

Modifier and Type	Method	Description
Map<FunctionKey,SqmFunctionDescriptor>	BaseSqmFunctionDescriptors.asMap()
Map<FunctionKey,SqmFunctionDescriptor>	KeyedSqmFunctionDescriptors.asMap()	Return the SqmFunctionDescriptors as map of FunctionKey to SqmFunctionDescriptor

Uses of SqmFunctionDescriptor in org.hibernate.spatial.dialect.hana

Classes in org.hibernate.spatial.dialect.hana that implement SqmFunctionDescriptor

Modifier and Type	Class	Description
class	HANASpatialAggregate
class	HANASpatialFunction

Uses of SqmFunctionDescriptor in org.hibernate.spatial.dialect.oracle

Classes in org.hibernate.spatial.dialect.oracle that implement SqmFunctionDescriptor

Modifier and Type	Class	Description
class	OracleSpatialFunction
class	OracleSpatialSQLMMFunction
class	SDOGetGeometryType
class	SDOMethodDescriptor
class	SDORelateFunction
class	STRelateFunction

Methods in org.hibernate.spatial.dialect.oracle that return types with arguments of type SqmFunctionDescriptor

Modifier and Type	Method	Description
Map<FunctionKey,SqmFunctionDescriptor>	OracleSDOFunctionDescriptors.asMap()
Map<FunctionKey,SqmFunctionDescriptor>	OracleSQLMMFunctionDescriptors.asMap()