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

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



1867
1868
1869
 
# File 'lib/google/apis/firestore_v1beta1/classes.rb', line 1867

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:



1819
1820
1821
 
# File 'lib/google/apis/firestore_v1beta1/classes.rb', line 1819

def end_at
  @end_at
end

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

The collections to query. Corresponds to the JSON property from

Returns:



1824
1825
1826
 
# File 'lib/google/apis/firestore_v1beta1/classes.rb', line 1824

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) 


1830
1831
1832
 
# File 'lib/google/apis/firestore_v1beta1/classes.rb', line 1830

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) 


1836
1837
1838
 
# File 'lib/google/apis/firestore_v1beta1/classes.rb', line 1836

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:



1850
1851
1852
 
# File 'lib/google/apis/firestore_v1beta1/classes.rb', line 1850

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:



1855
1856
1857
 
# File 'lib/google/apis/firestore_v1beta1/classes.rb', line 1855

def select
  @select
end

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

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

Returns:



1860
1861
1862
 
# File 'lib/google/apis/firestore_v1beta1/classes.rb', line 1860

def start_at
  @start_at
end

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

A filter. Corresponds to the JSON property where

Returns:



1865
1866
1867
 
# File 'lib/google/apis/firestore_v1beta1/classes.rb', line 1865

def where
  @where
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
 
# File 'lib/google/apis/firestore_v1beta1/classes.rb', line 1872

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