Class: Google::Firestore::V1::StructuredQuery

Inherits:
Object
  • Object
show all
Defined in:
lib/google/cloud/firestore/v1/doc/google/firestore/v1/query.rb

Overview

A Firestore query.

Defined Under Namespace

Modules: Direction Classes: CollectionSelector, CompositeFilter, FieldFilter, FieldReference, Filter, Order, Projection, UnaryFilter

Instance Attribute Summary collapse

Instance Attribute Details

#end_at ⇒ Google::Firestore::V1::Cursor

Returns A end point for the query results.

Returns:



67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
 
# File 'lib/google/cloud/firestore/v1/doc/google/firestore/v1/query.rb', line 67

class StructuredQuery
  # A selection of a collection, such as `messages as m1`.
  # @!attribute [rw] collection_id
  #   @return [String]
  #     The collection ID.
  #     When set, selects only collections with this ID.
  # @!attribute [rw] all_descendants
  #   @return [true, false]
  #     When false, selects only collections that are immediate children of
  #     the `parent` specified in the containing `RunQueryRequest`.
  #     When true, selects all descendant collections.
  class CollectionSelector; end

  # A filter.
  # @!attribute [rw] composite_filter
  #   @return [Google::Firestore::V1::StructuredQuery::CompositeFilter]
  #     A composite filter.
  # @!attribute [rw] field_filter
  #   @return [Google::Firestore::V1::StructuredQuery::FieldFilter]
  #     A filter on a document field.
  # @!attribute [rw] unary_filter
  #   @return [Google::Firestore::V1::StructuredQuery::UnaryFilter]
  #     A filter that takes exactly one argument.
  class Filter; end

  # A filter that merges multiple other filters using the given operator.
  # @!attribute [rw] op
  #   @return [Google::Firestore::V1::StructuredQuery::CompositeFilter::Operator]
  #     The operator for combining multiple filters.
  # @!attribute [rw] filters
  #   @return [Array<Google::Firestore::V1::StructuredQuery::Filter>]
  #     The list of filters to combine.
  #     Must contain at least one filter.
  class CompositeFilter
    # A composite filter operator.
    module Operator
      # Unspecified. This value must not be used.
      OPERATOR_UNSPECIFIED = 0

      # The results are required to satisfy each of the combined filters.
      AND = 1
    end
  end

  # A filter on a specific field.
  # @!attribute [rw] field
  #   @return [Google::Firestore::V1::StructuredQuery::FieldReference]
  #     The field to filter by.
  # @!attribute [rw] op
  #   @return [Google::Firestore::V1::StructuredQuery::FieldFilter::Operator]
  #     The operator to filter by.
  # @!attribute [rw] value
  #   @return [Google::Firestore::V1::Value]
  #     The value to compare to.
  class FieldFilter
    # A field filter operator.
    module Operator
      # Unspecified. This value must not be used.
      OPERATOR_UNSPECIFIED = 0

      # Less than. Requires that the field come first in `order_by`.
      LESS_THAN = 1

      # Less than or equal. Requires that the field come first in `order_by`.
      LESS_THAN_OR_EQUAL = 2

      # Greater than. Requires that the field come first in `order_by`.
      GREATER_THAN = 3

      # Greater than or equal. Requires that the field come first in
      # `order_by`.
      GREATER_THAN_OR_EQUAL = 4

      # Equal.
      EQUAL = 5

      # Contains. Requires that the field is an array.
      ARRAY_CONTAINS = 7

      # In. Requires that `value` is a non-empty ArrayValue with at most 10
      # values.
      IN = 8

      # Contains any. Requires that the field is an array and
      # `value` is a non-empty ArrayValue with at most 10 values.
      ARRAY_CONTAINS_ANY = 9
    end
  end

  # The projection of document's fields to return.
  # @!attribute [rw] fields
  #   @return [Array<Google::Firestore::V1::StructuredQuery::FieldReference>]
  #     The fields to return.
  #
  #     If empty, all fields are returned. To only return the name
  #     of the document, use `['__name__']`.
  class Projection; end

  # A filter with a single operand.
  # @!attribute [rw] op
  #   @return [Google::Firestore::V1::StructuredQuery::UnaryFilter::Operator]
  #     The unary operator to apply.
  # @!attribute [rw] field
  #   @return [Google::Firestore::V1::StructuredQuery::FieldReference]
  #     The field to which to apply the operator.
  class UnaryFilter
    # A unary operator.
    module Operator
      # Unspecified. This value must not be used.
      OPERATOR_UNSPECIFIED = 0

      # Test if a field is equal to NaN.
      IS_NAN = 2

      # Test if an expression evaluates to Null.
      IS_NULL = 3
    end
  end

  # A reference to a field, such as `max(messages.time) as max_time`.
  # @!attribute [rw] field_path
  #   @return [String]
  class FieldReference; end

  # An order on a field.
  # @!attribute [rw] field
  #   @return [Google::Firestore::V1::StructuredQuery::FieldReference]
  #     The field to order by.
  # @!attribute [rw] direction
  #   @return [Google::Firestore::V1::StructuredQuery::Direction]
  #     The direction to order by. Defaults to `ASCENDING`.
  class Order; end

  # A sort direction.
  module Direction
    # Unspecified.
    DIRECTION_UNSPECIFIED = 0

    # Ascending.
    ASCENDING = 1

    # Descending.
    DESCENDING = 2
  end
