Interface JpaJsonTableFunction

All Superinterfaces:

JpaJsonTableColumnsNode

All Known Implementing Classes:

SqmJsonTableFunction

@Incubating(since="6.3")
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)	Add an ordinality column with the given name.
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 JpaJsonTableColumnsNode

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

Method Details

passing

@Nonnull
JpaJsonTableFunction passing(@Nonnull
 String parameterName,
 @Nonnull
 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

@Nonnull
JpaJsonTableFunction.ErrorBehavior getErrorBehavior()

Get the JpaJsonTableFunction.ErrorBehavior of this json table expression.

Returns:

the error behavior

unspecifiedOnError

@Nonnull
JpaJsonTableFunction unspecifiedOnError()

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

Returns:

this for method chaining

errorOnError

@Nonnull
JpaJsonTableFunction errorOnError()

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

Returns:

this for method chaining

nullOnError

@Nonnull
JpaJsonTableFunction nullOnError()

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

Returns:

this for method chaining

ordinalityColumn

@Nonnull
JpaJsonTableFunction ordinalityColumn(@Nonnull
 String columnName)

Add an ordinality column with the given name.

Specified by:

ordinalityColumn in interface JpaJsonTableColumnsNode

Returns:

this for method chaining