yq/pkg/yqlib/doc/Path.md

93 lines
1.3 KiB
Markdown
Raw Normal View History

2020-11-22 02:16:54 +00:00
The path operator can be used to get the traversal paths of matching nodes in an expression. The path is returned as an array, which if traversed in order will lead to the matching node.
2020-11-26 00:20:53 +00:00
You can get the key/index of matching nodes by using the `path` operator to return the path array then piping that through `.[-1]` to get the last element of that array, the key.
2020-11-22 02:16:54 +00:00
## Map path
2020-11-22 01:19:57 +00:00
Given a sample.yml file of:
```yaml
a:
b: cat
```
then
```bash
yq eval '.a.b | path' sample.yml
```
will output
```yaml
- a
- b
```
2020-11-26 00:20:53 +00:00
## Get map key
Given a sample.yml file of:
```yaml
a:
b: cat
```
then
```bash
yq eval '.a.b | path | .[-1]' sample.yml
```
will output
```yaml
b
```
2020-11-22 02:16:54 +00:00
## Array path
2020-11-22 01:19:57 +00:00
Given a sample.yml file of:
```yaml
a:
- cat
- dog
```
then
```bash
yq eval '.a.[] | select(. == "dog") | path' sample.yml
```
will output
```yaml
- a
- 1
```
2020-11-26 00:20:53 +00:00
## Get array index
Given a sample.yml file of:
```yaml
a:
- cat
- dog
```
then
```bash
yq eval '.a.[] | select(. == "dog") | path | .[-1]' sample.yml
```
will output
```yaml
1
```
2020-11-22 02:16:54 +00:00
## Print path and value
2020-11-22 01:19:57 +00:00
Given a sample.yml file of:
```yaml
a:
- cat
- dog
- frog
```
then
```bash
yq eval '.a.[] | select(. == "*og") | [{"path":path, "value":.}]' sample.yml
```
will output
2021-02-03 06:20:54 +00:00
```yaml
- path:
- a
- 1
value: dog
- path:
- a
- 2
value: frog
```