end

#from ⇒ Array<Google::Firestore::V1::StructuredQuery::CollectionSelector>

Returns The collections to query.

Returns:



67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
 
# File 'lib/google/cloud/firestore/v1/doc/google/firestore/v1/query.rb', line 67

class StructuredQuery
  # A selection of a collection, such as `messages as m1`.
  # @!attribute [rw] collection_id
  #   @return [String]
  #     The collection ID.
  #     When set, selects only collections with this ID.
  # @!attribute [rw] all_descendants
  #   @return [true, false]
  #     When false, selects only collections that are immediate children of
  #     the `parent` specified in the containing `RunQueryRequest`.
  #     When true, selects all descendant collections.
  class CollectionSelector; end

  # A filter.
  # @!attribute [rw] composite_filter
  #   @return [Google::Firestore::V1::StructuredQuery::CompositeFilter]
  #     A composite filter.
  # @!attribute [rw] field_filter
  #   @return [Google::Firestore::V1::StructuredQuery::FieldFilter]
  #     A filter on a document field.
  # @!attribute [rw] unary_filter
  #   @return [Google::Firestore::V1::StructuredQuery::UnaryFilter]
  #     A filter that takes exactly one argument.
  class Filter; end

  # A filter that merges multiple other filters using the given operator.
  # @!attribute [rw] op
  #   @return [Google::Firestore::V1::StructuredQuery::CompositeFilter::Operator]
  #     The operator for combining multiple filters.
  # @!attribute [rw] filters
  #   @return [Array<Google::Firestore::V1::StructuredQuery::Filter>]
  #     The list of filters to combine.
  #     Must contain at least one filter.
  class CompositeFilter
    # A composite filter operator.
    module Operator
      # Unspecified. This value must not be used.
      OPERATOR_UNSPECIFIED = 0

      # The results are required to satisfy each of the combined filters.
      AND = 1
    end
  end

  # A filter on a specific field.
  # @!attribute [rw] field
  #   @return [Google::Firestore::V1::StructuredQuery::FieldReference]
  #     The field to filter by.
  # @!attribute [rw] op
  #   @return [Google::Firestore::V1::StructuredQuery::FieldFilter::Operator]
  #     The operator to filter by.
  # @!attribute [rw] value
  #   @return [Google::Firestore::V1::Value]
  #     The value to compare to.
  class FieldFilter
    # A field filter operator.
    module Operator
      # Unspecified. This value must not be used.
      OPERATOR_UNSPECIFIED = 0

      # Less than. Requires that the field come first in `order_by`.
      LESS_THAN = 1

      # Less than or equal. Requires that the field come first in `order_by`.
      LESS_THAN_OR_EQUAL = 2

      # Greater than. Requires that the field come first in `order_by`.
      GREATER_THAN = 3

      # Greater than or equal. Requires that the field come first in
      # `order_by`.
      GREATER_THAN_OR_EQUAL = 4

      # Equal.
      EQUAL = 5

      # Contains. Requires that the field is an array.
      ARRAY_CONTAINS = 7

      # In. Requires that `value` is a non-empty ArrayValue with at most 10
      # values.
      IN = 8

      # Contains any. Requires that the field is an array and
      # `value` is a non-empty ArrayValue with at most 10 values.
      ARRAY_CONTAINS_ANY = 9
    end
  end

  # The projection of document's fields to return.
  # @!attribute [rw] fields
  #   @return [Array<Google::Firestore::V1::StructuredQuery::FieldReference>]
  #     The fields to return.
  #
  #     If empty, all fields are returned. To only return the name
  #     of the document, use `['__name__']`.
  class Projection; end

  # A filter with a single operand.
  # @!attribute [rw] op
  #   @return [Google::Firestore::V1::StructuredQuery::UnaryFilter::Operator]
  #     The unary operator to apply.
  # @!attribute [rw] field
  #   @return [Google::Firestore::V1::StructuredQuery::FieldReference]
  #     The field to which to apply the operator.
  class UnaryFilter
    # A unary operator.
    module Operator
      # Unspecified. This value must not be used.
      OPERATOR_UNSPECIFIED = 0

      # Test if a field is equal to NaN.
      IS_NAN = 2

      # Test if an expression evaluates to Null.
      IS_NULL = 3
    end
  end

  # A reference to a field, such as `max(messages.time) as max_time`.
  # @!attribute [rw] field_path
  #   @return [String]
  class FieldReference; end

  # An order on a field.
  # @!attribute [rw] field
  #   @return [Google::Firestore::V1::StructuredQuery::FieldReference]
  #     The field to order by.
  # @!attribute [rw] direction
  #   @return [Google::Firestore::V1::StructuredQuery::Direction]
  #     The direction to order by. Defaults to `ASCENDING`.
  class Order; end

  # A sort direction.
  module Direction
    # Unspecified.
    DIRECTION_UNSPECIFIED = 0

    # Ascending.
    ASCENDING = 1

    # Descending.
    DESCENDING = 2
  end
end

#limit ⇒ Google::Protobuf::Int32Value

Returns The maximum number of results to return.

