Class JsonQueryFunction

java.lang.Object

org.hibernate.query.sqm.function.AbstractSqmFunctionDescriptor

org.hibernate.query.sqm.function.AbstractSqmSelfRenderingFunctionDescriptor

org.hibernate.dialect.function.json.JsonQueryFunction

All Implemented Interfaces:

FunctionRenderer, SqmFunctionDescriptor

Direct Known Subclasses:

CockroachDBJsonQueryFunction, H2JsonQueryFunction, MariaDBJsonQueryFunction, MySQLJsonQueryFunction, PostgreSQLJsonQueryFunction, SpannerJsonQueryFunction, SQLServerJsonQueryFunction

@SPI({USE,IMPLEMENT})
public class JsonQueryFunction
extends AbstractSqmSelfRenderingFunctionDescriptor

Subclassable descriptor for the standard json_query function.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static final record	JsonQueryFunction.JsonQueryArguments

Field Summary

Fields

Modifier and Type	Field	Description
protected final boolean	supportsJsonPathExpression
protected final boolean	supportsJsonPathPassingClause

Constructor Summary

Constructors

Constructor	Description
JsonQueryFunction(TypeConfiguration typeConfiguration, boolean supportsJsonPathExpression, boolean supportsJsonPathPassingClause)

Method Summary

Modifier and Type	Method	Description
protected <T> SelfRenderingSqmFunction<T>	generateSqmFunctionExpression(List<? extends SqmTypedNode<?>> arguments, ReturnableType<T> impliedResultType, QueryEngine queryEngine)	Return an SQM node or subtree representing an invocation of this function with the given arguments.
void	render(SqlAppender sqlAppender, List<? extends SqlAstNode> sqlAstArguments, ReturnableType<?> returnType, SqlAstTranslator<?> walker)
protected void	render(SqlAppender sqlAppender, JsonQueryFunction.JsonQueryArguments arguments, ReturnableType<?> returnType, SqlAstTranslator<?> walker)

Methods inherited from class AbstractSqmSelfRenderingFunctionDescriptor

filterClauseSupported, generateSqmAggregateFunctionExpression, generateSqmOrderedSetAggregateFunctionExpression, generateSqmWindowFunctionExpression, getFunctionKind

Methods inherited from class AbstractSqmFunctionDescriptor

generateAggregateSqmExpression, generateOrderedSetAggregateSqmExpression, generateSqmExpression, generateWindowSqmExpression, getArgumentListSignature, getArgumentsValidator, getArgumentTypeResolver, getName, getReturnSignature, getReturnTypeResolver, getSignature

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface FunctionRenderer

render, render, render, render

Methods inherited from interface SqmFunctionDescriptor

alwaysIncludesParentheses, generateSqmExpression, generateSqmExpression, isPredicate

Field Details

supportsJsonPathExpression

protected final boolean supportsJsonPathExpression

supportsJsonPathPassingClause

protected final boolean supportsJsonPathPassingClause

Constructor Details

JsonQueryFunction

@SPI(IMPLEMENT)
public JsonQueryFunction(TypeConfiguration typeConfiguration,
 boolean supportsJsonPathExpression,
 boolean supportsJsonPathPassingClause)

Method Details

generateSqmFunctionExpression

protected <T> SelfRenderingSqmFunction<T> generateSqmFunctionExpression(List<? extends SqmTypedNode<?>> arguments,
 @Nullable
 ReturnableType<T> impliedResultType,
 QueryEngine queryEngine)

Description copied from class: AbstractSqmFunctionDescriptor

Return an SQM node or subtree representing an invocation of this function with the given arguments. This method may be overridden in the case of function descriptors that wish to customize creation of the node.

Overrides:

generateSqmFunctionExpression in class AbstractSqmSelfRenderingFunctionDescriptor

Parameters:

arguments - the arguments of the function invocation

impliedResultType - the function return type as inferred from its usage

render

public void render(SqlAppender sqlAppender,
 List<? extends SqlAstNode> sqlAstArguments,
 ReturnableType<?> returnType,
 SqlAstTranslator<?> walker)

Specified by:

render in interface FunctionRenderer

Overrides:

render in class AbstractSqmSelfRenderingFunctionDescriptor

render

protected void render(SqlAppender sqlAppender,
 JsonQueryFunction.JsonQueryArguments arguments,
 ReturnableType<?> returnType,
 SqlAstTranslator<?> walker)