com.github.t9t.jooq.json

Class JsonDSL

java.lang.Object

com.github.t9t.jooq.json.JsonDSL

public final class JsonDSL
extends Object

Functions for json PostgreSQL operator support in jOOQ

Reference: https://www.postgresql.org/docs/11/functions-json.html

Constructor Summary

Constructors

Constructor and Description
JsonDSL()

Method Summary

Modifier and Type	Method and Description
static org.jooq.Field<Json>	arrayElement(org.jooq.Field<Json> jsonField, int index) Get JSON array element (indexed from zero, negative integers count from the end), using the -> operator
static org.jooq.Field<String>	arrayElementText(org.jooq.Field<Json> jsonField, int index) Get JSON array element as text rather than json(b) (indexed from zero, negative integers count from the end), using the ->> operator
static org.jooq.Field<Json>	field(Json json) Create a jOOQ Field wrapping the Json object.
static org.jooq.Field<Json>	field(String json) Create a jOOQ Field wrapping a Json object representing a json value for the JSON string.
static org.jooq.Field<Json>	fieldByKey(org.jooq.Field<Json> jsonField, String key) Get JSON object field by key using the -> operator
static org.jooq.Field<String>	fieldByKeyText(org.jooq.Field<Json> jsonField, String key) Get JSON object field as text rather than json(b), using the ->> operator
static org.jooq.Field<Json>	objectAtPath(org.jooq.Field<Json> jsonField, Collection<String> path) Get JSON object at specified path using the #> operator
static org.jooq.Field<Json>	objectAtPath(org.jooq.Field<Json> jsonField, String... path) Get JSON object at specified path using the #> operator
static org.jooq.Field<String>	objectAtPathText(org.jooq.Field<Json> jsonField, Collection<String> path) Get JSON object at specified path as text rather than json(b), using the #>> operator
static org.jooq.Field<String>	objectAtPathText(org.jooq.Field<Json> jsonField, String... path) Get JSON object at specified path as text rather than json(b), using the #>> operator

Methods inherited from class java.lang.Object

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

Constructor Detail

JsonDSL

public JsonDSL()

Method Detail

field

public static org.jooq.Field<Json> field(String json)

Create a jOOQ Field wrapping a Json object representing a json value for the JSON string. Note that the JSON is not validated (any formatting errors will only occur when interacting with the database).

Parameters:

json - JSON string

Returns:

json Field for the JSON string

field

public static org.jooq.Field<Json> field(Json json)

Create a jOOQ Field wrapping the Json object.

Parameters:

json - Jsonb object to wrap

Returns:

json Field for the Jsonb object

arrayElement

public static org.jooq.Field<Json> arrayElement(org.jooq.Field<Json> jsonField,
                                                int index)

Get JSON array element (indexed from zero, negative integers count from the end), using the -> operator

Example: '[{"a":"foo"},{"b":"bar"},{"c":"baz"}]'::json->2

Example result: {"c":"baz"}

Parameters:

jsonField - A JSON Field containing an array to get the array element from

index - Array index; negative values count from the end

Returns:

A Field representing the extracted array element

arrayElementText

public static org.jooq.Field<String> arrayElementText(org.jooq.Field<Json> jsonField,
                                                      int index)

Get JSON array element as text rather than json(b) (indexed from zero, negative integers count from the end), using the ->> operator

Example: '[1,2,3]'::json->>2

Example result: 3

Parameters:

jsonField - A JSON Field containing an array to get the array element from

index - Array index; negative values count from the end

Returns:

A Field representing the extracted array element, as text

fieldByKey

public static org.jooq.Field<Json> fieldByKey(org.jooq.Field<Json> jsonField,
                                              String key)

Get JSON object field by key using the -> operator

Example: '{"a": {"b":"foo"}}'::json->'a'

Example result: {"b":"foo"}

Parameters:

jsonField - The JSON Field to extract the field from

key - JSON field key name

Returns:

A Field representing the extracted value

fieldByKeyText

public static org.jooq.Field<String> fieldByKeyText(org.jooq.Field<Json> jsonField,
                                                    String key)

Get JSON object field as text rather than json(b), using the ->> operator

Example: '{"a":1,"b":2}'::json->>'b'

Example result: 2

Parameters:

jsonField - The JSON Field to extract the field from

key - JSON field key name

Returns:

A Field representing the extracted array element, as text

objectAtPath

public static org.jooq.Field<Json> objectAtPath(org.jooq.Field<Json> jsonField,
                                                String... path)

Get JSON object at specified path using the #> operator

Example: '{"a": {"b":{"c": "foo"}}}'::json#>'{a,b}'

Example result: {"c": "foo"}

Parameters:

jsonField - The JSON Field to extract the path from

path - Path to the the object to return

Returns:

A Field representing the object at the specified path

See Also:

objectAtPath(Field, Collection)

objectAtPath

public static org.jooq.Field<Json> objectAtPath(org.jooq.Field<Json> jsonField,
                                                Collection<String> path)

Get JSON object at specified path using the #> operator

Example: '{"a": {"b":{"c": "foo"}}}'::json#>'{a,b}'

Example result: {"c": "foo"}

Parameters:

jsonField - The JSON Field to extract the path from

path - Path to the the object to return

Returns:

A Field representing the object at the specified path

See Also:

objectAtPath(Field, String...)

objectAtPathText

public static org.jooq.Field<String> objectAtPathText(org.jooq.Field<Json> jsonField,
                                                      String... path)

Get JSON object at specified path as text rather than json(b), using the #>> operator

Example: '{"a":[1,2,3],"b":[4,5,6]}'::json#>>'{a,2}'

Example result: 3

Parameters:

jsonField - The JSON Field to extract the path from

path - Path to the the object to return

Returns:

A Field representing the object at the specified path, as text

See Also:

objectAtPathText(Field, Collection)

objectAtPathText

public static org.jooq.Field<String> objectAtPathText(org.jooq.Field<Json> jsonField,
                                                      Collection<String> path)

Get JSON object at specified path as text rather than json(b), using the #>> operator

Example: '{"a":[1,2,3],"b":[4,5,6]}'::json#>>'{a,2}'

Example result: 3

Parameters:

jsonField - The JSON Field to extract the path from

path - Path to the the object to return

Returns:

A Field representing the object at the specified path, as text

See Also:

objectAtPath(Field, String...)