Applies after all other constraints. Must be >= 0 if specified.

Returns:

  • (Google::Protobuf::Int32Value) —

    The maximum number of results to return.

    Applies after all other constraints. Must be >= 0 if specified.



67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
 
# File 'lib/google/cloud/firestore/v1/doc/google/firestore/v1/query.rb', line 67

class StructuredQuery
  # A selection of a collection, such as `messages as m1`.
  # @!attribute [rw] collection_id
  #   @return [String]
  #     The collection ID.
  #     When set, selects only collections with this ID.
  # @!attribute [rw] all_descendants
  #   @return [true, false]
  #     When false, selects only collections that are immediate children of
  #     the `parent` specified in the containing `RunQueryRequest`.
  #     When true, selects all descendant collections.
  class CollectionSelector; end

  # A filter.
  # @!attribute [rw] composite_filter
  #   @return [Google::Firestore::V1::StructuredQuery::CompositeFilter]
  #     A composite filter.
  # @!attribute [rw] field_filter
  #   @return [Google::Firestore::V1::StructuredQuery::FieldFilter]
  #     A filter on a document field.
  # @!attribute [rw] unary_filter
  #   @return [Google::Firestore::V1::StructuredQuery::UnaryFilter]
  #     A filter that takes exactly one argument.
  class Filter; end

  # A filter that merges multiple other filters using the given operator.
  # @!attribute [rw] op
  #   @return [Google::Firestore::V1::StructuredQuery::CompositeFilter::Operator]
  #     The operator for combining multiple filters.
  # @!attribute [rw] filters
  #   @return [Array<Google::Firestore::V1::StructuredQuery::Filter>]
  #     The list of filters to combine.
  #     Must contain at least one filter.
  class CompositeFilter
    # A composite filter operator.
    module Operator
      # Unspecified. This value must not be used.
      OPERATOR_UNSPECIFIED = 0

      # The results are required to satisfy each of the combined filters.
      AND = 1
    end
  end

  # A filter on a specific field.
  # @!attribute [rw] field
  #   @return [Google::Firestore::V1::StructuredQuery::FieldReference]
  #     The field to filter by.
  # @!attribute [rw] op
  #   @return [Google::Firestore::V1::StructuredQuery::FieldFilter::Operator]
  #     The operator to filter by.
  # @!attribute [rw] value
  #   @return [Google::Firestore::V1::Value]
  #     The value to compare to.
  class FieldFilter
    # A field filter operator.
    module Operator
      # Unspecified. This value must not be used.
      OPERATOR_UNSPECIFIED = 0

      # Less than. Requires that the field come first in `order_by`.
      LESS_THAN = 1

      # Less than or equal. Requires that the field come first in `order_by`.
      LESS_THAN_OR_EQUAL = 2

      # Greater than. Requires that the field come first in `order_by`.
      GREATER_THAN = 3

      # Greater than or equal. Requires that the field come first in
      # `order_by`.
      GREATER_THAN_OR_EQUAL = 4

      # Equal.
      EQUAL = 5

      # Contains. Requires that the field is an array.
      ARRAY_CONTAINS = 7

      # In. Requires that `value` is a non-empty ArrayValue with at most 10
      # values.
      IN = 8

      # Contains any. Requires that the field is an array and
      # `value` is a non-empty ArrayValue with at most 10 values.
      ARRAY_CONTAINS_ANY = 9
    end
  end

  # The projection of document's fields to return.
  # @!attribute [rw] fields
  #   @return [Array<Google::Firestore::V1::StructuredQuery::FieldReference>]
  #     The fields to return.
  #
  #     If empty, all fields are returned. To only return the name
  #     of the document, use `['__name__']`.
  class Projection; end

  # A filter with a single operand.
  # @!attribute [rw] op
  #   @return [Google::Firestore::V1::StructuredQuery::UnaryFilter::Operator]
  #     The unary operator to apply.
  # @!attribute [rw] field
  #   @return [Google::Firestore::V1::StructuredQuery::FieldReference]
  #     The field to which to apply the operator.
  class UnaryFilter
    # A unary operator.
    module Operator
      # Unspecified. This value must not be used.
      OPERATOR_UNSPECIFIED = 0

      # Test if a field is equal to NaN.
      IS_NAN = 2

      # Test if an expression evaluates to Null.
      IS_NULL = 3
    end
  end

  # A reference to a field, such as `max(messages.time) as max_time`.
  # @!attribute [rw] field_path
  #   @return [String]
  class FieldReference; end

  # An order on a field.
  # @!attribute [rw] field
  #   @return [Google::Firestore::V1::StructuredQuery::FieldReference]
  #     The field to order by.
  # @!attribute [rw] direction
  #   @return [Google::Firestore::V1::StructuredQuery::Direction]
  #     The direction to order by. Defaults to `ASCENDING`.
  class Order; end

  # A sort direction.
  module Direction
    # Unspecified.
    DIRECTION_UNSPECIFIED = 0

    # Ascending.
    ASCENDING = 1

    # Descending.
    DESCENDING = 2
  end
end

#offset ⇒ Integer

Returns The number of results to skip.

Applies before limit, but after all other constraints. Must be >= 0 if specified.

Returns:

  • (Integer) —

    The number of results to skip.

    Applies before limit, but after all other constraints. Must be >= 0 if specified.



