Class: Google::Apis::FirestoreV1beta1::StructuredQuery

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/firestore_v1beta1/classes.rb,
generated/google/apis/firestore_v1beta1/representations.rb,
generated/google/apis/firestore_v1beta1/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.



1854
1855
1856
 
# File 'generated/google/apis/firestore_v1beta1/classes.rb', line 1854

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

Instance Attribute Details

#end_at ⇒ Google::Apis::FirestoreV1beta1::Cursor

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

Returns:



1806
1807
1808
 
# File 'generated/google/apis/firestore_v1beta1/classes.rb', line 1806

def end_at
  @end_at
end

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

The collections to query. Corresponds to the JSON property from

Returns:



1811
1812
1813
 
# File 'generated/google/apis/firestore_v1beta1/classes.rb', line 1811

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) 


1817
1818
1819
 
# File 'generated/google/apis/firestore_v1beta1/classes.rb', line 1817

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) 


1823
1824
1825
 
# File 'generated/google/apis/firestore_v1beta1/classes.rb', line 1823

def offset
  @offset
end

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



1837
1838
1839
 
# File 'generated/google/apis/firestore_v1beta1/classes.rb', line 1837

def order_by
  @order_by
end

#select ⇒ Google::Apis::FirestoreV1beta1::Projection

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

Returns:



1842
1843
1844
 
# File 'generated/google/apis/firestore_v1beta1/classes.rb', line 1842

def select
  @select
end

#start_at ⇒ Google::Apis::FirestoreV1beta1::Cursor

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

Returns:



1847
1848
1849
 
# File 'generated/google/apis/firestore_v1beta1/classes.rb', line 1847

def start_at
  @start_at
end

#where ⇒ Google::Apis::FirestoreV1beta1::Filter

A filter. Corresponds to the JSON property where

Returns:



1852
1853
1854
 
# File 'generated/google/apis/firestore_v1beta1/classes.rb', line 1852

def where
  @where
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
 
# File 'generated/google/apis/firestore_v1beta1/classes.rb', line 1859

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