FunctionsJSON
JSON
80 JSON functions in the NYXDB native function registry, with signatures, briefs, and measured medians where available.
80 functions in the json family. Each name links to its page; … marks the variadic argument list (the engine declares no named parameters). A Measured value appears only where a benchmark corpus case joins by name (server-class hardware, median).
| Function | Type | Description | Measured |
|---|---|---|---|
as_json(…) → JSON | scalar | Convert a value to JSON. | — |
distinct_json_paths(…) → JSON | aggregate | Discover JSON paths. | — |
distinct_json_paths_and_types(…) → JSON | aggregate | Discover JSON paths with inferred types. | — |
from_json(…) → JSON | scalar | Parse JSON into a typed value. | — |
is_valid_json(…) → Bool | scalar | Validate JSON. | — |
json_agg(…) → JSON | aggregate | Aggregate values into a JSON array. | — |
json_agg_strict(…) → JSON | aggregate | Aggregate values into a JSON array (strict). | — |
json_all_paths(…) → JSON | scalar | Discover JSON paths. | — |
json_all_paths_with_types(…) → JSON | scalar | Discover JSON paths with inferred types. | — |
json_array_element(…) → JSON | scalar | Get JSON array element. | — |
json_array_element_text(…) → String | scalar | Get JSON array element as text. | — |
json_array_elements(…) → JSON | scalar | Expand JSON array elements. | — |
json_array_elements_text(…) → JSON | scalar | Expand JSON array elements as text. | — |
json_array_length(…) → UInt64 | scalar | Length of a JSON array. | — |
json_build_array(…) → JSON | scalar | Build a JSON array. | — |
json_build_object(…) → JSON | scalar | Build a JSON object. | — |
json_concat(…) → JSON | scalar | Concatenate JSON values. | — |
json_delete(…) → JSON | scalar | Delete a JSON key or array element. | — |
json_delete_path(…) → JSON | scalar | Delete a JSON path. | — |
json_dynamic_paths(…) → JSON | scalar | Discover dynamic JSON paths. | — |
json_dynamic_paths_with_types(…) → JSON | scalar | Discover dynamic JSON paths with inferred types. | — |
json_each(…) → JSON | scalar | Expand JSON object fields. | — |
json_each_text(…) → JSON | scalar | Expand JSON object fields as text. | — |
json_encode(…) → String | scalar | Encode as JSON text. | — |
json_exists(…) → Bool | scalar | Test JSON key/path existence. | — |
json_exists_all(…) → Bool | scalar | Test existence of all keys/paths. | — |
json_exists_any(…) → Bool | scalar | Test existence of any key/path. | — |
json_extract(…) → JSON | scalar | Extract a value from JSON. | — |
json_extract_array(…) → JSON | scalar | Extract JSON array. | — |
json_extract_array_raw(…) → JSON | scalar | Extract JSON array as raw JSON. | — |
json_extract_bool(…) → Bool | scalar | Extract a boolean from JSON by path. | — |
json_extract_float(…) → Float64 | scalar | Extract a floating-point number from JSON by path. | — |
json_extract_int(…) → Int64 | scalar | Extract a signed integer from JSON by path. | — |
json_extract_keys(…) → JSON | scalar | Extract keys from a JSON object. | — |
json_extract_keys_and_values(…) → JSON | scalar | Extract keys and typed values. | — |
json_extract_keys_and_values_raw(…) → JSON | scalar | Extract keys and raw JSON values. | — |
json_extract_path(…) → JSON | scalar | Extract JSON value by path. | — |
json_extract_path_text(…) → String | scalar | Extract JSON value by path as text. | — |
json_extract_raw(…) → JSON | scalar | Extract raw JSON fragment. | — |
json_extract_string(…) → String | scalar | Extract a string from JSON by path. | — |
json_extract_uint(…) → UInt64 | scalar | Extract an unsigned integer from JSON by path. | — |
json_has(…) → Bool | scalar | Test JSON contains key or value. | — |
json_hash(…) → UInt64 | scalar | Hash a JSON document. | — |
json_hash_extended(…) → String | scalar | Hash a JSON document (extended). | — |
json_insert(…) → JSON | scalar | Insert a value at a JSON path. | — |
json_key(…) → String | scalar | JSON key at a position. | — |
json_length(…) → UInt64 | scalar | Length of a JSON array or object. | — |
json_merge_patch(…) → JSON | scalar | JSON Merge Patch. | — |
json_object(…) → JSON | scalar | Build a JSON object. | — |
json_object_agg(…) → JSON | aggregate | Aggregate key/value pairs into a JSON object. | — |
json_object_agg_strict(…) → JSON | aggregate | Aggregate key/value pairs into a JSON object (strict). | — |
json_object_agg_unique(…) → JSON | aggregate | Aggregate key/value pairs into a JSON object (unique keys). | — |
json_object_agg_unique_strict(…) → JSON | aggregate | Aggregate key/value pairs into a JSON object (unique, strict). | — |
json_object_field(…) → JSON | scalar | Get JSON object field. | — |
json_object_field_text(…) → String | scalar | Get JSON object field. | — |
json_object_keys(…) → JSON | scalar | JSON object keys. | — |
json_path_exists(…) → Bool | scalar | Test SQL/JSON path existence. | — |
json_path_exists_tz(…) → Bool | scalar | Test SQL/JSON path existence (time-zone aware). | — |
json_path_match(…) → Bool | scalar | SQL/JSON path predicate. | — |
json_path_match_tz(…) → Bool | scalar | SQL/JSON path predicate (time-zone aware). | — |
json_path_query(…) → JSON | scalar | SQL/JSON path query. | — |
json_path_query_array(…) → JSON | scalar | SQL/JSON path query (array). | — |
json_path_query_array_tz(…) → JSON | scalar | SQL/JSON path query (array) (time-zone aware). | — |
json_path_query_first(…) → JSON | scalar | SQL/JSON path first match. | — |
json_path_query_first_tz(…) → JSON | scalar | SQL/JSON path first match (time-zone aware). | — |
json_path_query_tz(…) → JSON | scalar | SQL/JSON path query (time-zone aware). | — |
json_pretty(…) → String | scalar | Pretty-print JSON. | — |
json_query(…) → JSON | scalar | SQL/JSON query result. | — |
json_set(…) → JSON | scalar | Set a value at a JSON path. | — |
json_set_lax(…) → JSON | scalar | Set a value at a JSON path (lax). | — |
json_shared_data_paths(…) → JSON | scalar | Discover JSON paths. | — |
json_shared_data_paths_with_types(…) → JSON | scalar | Discover JSON paths with inferred types. | — |
json_strip_nulls(…) → JSON | scalar | Remove null-valued keys. | — |
json_type(…) → String | scalar | JSON type of a value. | — |
json_typeof(…) → String | scalar | JSON type of a value. | — |
json_value(…) → String | scalar | SQL/JSON scalar value. | — |
json_values(…) → JSON | scalar | SQL/JSON multiple scalar values. | — |
row_to_json(…) → JSON | scalar | Convert a row to a JSON object. | — |
to_json(…) → JSON | scalar | Convert a value to JSON. | — |
to_json_string(…) → String | scalar | Convert a value to JSON text. | — |