Homepage

JsonbAttributeFilter

Last edit: Nov 10, 2026

Condition on the value stored under one top-level key of a JSON object. Exactly
one operator must be given besides key; zero or several operators return an
error. Values are compared to the stored JSON value, so a number stored as 5 is
matched by valueint, while the string "5" is matched by value. A not operator
matches when its positive counterpart does not; records without the key are not
matched by most not_ operators (not_value does match them)

type JsonbAttributeFilter {
  array_contains: [String!]
  array_overlaps: [String!]
  array_value_in: [String!]
  contains: String
  exists: Any
  key: String!
  not_array_contains: [String!]
  not_array_overlaps: [String!]
  not_array_value_in: [String!]
  not_contains: String
  not_exists: Any
  not_value: Any
  not_value_array: [String!]
  not_value_boolean: Boolean
  not_value_float: Float
  not_value_in: [String!]
  not_value_int: Int
  value: Any
  value_array: [String!]
  value_boolean: Boolean
  value_float: Float
  value_in: [String!]
  value_int: Int
}

Fields

array_contains (String)

Matches when the value is an array that contains all of the given elements

array_overlaps (String)

Matches when the value is an array that has at least one element in common with the given list

array_value_in (String)

Matches when the value is an array whose every element is in the given list (a subset of it)

contains (String)

Matches when the value, serialized as JSON text, contains the given text; case insensitive. % and _ act as wildcards

exists (Any)

Matches when the given string is an element of the array, a key of the object,
or equal to the string stored under key. It does not test whether key itself
exists; use has_key of the parent filter for that

key (String)

Top-level key whose value is checked

not_array_contains (String)

Negation of array_contains: the array lacks at least one of the given elements

not_array_overlaps (String)

Negation of array_overlaps: the array has no element in common with the given list

not_array_value_in (String)

Negation of array_value_in: the array has at least one element outside the given list

not_contains (String)

Negation of contains

not_exists (Any)

Negation of exists

not_value (Any)

Negation of value; also matches records that do not have the key

not_value_array (String)

Matches when the value is an array that is not exactly equal to the given one

not_value_boolean (Boolean)

Negation of value_boolean

not_value_float (Float)

Negation of value_float

not_value_in (String)

Matches when the value, read as text, is none of the given values

not_value_int (Int)

Negation of value_int

value (Any)

Matches when the value is the given string. Non-string input is converted to
its JSON text first, so use value_int, value_float or value_boolean for
non-string values

value_array (String)

Matches when the value is an array exactly equal to the given one, in the same order

value_boolean (Boolean)

Matches when the value is the given boolean

value_float (Float)

Matches when the value is the given number

value_in (String)

Matches when the value, read as text, is one of the given values

value_int (Int)

Matches when the value is the given integer

Questions?

We are always happy to help with any questions you may have.

contact us