Cloud Firestore V1 API - Module Google::Cloud::Firestore::V1::StructuredQuery::FieldFilter::Operator (v2.4.0)

Reference documentation and code samples for the Cloud Firestore V1 API module Google::Cloud::Firestore::V1::StructuredQuery::FieldFilter::Operator.

A field filter operator.

Constants

OPERATOR_UNSPECIFIED

value: 0
Unspecified. This value must not be used.

LESS_THAN

value: 1

The given field is less than the given value.

Requires:

  • That field come first in order_by.

LESS_THAN_OR_EQUAL

value: 2

The given field is less than or equal to the given value.

Requires:

  • That field come first in order_by.

GREATER_THAN

value: 3

The given field is greater than the given value.

Requires:

  • That field come first in order_by.

GREATER_THAN_OR_EQUAL

value: 4

The given field is greater than or equal to the given value.

Requires:

  • That field come first in order_by.

EQUAL

value: 5
The given field is equal to the given value.

NOT_EQUAL

value: 6

The given field is not equal to the given value.

Requires:

  • No other NOT_EQUAL, NOT_IN, IS_NOT_NULL, or IS_NOT_NAN.
  • That field comes first in the order_by.

ARRAY_CONTAINS

value: 7
The given field is an array that contains the given value.

IN

value: 8

The given field is equal to at least one value in the given array.

Requires:

  • That value is a non-empty ArrayValue, subject to disjunction limits.
  • No NOT_IN filters in the same query.

ARRAY_CONTAINS_ANY

value: 9

The given field is an array that contains any of the values in the given array.

Requires:

  • That value is a non-empty ArrayValue, subject to disjunction limits.
  • No other ARRAY_CONTAINS_ANY filters within the same disjunction.
  • No NOT_IN filters in the same query.

NOT_IN

value: 10

The value of the field is not in the given array.

Requires:

  • That value is a non-empty ArrayValue with at most 10 values.
  • No other OR, IN, ARRAY_CONTAINS_ANY, NOT_IN, NOT_EQUAL, IS_NOT_NULL, or IS_NOT_NAN.
  • That field comes first in the order_by.