PropertyFilterInput

Condition on a single property. When several operators are given, all of them
must match. Operators given a null or empty string value are ignored, unless
allow_empty is true

type PropertyFilterInput {
  allow_empty: Boolean
  array_contains: [String!]
  array_overlaps: [String!]
  case_sensitive: Boolean
  contains: String
  distance_sphere: GeoPropertyFilterInput
  ends_with: String
  exists: Boolean
  name: String!
  not_array_contains: [String!]
  not_array_overlaps: [String!]
  not_contains: String
  not_ends_with: String
  not_starts_with: String
  not_value: String
  not_value_array: [String!]
  not_value_boolean: Boolean
  not_value_float: Float
  not_value_in: [String!]
  not_value_int: Int
  not_within_radius: GeoRadiusPropertyFilterInput
  property_type: String
  range: RangeFilter
  starts_with: String
  value: String
  value_array: [String!]
  value_boolean: Boolean
  value_float: Float
  value_in: [String!]
  value_int: Int
  within_radius: GeoRadiusPropertyFilterInput
}

Fields

allow_empty (Boolean)

When true, operators given a null or empty string value are applied (e.g.
value: "" matches an empty string) instead of being ignored

array_contains (String)

Matches when the Array property contains all of the given elements. Raises an error for a property that is not an Array

array_overlaps (String)

Matches when the Array property contains at least one of the given elements.
Raises an error for a property that is not an Array

case_sensitive (Boolean)

When true, contains, startswith, ends_with and their not variants are case sensitive. Defaults to case insensitive

contains (String)

Matches when the property value contains this string. Case insensitive unless case_sensitive is true

distance_sphere (GeoPropertyFilterInput)

Matches records whose geometry property lies closer than distance_in_km to center, ordered by distance (see sort)

ends_with (String)

Matches when the property value ends with this string. Case insensitive unless case_sensitive is true

exists (Boolean)

When true, matches records where the property is present and not null; when false, records where it is missing or null

name (String)

Name of the property the condition applies to

not_array_contains (String)

Matches when the Array property does not contain all of the given elements (it
may contain some of them). Raises an error for a property that is not an Array

not_array_overlaps (String)

Matches when the Array property has no element in common with the given
elements. Raises an error for a property that is not an Array

not_contains (String)

Matches when the property value does not contain this string. Case insensitive unless case_sensitive is true

not_ends_with (String)

Matches when the property value does not end with this string. Case insensitive unless case_sensitive is true

not_starts_with (String)

Matches when the property value does not start with this string. Case insensitive unless case_sensitive is true

not_value (String)

Matches when the property value is not equal to this string, including records without the property

not_value_array (String)

Matches when the Array property is not equal to the given array. Raises an error for a property that is not an Array

not_value_boolean (Boolean)

Matches when the property is not equal to this boolean, including records without the property

not_value_float (Float)

Matches when the property is not equal to this number, including records without the property

not_value_in (String)

Matches when the property is equal to none of the given values. For an Array
property, matches when at least one element of the property is not among the given values

not_value_int (Int)

Matches when the property is not equal to this integer, including records without the property

not_within_radius (GeoRadiusPropertyFilterInput)

Matches records whose geometry property does not lie within radius_in_km_from_property kilometers from point

property_type (String)

Type of the property, e.g. string, integer, float, boolean, array, date or
datetime. Only needed when it cannot be determined from the table in the
filter; an unknown type raises an error

range (RangeFilter)

Matches when the property value is within the range; lt, lte, gt and gte can
be combined. String, Date and DateTime properties are compared as text (use
ISO 8601 dates), other properties numerically

starts_with (String)

Matches when the property value starts with this string. Case insensitive unless case_sensitive is true

value (String)

Matches when the property value is equal to this string. Integer, Float and
Boolean properties are compared as text; use value_int, value_float or
value_boolean for them, which is also faster

value_array (String)

Matches when the Array property is equal to the given array, including element
order. Raises an error for a property that is not an Array

value_boolean (Boolean)

Matches when the property is equal to this boolean

value_float (Float)

Matches when the property is equal to this number

value_in (String)

Matches when the property is equal to one of the given values. For an Array
property, matches when every element of the property is one of the given values

value_int (Int)

Matches when the property is equal to this integer

within_radius (GeoRadiusPropertyFilterInput)

Matches records whose geometry property lies within radius_in_km_from_property kilometers from point