-
Notifications
You must be signed in to change notification settings - Fork 487
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Added json_path function #4225
Merged
Merged
Added json_path function #4225
Changes from 2 commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,41 @@ | ||
| --- | ||
| aliases: | ||
| - ../../configuration-language/standard-library/json_path/ | ||
| title: json_path | ||
| --- | ||
|
|
||
| # json_path | ||
|
|
||
| The `json_path` function lookup values using [jsonpath](https://goessner.net/articles/JsonPath/) syntax. | ||
|
|
||
| The function expects 2 strings. First string is the json string to lookup values from. Second string is the jsonpath expression. | ||
|
|
||
| `json_path` always return a list of values. If the jsonpath expression does not match any values, an empty list is returned. | ||
|
|
||
| A common use case of `json_path` is to decode and filter the output of a [`local.file`][] or [`remote.http`][] component to a River value. | ||
|
|
||
| > Remember to escape double quotes when passing JSON string literals to `json_path`. | ||
jkroepke marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| > | ||
| > For example, the JSON value `{"key": "value"}` is properly represented by the | ||
| > string `"{\"key\": \"value\"}"`. | ||
|
|
||
| ## Examples | ||
|
|
||
| ``` | ||
| > json_path("{\"key\": \"value\"}", ".key") | ||
| ["value"] | ||
|
|
||
|
|
||
| > json_path("[{\"name\": \"Department\",\"value\": \"IT\"},{\"name\":\"TestStatus\",\"value\":\"Pending\"}]", "[?(@.name == \"Department\")].value") | ||
| ["IT"] | ||
|
|
||
| > json_path("{\"key\": \"value\"}", ".nonexists") | ||
| [] | ||
|
|
||
| > json_path("{\"key\": \"value\"}", ".key")[0] | ||
| value | ||
|
|
||
| ``` | ||
jkroepke marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| [`local.file`]: {{< relref "../components/local.file.md" >}} | ||
| [`remote.http`]: {{< relref "../components/remote.http.md" >}} | ||
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
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
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
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
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It's implied, but could we also mention that we can pass the string export of another component directly if it's valid JSON?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I do a bit copy/paste from json_encode. Is this enough?