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.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	Package defining support for HQL, including JPQL as a subset of 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
org.hibernate.spatial.dialect.hana
org.hibernate.spatial.dialect.oracle
org.hibernate.testing.boot

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 that return types with arguments of type SqmFunctionDescriptor

Modifier and Type	Method	Description
Map<String,SqmFunctionDescriptor>	Configuration.getSqlFunctions()

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

Modifier and Type	Method	Description
Configuration	Configuration.addSqlFunction(String functionName, SqmFunctionDescriptor function)	Adds a SQL 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	DerbyLpadEmulation	A derby implementation for lpad.
class	DerbyRpadEmulation	A derby implementation for rpad.
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	OracleTruncFunction	Custom TruncFunction for Oracle which uses emulation when truncating datetimes to seconds
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	SqlFunction	A function to pass through a SQL fragment.
class	SqlServerConvertTruncFunction	Custom TruncFunction for SQL Server versions < 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, char).
class	TruncFunction	Custom function that manages both numeric and datetime truncation

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

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

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
SqmFunctionDescriptor	SqmFunctionRegistry.findFunctionDescriptor(String functionName)	Find a SqmFunctionTemplate 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

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, FunctionRenderingSupport renderingSupport, List<? extends SqmTypedNode<?>> arguments, SqmPredicate filter, ReturnableType<T> impliedResultType, ArgumentsValidator argumentsValidator, FunctionReturnTypeResolver returnTypeResolver, NodeBuilder nodeBuilder, String name)
SelfRenderingSqmFunction(SqmFunctionDescriptor descriptor, FunctionRenderingSupport renderingSupport, List<? extends SqmTypedNode<?>> arguments, ReturnableType<T> impliedResultType, ArgumentsValidator argumentsValidator, FunctionReturnTypeResolver returnTypeResolver, NodeBuilder nodeBuilder, String name)
SelfRenderingSqmOrderedSetAggregateFunction(SqmFunctionDescriptor descriptor, FunctionRenderingSupport renderingSupport, List<? extends SqmTypedNode<?>> arguments, SqmPredicate filter, SqmOrderByClause withinGroupClause, ReturnableType<T> impliedResultType, ArgumentsValidator argumentsValidator, FunctionReturnTypeResolver returnTypeResolver, NodeBuilder nodeBuilder, String name)
SelfRenderingSqmWindowFunction(SqmFunctionDescriptor descriptor, FunctionRenderingSupport renderingSupport, 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

Constructor	Description
SqmFunction(String functionName, SqmFunctionDescriptor functionDescriptor, SqmExpressible<T> type, List<? extends SqmTypedNode<?>> arguments, NodeBuilder criteriaBuilder)

Uses of SqmFunctionDescriptor in org.hibernate.spatial

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

Modifier and Type	Field	Description
protected 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()

Uses of SqmFunctionDescriptor in org.hibernate.testing.boot

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

Modifier and Type	Method	Description
Map<String,SqmFunctionDescriptor>	BootstrapContextImpl.getSqlFunctions()