mirror of
https://github.com/mikefarah/yq.git
synced 2024-12-19 20:19:04 +00:00
fa6fac1a76
* Remove extra backtick * Reword explanation of update * Reword explanation of relative update * Change "remaple" to "remain" * Change "clovver" to "clobber" * Reword explanation of update for comment operators * Reword explanation of relative update for comment operators * Change "array" to "expression" * Change "the golangs" to "Golang's" * Change "golangs" to "Golang's" * Change "can durations" to "can add durations" * Change "array scalars" to "arrays" * Change "beit" to "be it" * Fix typo in `eval` tip * Fix typo in header for `has` operation * Add space before pipe in `line` operator example * Fix typos in explanation of deep array merges * Change "is now used" to "is now used." * Change "object," to "object." * Changes "indexes" to "indices" * Remove extraneous copied text from `..` article * Reword explanation of `...` operator * Change "your are" to "you are" * Add link to `string` operator docs in `select` article * Change "is a" to "parameter specifies" in `string` operators article * Change "new line" to "newline" * Change "golang regex" to "Golang's regex" * Change "golang" to "Golang" * Add period * Remove comma in `subtract` article * Remove duplicate number subtraction example * Remove comma in `traverse` operator article * Clarify use of brackets when `read`ing with special characters
157 lines
2.5 KiB
Markdown
157 lines
2.5 KiB
Markdown
# Recursive Descent (Glob)
|
|
|
|
This operator recursively matches (or globs) all children nodes given of a particular element, including that node itself. This is most often used to apply a filter recursively against all matches.
|
|
|
|
## match values form `..`
|
|
This will, like the `jq` equivalent, recursively match all _value_ nodes. Use it to find/manipulate particular values.
|
|
|
|
For instance to set the `style` of all _value_ nodes in a yaml doc, excluding map keys:
|
|
|
|
```bash
|
|
yq '.. style= "flow"' file.yaml
|
|
```
|
|
|
|
## match values and map keys form `...`
|
|
The also includes map keys in the results set. This is particularly useful in YAML as unlike JSON, map keys can have their own styling and tags and also use anchors and aliases.
|
|
|
|
For instance to set the `style` of all nodes in a yaml doc, including the map keys:
|
|
|
|
```bash
|
|
yq '... style= "flow"' file.yaml
|
|
```
|
|
## Recurse map (values only)
|
|
Given a sample.yml file of:
|
|
```yaml
|
|
a: frog
|
|
```
|
|
then
|
|
```bash
|
|
yq '..' sample.yml
|
|
```
|
|
will output
|
|
```yaml
|
|
a: frog
|
|
frog
|
|
```
|
|
|
|
## Recursively find nodes with keys
|
|
Note that this example has wrapped the expression in `[]` to show that there are two matches returned. You do not have to wrap in `[]` in your path expression.
|
|
|
|
Given a sample.yml file of:
|
|
```yaml
|
|
a:
|
|
name: frog
|
|
b:
|
|
name: blog
|
|
age: 12
|
|
```
|
|
then
|
|
```bash
|
|
yq '[.. | select(has("name"))]' sample.yml
|
|
```
|
|
will output
|
|
```yaml
|
|
- name: frog
|
|
b:
|
|
name: blog
|
|
age: 12
|
|
- name: blog
|
|
age: 12
|
|
```
|
|
|
|
## Recursively find nodes with values
|
|
Given a sample.yml file of:
|
|
```yaml
|
|
a:
|
|
nameA: frog
|
|
b:
|
|
nameB: frog
|
|
age: 12
|
|
```
|
|
then
|
|
```bash
|
|
yq '.. | select(. == "frog")' sample.yml
|
|
```
|
|
will output
|
|
```yaml
|
|
frog
|
|
frog
|
|
```
|
|
|
|
## Recurse map (values and keys)
|
|
Note that the map key appears in the results
|
|
|
|
Given a sample.yml file of:
|
|
```yaml
|
|
a: frog
|
|
```
|
|
then
|
|
```bash
|
|
yq '...' sample.yml
|
|
```
|
|
will output
|
|
```yaml
|
|
a: frog
|
|
a
|
|
frog
|
|
```
|
|
|
|
## Aliases are not traversed
|
|
Given a sample.yml file of:
|
|
```yaml
|
|
a: &cat
|
|
c: frog
|
|
b: *cat
|
|
```
|
|
then
|
|
```bash
|
|
yq '[..]' sample.yml
|
|
```
|
|
will output
|
|
```yaml
|
|
- a: &cat
|
|
c: frog
|
|
b: *cat
|
|
- &cat
|
|
c: frog
|
|
- frog
|
|
- *cat
|
|
```
|
|
|
|
## Merge docs are not traversed
|
|
Given a sample.yml file of:
|
|
```yaml
|
|
foo: &foo
|
|
a: foo_a
|
|
thing: foo_thing
|
|
c: foo_c
|
|
bar: &bar
|
|
b: bar_b
|
|
thing: bar_thing
|
|
c: bar_c
|
|
foobarList:
|
|
b: foobarList_b
|
|
!!merge <<:
|
|
- *foo
|
|
- *bar
|
|
c: foobarList_c
|
|
foobar:
|
|
c: foobar_c
|
|
!!merge <<: *foo
|
|
thing: foobar_thing
|
|
```
|
|
then
|
|
```bash
|
|
yq '.foobar | [..]' sample.yml
|
|
```
|
|
will output
|
|
```yaml
|
|
- c: foobar_c
|
|
!!merge <<: *foo
|
|
thing: foobar_thing
|
|
- foobar_c
|
|
- *foo
|
|
- foobar_thing
|
|
```
|
|
|