Skip to main content
Version: v1.2.0

compare

Function

compare return an integer comparing two values

Synopsis

compare(a: any, b: any [, nullsMax: bool]) -> int64

Description

The compare function returns an integer comparing two values. The result will be 0 if a is equal to b, +1 if a is greater than b, and -1 if a is less than b. compare differs from <, >, <=, >=, ==, and != in that it will work for any type (e.g., compare(1, "1")).

nullsMax is an optional value (true by default) that determines whether null is treated as the minimum or maximum value.

Examples

echo '{a: 2, b: "1"}' | zq -z 'yield compare(a, b)' -

=>

-1