Package org.hibernate.query.criteria

Interface JpaJsonTableFunction

All Superinterfaces:

JpaJsonTableColumnsNode

All Known Implementing Classes:

SqmJsonTableFunction

@Incubating
public interface JpaJsonTableFunction
extends JpaJsonTableColumnsNode

A special expression for the json_table function.

Since:

7.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	JpaJsonTableFunction.ErrorBehavior	The behavior of the json exists expression when a JSON processing error occurs.

Method Summary

Modifier and Type	Method	Description
JpaJsonTableFunction	errorOnError()	Sets the JpaJsonTableFunction.ErrorBehavior.ERROR for this json table expression.
JpaJsonTableFunction.ErrorBehavior	getErrorBehavior()	Get the JpaJsonTableFunction.ErrorBehavior of this json table expression.
JpaJsonTableFunction	nullOnError()	Sets the JpaJsonTableFunction.ErrorBehavior.NULL for this json table expression.
JpaJsonTableFunction	ordinalityColumn(String columnName)	Defines a long typed column on the result type with the given name which is set to the ordinality i.e.
JpaJsonTableFunction	passing(String parameterName, Expression<?> expression)	Passes the given Expression as value for the parameter with the given name in the JSON path.
JpaJsonTableFunction	unspecifiedOnError()	Sets the JpaJsonTableFunction.ErrorBehavior.UNSPECIFIED for this json table expression.

Methods inherited from interface org.hibernate.query.criteria.JpaJsonTableColumnsNode

existsColumn, existsColumn, nested, queryColumn, queryColumn, valueColumn, valueColumn, valueColumn, valueColumn

Method Details

passing

JpaJsonTableFunction passing(String parameterName,
 Expression<?> expression)

Passes the given Expression as value for the parameter with the given name in the JSON path.

Returns:

this for method chaining

getErrorBehavior

JpaJsonTableFunction.ErrorBehavior getErrorBehavior()

Get the JpaJsonTableFunction.ErrorBehavior of this json table expression.

Returns:

the error behavior

unspecifiedOnError

JpaJsonTableFunction unspecifiedOnError()

Sets the JpaJsonTableFunction.ErrorBehavior.UNSPECIFIED for this json table expression.

Returns:

this for method chaining

errorOnError

JpaJsonTableFunction errorOnError()

Sets the JpaJsonTableFunction.ErrorBehavior.ERROR for this json table expression.

Returns:

this for method chaining

nullOnError

JpaJsonTableFunction nullOnError()

Sets the JpaJsonTableFunction.ErrorBehavior.NULL for this json table expression.

Returns:

this for method chaining

ordinalityColumn

JpaJsonTableFunction ordinalityColumn(String columnName)

Description copied from interface: JpaJsonTableColumnsNode

Defines a long typed column on the result type with the given name which is set to the ordinality i.e. the 1-based position of the processed element. Ordinality starts again at 1 within nested paths.

Specified by:

ordinalityColumn in interface JpaJsonTableColumnsNode

Returns:

this for method chaining