67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
 
# File 'lib/google/cloud/firestore/v1/doc/google/firestore/v1/query.rb', line 67

class StructuredQuery
  # A selection of a collection, such as `messages as m1`.
  # @!attribute [rw] collection_id
  #   @return [String]
  #     The collection ID.
  #     When set, selects only collections with this ID.
  # @!attribute [rw] all_descendants
  #   @return [true, false]
  #     When false, selects only collections that are immediate children of
  #     the `parent` specified in the containing `RunQueryRequest`.
  #     When true, selects all descendant collections.
  class CollectionSelector; end

  # A filter.
  # @!attribute [rw] composite_filter
  #   @return [Google::Firestore::V1::StructuredQuery::CompositeFilter]
  #     A composite filter.
  # @!attribute [rw] field_filter
  #   @return [Google::Firestore::V1::StructuredQuery::FieldFilter]
  #     A filter on a document field.
  # @!attribute [rw] unary_filter
  #   @return [Google::Firestore::V1::StructuredQuery::UnaryFilter]
  #     A filter that takes exactly one argument.
  class Filter; end

  # A filter that merges multiple other filters using the given operator.
  # @!attribute [rw] op
  #   @return [Google::Firestore::V1::StructuredQuery::CompositeFilter::Operator]
  #     The operator for combining multiple filters.
  # @!attribute [rw] filters
  #   @return [Array<Google::Firestore::V1::StructuredQuery::Filter>]
  #     The list of filters to combine.
  #     Must contain at least one filter.
  class CompositeFilter
    # A composite filter operator.
    module Operator
      # Unspecified. This value must not be used.
      OPERATOR_UNSPECIFIED = 0

      # The results are required to satisfy each of the combined filters.
      AND = 1
    end
  end

  # A filter on a specific field.
  # @!attribute [rw] field
  #   @return [Google::Firestore::V1::StructuredQuery::FieldReference]
  #     The field to filter by.
  # @!attribute [rw] op
  #   @return [Google::Firestore::V1::StructuredQuery::FieldFilter::Operator]
  #     The operator to filter by.
  # @!attribute [rw] value
  #   @return [Google::Firestore::V1::Value]
  #     The value to compare to.
  class FieldFilter
    # A field filter operator.
    module Operator
      # Unspecified. This value must not be used.
      OPERATOR_UNSPECIFIED = 0

      # Less than. Requires that the field come first in `order_by`.
      LESS_THAN = 1

      # Less than or equal. Requires that the field come first in `order_by`.
      LESS_THAN_OR_EQUAL = 2

      # Greater than. Requires that the field come first in `order_by`.
      GREATER_THAN = 3

      # Greater than or equal. Requires that the field come first in
      # `order_by`.
      GREATER_THAN_OR_EQUAL = 4

      # Equal.
      EQUAL = 5

      # Contains. Requires that the field is an array.
      ARRAY_CONTAINS = 7

      # In. Requires that `value` is a non-empty ArrayValue with at most 10
      # values.
      IN = 8

      # Contains any. Requires that the field is an array and
      # `value` is a non-empty ArrayValue with at most 10 values.
      ARRAY_CONTAINS_ANY = 9
    end
  end

  # The projection of document's fields to return.
  # @!attribute [rw] fields
  #   @return [Array<Google::Firestore::V1::StructuredQuery::FieldReference>]
  #     The fields to return.
  #
  #     If empty, all fields are returned. To only return the name
  #     of the document, use `['__name__']`.
  class Projection; end

  # A filter with a single operand.
  # @!attribute [rw] op
  #   @return [Google::Firestore::V1::StructuredQuery::UnaryFilter::Operator]
  #     The unary operator to apply.
  # @!attribute [rw] field
  #   @return [Google::Firestore::V1::StructuredQuery::FieldReference]
  #     The field to which to apply the operator.
  class UnaryFilter
    # A unary operator.
    module Operator
      # Unspecified. This value must not be used.
      OPERATOR_UNSPECIFIED = 0

      # Test if a field is equal to NaN.
      IS_NAN = 2

      # Test if an expression evaluates to Null.
      IS_NULL = 3
    end
  end

  # A reference to a field, such as `max(messages.time) as max_time`.
  # @!attribute [rw] field_path
  #   @return [String]
  class FieldReference; end

  # An order on a field.
  # @!attribute [rw] field
  #   @return [Google::Firestore::V1::StructuredQuery::FieldReference]
  #     The field to order by.
  # @!attribute [rw] direction
  #   @return [Google::Firestore::V1::StructuredQuery::Direction]
  #     The direction to order by. Defaults to `ASCENDING`.
  class Order; end

  # A sort direction.
  module Direction
    # Unspecified.
    DIRECTION_UNSPECIFIED = 0

    # Ascending.
    ASCENDING = 1

    # Descending.
    DESCENDING = 2
  end
end

#order_by ⇒ Array<Google::Firestore::V1::StructuredQuery::Order>

Returns The order to apply to the query results.

Firestore guarantees a stable ordering through the following rules:

  • Any field required to appear in order_by, that is not already specified in order_by, is appended to the order in field name order by default.
  • If an order on __name__ is not specified, it is appended by default.

