minor doc adjustments #15531
Merged
minor doc adjustments #15531
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
317brian
approved these changes
Dec 11, 2023
docs/querying/sql-functions.md
Outdated
|
|
||
| `JSON_QUERY_ARRAY(expr, path)` | ||
|
|
||
| Extracts an `ARRAY<COMPLEX<json>>` value from `expr`, at the specified `path`. If value is not an `ARRAY`, it will be translated into a single element `ARRAY` containing the value at `path`. The primary use of this function is to allow extracting arrays of objects to use as inputs to other [array functions](./sql-array-functions.md). |
There was a problem hiding this comment.
Suggested change
| Extracts an `ARRAY<COMPLEX<json>>` value from `expr`, at the specified `path`. If value is not an `ARRAY`, it will be translated into a single element `ARRAY` containing the value at `path`. The primary use of this function is to allow extracting arrays of objects to use as inputs to other [array functions](./sql-array-functions.md). | |
| Extracts an `ARRAY<COMPLEX<json>>` value from `expr` at the specified `path`. If value is not an `ARRAY`, it gets translated into a single element `ARRAY` containing the value at `path`. The primary use of this function is to extract arrays of objects to use as inputs to other [array functions](./sql-array-functions.md). |
docs/querying/sql-json-functions.md
Outdated
| @@ -40,7 +40,7 @@ You can use the following JSON functions to extract, transform, and create `COMP | |||
| |`JSON_OBJECT(KEY expr1 VALUE expr2[, KEY expr3 VALUE expr4, ...])` | Constructs a new `COMPLEX<json>` object. The `KEY` expressions must evaluate to string types. The `VALUE` expressions can be composed of any input type, including other `COMPLEX<json>` values. `JSON_OBJECT` can accept colon-separated key-value pairs. The following syntax is equivalent: `JSON_OBJECT(expr1:expr2[, expr3:expr4, ...])`.| | |||
| |`JSON_PATHS(expr)`| Returns an array of all paths which refer to literal values in `expr` in JSONPath format. | | |||
| |`JSON_QUERY(expr, path)`| Extracts a `COMPLEX<json>` value from `expr`, at the specified `path`. | | |||
| |`JSON_QUERY_ARRAY(expr, path)`| Extracts an `ARRAY<COMPLEX<json>>` value from `expr`, at the specified `path`. If value is not an `ARRAY`, it will be translated into a single element `ARRAY` containing the value at `path`.| | |||
| |`JSON_QUERY_ARRAY(expr, path)`| Extracts an `ARRAY<COMPLEX<json>>` value from `expr`, at the specified `path`. If value is not an `ARRAY`, it will be translated into a single element `ARRAY` containing the value at `path`. The primary use of this function is to allow extracting arrays of objects to use as inputs to other [array functions](./sql-array-functions.md)| | |||
There was a problem hiding this comment.
Suggested change
| |`JSON_QUERY_ARRAY(expr, path)`| Extracts an `ARRAY<COMPLEX<json>>` value from `expr`, at the specified `path`. If value is not an `ARRAY`, it will be translated into a single element `ARRAY` containing the value at `path`. The primary use of this function is to allow extracting arrays of objects to use as inputs to other [array functions](./sql-array-functions.md)| | |
| |`JSON_QUERY_ARRAY(expr, path)`| Extracts an `ARRAY<COMPLEX<json>>` value from `expr` at the specified `path`. If value is not an `ARRAY`, it gets translated into a single element `ARRAY` containing the value at `path`. The primary use of this function is to extract arrays of objects to use as inputs to other [array functions](./sql-array-functions.md)| |
soumyava
reviewed
Dec 11, 2023
| @@ -192,7 +192,7 @@ See javadoc of java.lang.Math for detailed explanation for each function. | |||
| | array_set_add_all(arr1,arr2) | combines the unique set of elements of 2 arrays, the resulting array type determined by the type of the first array | | |||
| | array_slice(arr,start,end) | return the subarray of arr from the 0 based index start(inclusive) to end(exclusive), or `null`, if start is less than 0, greater than length of arr or less than end| | |||
| | array_to_string(arr,str) | joins all elements of arr by the delimiter specified by str | | |||
| | string_to_array(str1,str2) | splits str1 into an array on the delimiter specified by str2 | | |||
| | string_to_array(str1,str2) | splits str1 into an array on the delimiter specified by str2, which is a regular expression | | |||
There was a problem hiding this comment.
QQ. Is str2 always a regex ? Or can it can be a delimiter like , or |. I see that I can run select STRING_TO_ARRAY('a,b,c',',') where str2 is not a regular expression. If so can we modify this as splits str1 into an array on the delimiter specified by str2, which can be a regular expression
There was a problem hiding this comment.
it just calls string.split so is always a regex
soumyava
approved these changes
Dec 11, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Update docs to clarify that
string_to_array2nd argument is regex (was missing from a few places), and addsJSON_QUERY_ARRAYto sql functions list and clarifies primary intended usage as input to other array functions.