Class: Google::Apis::FirestoreV1::StructuredQuery

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/firestore_v1/classes.rb,
generated/google/apis/firestore_v1/representations.rb,
generated/google/apis/firestore_v1/representations.rb

Overview

A Firestore query.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ StructuredQuery

Returns a new instance of StructuredQuery.



2195
2196
2197
 
# File 'generated/google/apis/firestore_v1/classes.rb', line 2195

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#end_at ⇒ Google::Apis::FirestoreV1::Cursor

A position in a query result set. Corresponds to the JSON property endAt

Returns:



2147
2148
2149
 
# File 'generated/google/apis/firestore_v1/classes.rb', line 2147

def end_at
  @end_at
end

#from ⇒ Array<Google::Apis::FirestoreV1::CollectionSelector>

The collections to query. Corresponds to the JSON property from

Returns:



2152
2153
2154
 
# File 'generated/google/apis/firestore_v1/classes.rb', line 2152

def from
  @from
end

#limit ⇒ Fixnum

The maximum number of results to return. Applies after all other constraints. Must be >= 0 if specified. Corresponds to the JSON property limit

Returns:

  • (Fixnum) 


2158
2159
2160
 
# File 'generated/google/apis/firestore_v1/classes.rb', line 2158

def limit
  @limit
end

#offset ⇒ Fixnum

The number of results to skip. Applies before limit, but after all other constraints. Must be >= 0 if specified. Corresponds to the JSON property offset

Returns:

  • (Fixnum) 


2164
2165
2166
 
# File 'generated/google/apis/firestore_v1/classes.rb', line 2164

def offset
  @offset
end

#order_by ⇒ Array<Google::Apis::FirestoreV1::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

1becomesSELECT * FROM Foo WHERE A > 1 ORDER BY A, name Corresponds to the JSON propertyorderBy`

Returns:



2178
2179
2180
 
# File 'generated/google/apis/firestore_v1/classes.rb', line 2178

def order_by
  @order_by
end

#select ⇒ Google::Apis::FirestoreV1::Projection

The projection of document's fields to return. Corresponds to the JSON property select

Returns:



2183
2184
2185
 
# File 'generated/google/apis/firestore_v1/classes.rb', line 2183

def select
  @select
end

#start_at ⇒ Google::Apis::FirestoreV1::Cursor

A position in a query result set. Corresponds to the JSON property startAt

Returns:



2188
2189
2190
 
# File 'generated/google/apis/firestore_v1/classes.rb', line 2188

def start_at
  @start_at
end

#where ⇒ Google::Apis::FirestoreV1::Filter

A filter. Corresponds to the JSON property where

Returns:



2193
2194
2195
 
# File 'generated/google/apis/firestore_v1/classes.rb', line 2193

def where
  @where
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
 
# File 'generated/google/apis/firestore_v1/classes.rb', line 2200

def update!(**args)
  @end_at = args[:end_at] if args.key?(:end_at)
  @from = args[:from] if args.key?(:from)
  @limit = args[:limit] if args.key?(:limit)
  @offset = args[:offset] if args.key?(:offset)
  @order_by = args[:order_by] if args.key?(:order_by)
  @select = args[:select] if args.key?(:select)
  @start_at = args[:start_at] if args.key?(:start_at)
  @where = args[:where] if args.key?(:where)
end