Fields are appended with the same sort direction as the last order specified, or 'ASCENDING' if no order was specified. For example:

  • SELECT * FROM Foo ORDER BY A becomes SELECT * FROM Foo ORDER BY A, __name__
  • SELECT * FROM Foo ORDER BY A DESC becomes SELECT * FROM Foo ORDER BY A DESC, __name__ DESC
  • SELECT * FROM Foo WHERE A > 1 becomes SELECT * FROM Foo WHERE A > 1 ORDER BY A, __name__.

Returns:

  • (Array<Google::Firestore::V1::StructuredQuery::Order>) —

    The order to apply to the query results.

    Firestore guarantees a stable ordering through the following rules:

    • Any field required to appear in order_by, that is not already specified in order_by, is appended to the order in field name order by default.
    • If an order on __name__ is not specified, it is appended by default.

    Fields are appended with the same sort direction as the last order specified, or 'ASCENDING' if no order was specified. For example:

    • SELECT * FROM Foo ORDER BY A becomes SELECT * FROM Foo ORDER BY A, __name__
    • SELECT * FROM Foo ORDER BY A DESC becomes SELECT * FROM Foo ORDER BY A DESC, __name__ DESC
    • SELECT * FROM Foo WHERE A > 1 becomes SELECT * FROM Foo WHERE A > 1 ORDER BY A, __name__


67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
 
# File 'lib/google/cloud/firestore/v1/doc/google/firestore/v1/query.rb', line 67

class StructuredQuery
  # A selection of a collection, such as `messages as m1`.
  # @!attribute [rw] collection_id
  #   @return [String]
  #     The collection ID.
  #     When set, selects only collections with this ID.
  # @!attribute [rw] all_descendants
  #   @return [true, false]
  #     When false, selects only collections that are immediate children of
  #     the `parent` specified in the containing `RunQueryRequest`.
  #     When true, selects all descendant collections.
  class CollectionSelector; end

  # A filter.
  # @!attribute [rw] composite_filter
  #   @return [Google::Firestore::V1::StructuredQuery::CompositeFilter]
  #     A composite filter.
  # @!attribute [rw] field_filter
  #   @return [Google::Firestore::V1::StructuredQuery::FieldFilter]
  #     A filter on a document field.
  # @!attribute [rw] unary_filter
  #   @return [Google::Firestore::V1::StructuredQuery::UnaryFilter]
  #     A filter that takes exactly one argument.
  class Filter; end

  # A filter that merges multiple other filters using the given operator.
  # @!attribute [rw] op
  #   @return [Google::Firestore::V1::StructuredQuery::CompositeFilter::Operator]
  #     The operator for combining multiple filters.
  # @!attribute [rw] filters
  #   @return [Array<Google::Firestore::V1::StructuredQuery::Filter>]
  #     The list of filters to combine.
  #     Must contain at least one filter.
  class CompositeFilter
    # A composite filter operator.
    module Operator
      # Unspecified. This value must not be used.
      OPERATOR_UNSPECIFIED = 0

      # The results are required to satisfy each of the combined filters.
      AND = 1
    end
  end

  # A filter on a specific field.
  # @!attribute [rw] field
  #   @return [Google::Firestore::V1::StructuredQuery::FieldReference]
  #     The field to filter by.
  # @!attribute [rw] op
  #   @return [Google::Firestore::V1::StructuredQuery::FieldFilter::Operator]
  #     The operator to filter by.
  # @!attribute [rw] value
  #   @return [Google::Firestore::V1::Value]
  #     The value to compare to.
  class FieldFilter
    # A field filter operator.
    module Operator
      # Unspecified. This value must not be used.
      OPERATOR_UNSPECIFIED = 0

      # Less than. Requires that the field come first in `order_by`.
      LESS_THAN = 1

      # Less than or equal. Requires that the field come first in `order_by`.
      LESS_THAN_OR_EQUAL = 2

      # Greater than. Requires that the field come first in `order_by`.
      GREATER_THAN = 3

      # Greater than or equal. Requires that the field come first in
      # `order_by`.
      GREATER_THAN_OR_EQUAL = 4

      # Equal.
      EQUAL = 5

      # Contains. Requires that the field is an array.
      ARRAY_CONTAINS = 7

      # In. Requires that `value` is a non-empty ArrayValue with at most 10
      # values.
      IN = 8

      # Contains any. Requires that the field is an array and
      # `value` is a non-empty ArrayValue with at most 10 values.
      ARRAY_CONTAINS_ANY = 9
    end
  end

  # The projection of document's fields to return.
  # @!attribute [rw] fields
  #   @return [Array<Google::Firestore::V1::StructuredQuery::FieldReference>]
  #     The fields to return.
  #
  #     If empty, all fields are returned. To only return the name
  #     of the document, use `['__name__']`.
  class Projection; end

  # A filter with a single operand.
  # @!attribute [rw] op
  #   @return [Google::Firestore::V1::StructuredQuery::UnaryFilter::Operator]
  #     The unary operator to apply.
  # @!attribute [rw] field
  #   @return [Google::Firestore::V1::StructuredQuery::FieldReference]
  #     The field to which to apply the operator.
  class UnaryFilter
    # A unary operator.
    module Operator
      # Unspecified. This value must not be used.
      OPERATOR_UNSPECIFIED = 0

      # Test if a field is equal to NaN.
      IS_NAN = 2

      # Test if an expression evaluates to Null.
      IS_NULL = 3
    end
  end

  # A reference to a field, such as `max(messages.time) as max_time`.
  # @!attribute [rw] field_path
  #   @return [String]
  class FieldReference; end

  # An order on a field.
  # @!attribute [rw] field
  #   @return [Google::Firestore::V1::StructuredQuery::FieldReference]
  #     The field to order by.
  # @!attribute [rw] direction
  #   @return [Google::Firestore::V1::StructuredQuery::Direction]
  #     The direction to order by. Defaults to `ASCENDING`.
  class Order; end

  # A sort direction.
  module Direction
    # Unspecified.
    DIRECTION_UNSPECIFIED = 0

    # Ascending.
    ASCENDING = 1

    # Descending.
    DESCENDING = 2
  end
