y
y
yq
v4.x
Search…
⌃K

Contains

This returns true if the context contains the passed in parameter, and false otherwise. For arrays, this will return true if the passed in array is contained within the array. For strings, it will return true if the string is a substring.
Note that, just like jq, when checking if an array of strings contains another, this will use contains and not equals to check each string. This means an array like contains(["cat"]) will return true for an array ["cats"].
See the "Array has a subset array" example below on how to check for a subset.

Array contains array

Array is equal or subset of
Given a sample.yml file of:
- foobar
- foobaz
- blarp
then
yq 'contains(["baz", "bar"])' sample.yml
will output
true

Array has a subset array

Subtract the superset array from the subset, if there's anything left, it's not a subset
Given a sample.yml file of:
- foobar
- foobaz
- blarp
then
yq '["baz", "bar"] - . | length == 0' sample.yml
will output
false

Object included in array

Given a sample.yml file of:
"foo": 12
"bar":
- 1
- 2
- "barp": 12
"blip": 13
then
yq 'contains({"bar": [{"barp": 12}]})' sample.yml
will output
true

Object not included in array

Given a sample.yml file of:
"foo": 12
"bar":
- 1
- 2
- "barp": 12
"blip": 13
then
yq 'contains({"foo": 12, "bar": [{"barp": 15}]})' sample.yml
will output
false

String contains substring

Given a sample.yml file of:
foobar
then
yq 'contains("bar")' sample.yml
will output
true

String equals string

Given a sample.yml file of:
meow
then
yq 'contains("meow")' sample.yml
will output
true