Module: Google::Cloud::Firestore::V1::StructuredQuery::FieldFilter::Operator

Defined in:
proto_docs/google/firestore/v1/query.rb

Overview

A field filter operator.

Constant Summary collapse

OPERATOR_UNSPECIFIED =

Unspecified. This value must not be used.

0
LESS_THAN =

The given field is less than the given value.

Requires:

  • That field come first in order_by.
1
LESS_THAN_OR_EQUAL =

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

Requires:

  • That field come first in order_by.
2
GREATER_THAN =

The given field is greater than the given value.

Requires:

  • That field come first in order_by.
3
GREATER_THAN_OR_EQUAL =

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

Requires:

  • That field come first in order_by.
4
EQUAL =

The given field is equal to the given value.

5
NOT_EQUAL =

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.
6
ARRAY_CONTAINS =

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

7
IN =

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

Requires:

  • That value is a non-empty ArrayValue with at most 10 values.
  • No other IN or ARRAY_CONTAINS_ANY or NOT_IN.
8
ARRAY_CONTAINS_ANY =

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

Requires:

  • That value is a non-empty ArrayValue with at most 10 values.
  • No other IN or ARRAY_CONTAINS_ANY or NOT_IN.
9
NOT_IN =

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 IN, ARRAY_CONTAINS_ANY, NOT_IN, NOT_EQUAL, IS_NOT_NULL, or IS_NOT_NAN.
  • That field comes first in the order_by.
10