end

#select ⇒ Google::Firestore::V1::StructuredQuery::Projection

Returns The projection to return.

Returns:



67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
 
# File 'lib/google/cloud/firestore/v1/doc/google/firestore/v1/query.rb', line 67

class StructuredQuery
  # A selection of a collection, such as `messages as m1`.
  # @!attribute [rw] collection_id
  #   @return [String]
  #     The collection ID.
  #     When set, selects only collections with this ID.
  # @!attribute [rw] all_descendants
  #   @return [true, false]
  #     When false, selects only collections that are immediate children of
  #     the `parent` specified in the containing `RunQueryRequest`.
  #     When true, selects all descendant collections.
  class CollectionSelector; end

  # A filter.
  # @!attribute [rw] composite_filter
  #   @return [Google::Firestore::V1::StructuredQuery::CompositeFilter]
  #     A composite filter.
  # @!attribute [rw] field_filter
  #   @return [Google::Firestore::V1::StructuredQuery::FieldFilter]
  #     A filter on a document field.
  # @!attribute [rw] unary_filter
  #   @return [Google::Firestore::V1::StructuredQuery::UnaryFilter]
  #     A filter that takes exactly one argument.
  class Filter; end

  # A filter that merges multiple other filters using the given operator.
  # @!attribute [rw] op
  #   @return [Google::Firestore::V1::StructuredQuery::CompositeFilter::Operator]
  #     The operator for combining multiple filters.
  # @!attribute [rw] filters
  #   @return [Array<Google::Firestore::V1::StructuredQuery::Filter>]
  #     The list of filters to combine.
  #     Must contain at least one filter.
  class CompositeFilter
    # A composite filter operator.
    module Operator
      # Unspecified. This value must not be used.
      OPERATOR_UNSPECIFIED = 0

      # The results are required to satisfy each of the combined filters.
      AND = 1
    end
  end

  # A filter on a specific field.
  # @!attribute [rw] field
  #   @return [Google::Firestore::V1::StructuredQuery::FieldReference]
  #     The field to filter by.
  # @!attribute [rw] op
  #   @return [Google::Firestore::V1::StructuredQuery::FieldFilter::Operator]
  #     The operator to filter by.
  # @!attribute [rw] value
  #   @return [Google::Firestore::V1::Value]
  #     The value to compare to.
  class FieldFilter
    # A field filter operator.
    module Operator
      # Unspecified. This value must not be used.
      OPERATOR_UNSPECIFIED = 0

      # Less than. Requires that the field come first in `order_by`.
      LESS_THAN = 1

      # Less than or equal. Requires that the field come first in `order_by`.
      LESS_THAN_OR_EQUAL = 2

      # Greater than. Requires that the field come first in `order_by`.
      GREATER_THAN = 3

      # Greater than or equal. Requires that the field come first in
      # `order_by`.
      GREATER_THAN_OR_EQUAL = 4

      # Equal.
      EQUAL = 5

      # Contains. Requires that the field is an array.
      ARRAY_CONTAINS = 7

      # In. Requires that `value` is a non-empty ArrayValue with at most 10
      # values.
      IN = 8

      # Contains any. Requires that the field is an array and
      # `value` is a non-empty ArrayValue with at most 10 values.
      ARRAY_CONTAINS_ANY = 9
    end
  end

  # The projection of document's fields to return.
  # @!attribute [rw] fields
  #   @return [Array<Google::Firestore::V1::StructuredQuery::FieldReference>]
  #     The fields to return.
  #
  #     If empty, all fields are returned. To only return the name
  #     of the document, use `['__name__']`.
  class Projection; end

  # A filter with a single operand.
  # @!attribute [rw] op
  #   @return [Google::Firestore::V1::StructuredQuery::UnaryFilter::Operator]
  #     The unary operator to apply.
  # @!attribute [rw] field
  #   @return [Google::Firestore::V1::StructuredQuery::FieldReference]
  #     The field to which to apply the operator.
  class UnaryFilter
    # A unary operator.
    module Operator
      # Unspecified. This value must not be used.
      OPERATOR_UNSPECIFIED = 0

      # Test if a field is equal to NaN.
      IS_NAN = 2

      # Test if an expression evaluates to Null.
      IS_NULL = 3
    end
  end

  # A reference to a field, such as `max(messages.time) as max_time`.
  # @!attribute [rw] field_path
  #   @return [String]
  class FieldReference; end

  # An order on a field.
  # @!attribute [rw] field
  #   @return [Google::Firestore::V1::StructuredQuery::FieldReference]
  #     The field to order by.
  # @!attribute [rw] direction
  #   @return [Google::Firestore::V1::StructuredQuery::Direction]
  #     The direction to order by. Defaults to `ASCENDING`.
  class Order; end

  # A sort direction.
  module Direction
    # Unspecified.
    DIRECTION_UNSPECIFIED = 0

    # Ascending.
    ASCENDING = 1

    # Descending.
    DESCENDING = 2
  end
