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

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



2467
2468
2469
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 2467

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:



2419
2420
2421
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 2419

def end_at
  @end_at
end

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

The collections to query. Corresponds to the JSON property from

Returns:



2424
2425
2426
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 2424

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) 


2430
2431
2432
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 2430

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) 


2436
2437
2438
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 2436

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:



2450
2451
2452
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 2450

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:



2455
2456
2457
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 2455

def select
  @select
end

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

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

Returns:



2460
2461
2462
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 2460

def start_at
  @start_at
end

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

A filter. Corresponds to the JSON property where

Returns:



2465
2466
2467
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 2465

def where
  @where
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 2472

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