Reference documentation and code samples for the Cloud Firestore V1 Client class Operator.
A field filter operator.
Protobuf type google.firestore.v1.StructuredQuery.FieldFilter.Operator
Namespace
Google \ Cloud \ Firestore \ V1 \ StructuredQuery \ FieldFilterMethods
static::name
Parameter | |
---|---|
Name | Description |
value |
mixed
|
static::value
Parameter | |
---|---|
Name | Description |
name |
mixed
|
Constants
OPERATOR_UNSPECIFIED
Value: 0
Unspecified. This value must not be used.
Generated from protobuf enum OPERATOR_UNSPECIFIED = 0;
LESS_THAN
Value: 1
The given field
is less than the given value
.
Requires:
- That
field
come first inorder_by
.
Generated from protobuf enum LESS_THAN = 1;
LESS_THAN_OR_EQUAL
Value: 2
The given field
is less than or equal to the given value
.
Requires:
- That
field
come first inorder_by
.
Generated from protobuf enum LESS_THAN_OR_EQUAL = 2;
GREATER_THAN
Value: 3
The given field
is greater than the given value
.
Requires:
- That
field
come first inorder_by
.
Generated from protobuf enum GREATER_THAN = 3;
GREATER_THAN_OR_EQUAL
Value: 4
The given field
is greater than or equal to the given value
.
Requires:
- That
field
come first inorder_by
.
Generated from protobuf enum GREATER_THAN_OR_EQUAL = 4;
EQUAL
Value: 5
The given field
is equal to the given value
.
Generated from protobuf enum EQUAL = 5;
NOT_EQUAL
Value: 6
The given field
is not equal to the given value
.
Requires:
- No other
NOT_EQUAL
,NOT_IN
,IS_NOT_NULL
, orIS_NOT_NAN
. - That
field
comes first in theorder_by
.
Generated from protobuf enum NOT_EQUAL = 6;
ARRAY_CONTAINS
Value: 7
The given field
is an array that contains the given value
.
Generated from protobuf enum ARRAY_CONTAINS = 7;
IN
Value: 8
The given field
is equal to at least one value in the given array.
Requires:
- That
value
is a non-emptyArrayValue
, subject to disjunction limits. - No
NOT_IN
filters in the same query.
Generated from protobuf enum IN = 8;
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-emptyArrayValue
, subject to disjunction limits. - No other
ARRAY_CONTAINS_ANY
filters within the same disjunction. - No
NOT_IN
filters in the same query.
Generated from protobuf enum ARRAY_CONTAINS_ANY = 9;
NOT_IN
Value: 10
The value of the field
is not in the given array.
Requires:
- That
value
is a non-emptyArrayValue
with at most 10 values. - No other
OR
,IN
,ARRAY_CONTAINS_ANY
,NOT_IN
,NOT_EQUAL
,IS_NOT_NULL
, orIS_NOT_NAN
. - That
field
comes first in theorder_by
.
Generated from protobuf enum NOT_IN = 10;