end

#start_at ⇒ Google::Firestore::V1::Cursor

Returns A starting point for the query results.

Returns:



67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
 
# File 'lib/google/cloud/firestore/v1/doc/google/firestore/v1/query.rb', line 67

class StructuredQuery
  # A selection of a collection, such as `messages as m1`.
  # @!attribute [rw] collection_id
  #   @return [String]
  #     The collection ID.
  #     When set, selects only collections with this ID.
  # @!attribute [rw] all_descendants
  #   @return [true, false]
  #     When false, selects only collections that are immediate children of
  #     the `parent` specified in the containing `RunQueryRequest`.
  #     When true, selects all descendant collections.
  class CollectionSelector; end

  # A filter.
  # @!attribute [rw] composite_filter
  #   @return [Google::Firestore::V1::StructuredQuery::CompositeFilter]
  #     A composite filter.
  # @!attribute [rw] field_filter
  #   @return [Google::Firestore::V1::StructuredQuery::FieldFilter]
  #     A filter on a document field.
  # @!attribute [rw] unary_filter
  #   @return [Google::Firestore::V1::StructuredQuery::UnaryFilter]
  #     A filter that takes exactly one argument.
  class Filter; end

  # A filter that merges multiple other filters using the given operator.
  # @!attribute [rw] op
  #   @return [Google::Firestore::V1::StructuredQuery::CompositeFilter::Operator]
  #     The operator for combining multiple filters.
  # @!attribute [rw] filters
  #   @return [Array<Google::Firestore::V1::StructuredQuery::Filter>]
  #     The list of filters to combine.
  #     Must contain at least one filter.
  class CompositeFilter
    # A composite filter operator.
    module Operator
      # Unspecified. This value must not be used.
      OPERATOR_UNSPECIFIED = 0

      # The results are required to satisfy each of the combined filters.
      AND = 1
    end
  end

  # A filter on a specific field.
  # @!attribute [rw] field
  #   @return [Google::Firestore::V1::StructuredQuery::FieldReference]
  #     The field to filter by.
  # @!attribute [rw] op
  #   @return [Google::Firestore::V1::StructuredQuery::FieldFilter::Operator]
  #     The operator to filter by.
  # @!attribute [rw] value
  #   @return [Google::Firestore::V1::Value]
  #     The value to compare to.
  class FieldFilter
    # A field filter operator.
    module Operator
      # Unspecified. This value must not be used.
      OPERATOR_UNSPECIFIED = 0

      # Less than. Requires that the field come first in `order_by`.
      LESS_THAN = 1

      # Less than or equal. Requires that the field come first in `order_by`.
      LESS_THAN_OR_EQUAL = 2

      # Greater than. Requires that the field come first in `order_by`.
      GREATER_THAN = 3

      # Greater than or equal. Requires that the field come first in
      # `order_by`.
      GREATER_THAN_OR_EQUAL = 4

      # Equal.
      EQUAL = 5

      # Contains. Requires that the field is an array.
      ARRAY_CONTAINS = 7

      # In. Requires that `value` is a non-empty ArrayValue with at most 10
      # values.
      IN = 8

      # Contains any. Requires that the field is an array and
      # `value` is a non-empty ArrayValue with at most 10 values.
      ARRAY_CONTAINS_ANY = 9
    end
  end

  # The projection of document's fields to return.
  # @!attribute [rw] fields
  #   @return [Array<Google::Firestore::V1::StructuredQuery::FieldReference>]
  #     The fields to return.
  #
  #     If empty, all fields are returned. To only return the name
  #     of the document, use `['__name__']`.
  class Projection; end

  # A filter with a single operand.
  # @!attribute [rw] op
  #   @return [Google::Firestore::V1::StructuredQuery::UnaryFilter::Operator]
  #     The unary operator to apply.
  # @!attribute [rw] field
  #   @return [Google::Firestore::V1::StructuredQuery::FieldReference]
  #     The field to which to apply the operator.
  class UnaryFilter
    # A unary operator.
    module Operator
      # Unspecified. This value must not be used.
      OPERATOR_UNSPECIFIED = 0

      # Test if a field is equal to NaN.
      IS_NAN = 2

      # Test if an expression evaluates to Null.
      IS_NULL = 3
    end
  end

  # A reference to a field, such as `max(messages.time) as max_time`.
  # @!attribute [rw] field_path
  #   @return [String]
  class FieldReference; end

  # An order on a field.
  # @!attribute [rw] field
  #   @return [Google::Firestore::V1::StructuredQuery::FieldReference]
  #     The field to order by.
  # @!attribute [rw] direction
  #   @return [Google::Firestore::V1::StructuredQuery::Direction]
  #     The direction to order by. Defaults to `ASCENDING`.
  class Order; end

  # A sort direction.
  module Direction
    # Unspecified.
    DIRECTION_UNSPECIFIED = 0

    # Ascending.
    ASCENDING = 1

    # Descending.
    DESCENDING = 2
  end
