mirror of
https://github.com/mikefarah/yq.git
synced 2024-11-15 07:38:14 +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
48 lines
812 B
Markdown
48 lines
812 B
Markdown
# Pick
|
|
|
|
Filter a map by the specified list of keys. Map is returned with the key in the order of the pick list.
|
|
|
|
Similarly, filter an array by the specified list of indices.
|
|
|
|
## Pick keys from map
|
|
Note that the order of the keys matches the pick order and non existent keys are skipped.
|
|
|
|
Given a sample.yml file of:
|
|
```yaml
|
|
myMap:
|
|
cat: meow
|
|
dog: bark
|
|
thing: hamster
|
|
hamster: squeek
|
|
```
|
|
then
|
|
```bash
|
|
yq '.myMap |= pick(["hamster", "cat", "goat"])' sample.yml
|
|
```
|
|
will output
|
|
```yaml
|
|
myMap:
|
|
hamster: squeek
|
|
cat: meow
|
|
```
|
|
|
|
## Pick indices from array
|
|
Note that the order of the indices matches the pick order and non existent indices are skipped.
|
|
|
|
Given a sample.yml file of:
|
|
```yaml
|
|
- cat
|
|
- leopard
|
|
- lion
|
|
```
|
|
then
|
|
```bash
|
|
yq 'pick([2, 0, 734, -5])' sample.yml
|
|
```
|
|
will output
|
|
```yaml
|
|
- lion
|
|
- cat
|
|
```
|
|
|