end

#where ⇒ Google::Firestore::V1::StructuredQuery::Filter

Returns The filter to apply.

Returns:



67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
 
# File 'lib/google/cloud/firestore/v1/doc/google/firestore/v1/query.rb', line 67

class StructuredQuery
  # A selection of a collection, such as `messages as m1`.
  # @!attribute [rw] collection_id
  #   @return [String]
  #     The collection ID.
  #     When set, selects only collections with this ID.
  # @!attribute [rw] all_descendants
  #   @return [true, false]
  #     When false, selects only collections that are immediate children of
  #     the `parent` specified in the containing `RunQueryRequest`.
  #     When true, selects all descendant collections.
  class CollectionSelector; end

  # A filter.
  # @!attribute [rw] composite_filter
  #   @return [Google::Firestore::V1::StructuredQuery::CompositeFilter]
  #     A composite filter.
  # @!attribute [rw] field_filter
  #   @return [Google::Firestore::V1::StructuredQuery::FieldFilter]
  #     A filter on a document field.
  # @!attribute [rw] unary_filter
  #   @return [Google::Firestore::V1::StructuredQuery::UnaryFilter]
  #     A filter that takes exactly one argument.
  class Filter; end

  # A filter that merges multiple other filters using the given operator.
  # @!attribute [rw] op
  #   @return [Google::Firestore::V1::StructuredQuery::CompositeFilter::Operator]
  #     The operator for combining multiple filters.
  # @!attribute [rw] filters
  #   @return [Array<Google::Firestore::V1::StructuredQuery::Filter>]
  #     The list of filters to combine.
  #     Must contain at least one filter.
  class CompositeFilter
    # A composite filter operator.
    module Operator
      # Unspecified. This value must not be used.
      OPERATOR_UNSPECIFIED = 0

      # The results are required to satisfy each of the combined filters.
      AND = 1
    end
  end

  # A filter on a specific field.
  # @!attribute [rw] field
  #   @return [Google::Firestore::V1::StructuredQuery::FieldReference]
  #     The field to filter by.
  # @!attribute [rw] op
  #   @return [Google::Firestore::V1::StructuredQuery::FieldFilter::Operator]
  #     The operator to filter by.
  # @!attribute [rw] value
  #   @return [Google::Firestore::V1::Value]
  #     The value to compare to.
  class FieldFilter
    # A field filter operator.
    module Operator
      # Unspecified. This value must not be used.
      OPERATOR_UNSPECIFIED = 0

      # Less than. Requires that the field come first in `order_by`.
      LESS_THAN = 1

      # Less than or equal. Requires that the field come first in `order_by`.
      LESS_THAN_OR_EQUAL = 2

      # Greater than. Requires that the field come first in `order_by`.
      GREATER_THAN = 3

      # Greater than or equal. Requires that the field come first in
      # `order_by`.
      GREATER_THAN_OR_EQUAL = 4

      # Equal.
      EQUAL = 5

      # Contains. Requires that the field is an array.
      ARRAY_CONTAINS = 7

      # In. Requires that `value` is a non-empty ArrayValue with at most 10
      # values.
      IN = 8

      # Contains any. Requires that the field is an array and
      # `value` is a non-empty ArrayValue with at most 10 values.
      ARRAY_CONTAINS_ANY = 9
    end
  end

  # The projection of document's fields to return.
  # @!attribute [rw] fields
  #   @return [Array<Google::Firestore::V1::StructuredQuery::FieldReference>]
  #     The fields to return.
  #
  #     If empty, all fields are returned. To only return the name
  #     of the document, use `['__name__']`.
  class Projection; end

  # A filter with a single operand.
  # @!attribute [rw] op
  #   @return [Google::Firestore::V1::StructuredQuery::UnaryFilter::Operator]
  #     The unary operator to apply.
  # @!attribute [rw] field
  #   @return [Google::Firestore::V1::StructuredQuery::FieldReference]
  #     The field to which to apply the operator.
  class UnaryFilter
    # A unary operator.
    module Operator
      # Unspecified. This value must not be used.
      OPERATOR_UNSPECIFIED = 0

      # Test if a field is equal to NaN.
      IS_NAN = 2

      # Test if an expression evaluates to Null.
      IS_NULL = 3
    end
  end

  # A reference to a field, such as `max(messages.time) as max_time`.
  # @!attribute [rw] field_path
  #   @return [String]
  class FieldReference; end

  # An order on a field.
  # @!attribute [rw] field
  #   @return [Google::Firestore::V1::StructuredQuery::FieldReference]
  #     The field to order by.
  # @!attribute [rw] direction
  #   @return [Google::Firestore::V1::StructuredQuery::Direction]
  #     The direction to order by. Defaults to `ASCENDING`.
  class Order; end

  # A sort direction.
  module Direction
    # Unspecified.
    DIRECTION_UNSPECIFIED = 0

    # Ascending.
    ASCENDING = 1

    # Descending.
    DESCENDING = 2
  end
end