Cloud Firestore V1 API - Class Google::Cloud::Firestore::V1::StructuredQuery (v0.7.1)

Version 0.7.1

• 1.2.0 (latest)
• 1.1.1
• 1.0.0
• 0.14.0
• 0.13.0
• 0.12.0
• 0.11.1
• 0.10.0
• 0.9.0
• 0.8.0
• 0.7.1
• 0.6.0
• 0.5.0
• 0.4.8

Reference documentation and code samples for the Cloud Firestore V1 API class Google::Cloud::Firestore::V1::StructuredQuery.

A Firestore query.

Inherits

• Object

Extended By

• Google::Protobuf::MessageExts::ClassMethods

Includes

• Google::Protobuf::MessageExts

Methods

#end_at

def end_at() -> ::Google::Cloud::Firestore::V1::Cursor

Returns

• (::Google::Cloud::Firestore::V1::Cursor) — A end point for the query results.

#end_at=

def end_at=(value) -> ::Google::Cloud::Firestore::V1::Cursor

Parameter

• value (::Google::Cloud::Firestore::V1::Cursor) — A end point for the query results.

Returns

• (::Google::Cloud::Firestore::V1::Cursor) — A end point for the query results.

#from

def from() -> ::Array<::Google::Cloud::Firestore::V1::StructuredQuery::CollectionSelector>

Returns

• (::Array<::Google::Cloud::Firestore::V1::StructuredQuery::CollectionSelector>) — The collections to query.

#from=

def from=(value) -> ::Array<::Google::Cloud::Firestore::V1::StructuredQuery::CollectionSelector>

Parameter

• value (::Array<::Google::Cloud::Firestore::V1::StructuredQuery::CollectionSelector>) — The collections to query.

Returns

• (::Array<::Google::Cloud::Firestore::V1::StructuredQuery::CollectionSelector>) — The collections to query.

#limit

def limit() -> ::Google::Protobuf::Int32Value

Returns

• (::Google::Protobuf::Int32Value) — The maximum number of results to return.

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

#limit=

def limit=(value) -> ::Google::Protobuf::Int32Value

Parameter

• value (::Google::Protobuf::Int32Value) — 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.

#offset

def offset() -> ::Integer

Returns

• (::Integer) — The number of results to skip.

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

#offset=

def offset=(value) -> ::Integer

Parameter

• value (::Integer) — 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.

#order_by

def order_by() -> ::Array<::Google::Cloud::Firestore::V1::StructuredQuery::Order>

Returns

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

  The order to apply to the query results.

  Firestore allows callers to provide a full ordering, a partial ordering, or no ordering at all. In all cases, Firestore guarantees a stable ordering through the following rules:

  • The order_by is required to reference all fields used with an inequality filter.
  • All fields that are required to be in the order_by but are not already present are appended in lexicographical ordering of the field name.
  • 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:

  • ORDER BY a becomes ORDER BY a ASC, __name__ ASC
  • ORDER BY a DESC becomes ORDER BY a DESC, __name__ DESC
  • WHERE a > 1 becomes WHERE a > 1 ORDER BY a ASC, __name__ ASC
  • WHERE __name__ > ... AND a > 1 becomes WHERE __name__ > ... AND a > 1 ORDER BY a ASC, __name__ ASC

#order_by=

def order_by=(value) -> ::Array<::Google::Cloud::Firestore::V1::StructuredQuery::Order>

Parameter

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

  The order to apply to the query results.

  Firestore allows callers to provide a full ordering, a partial ordering, or no ordering at all. In all cases, Firestore guarantees a stable ordering through the following rules:

  • The order_by is required to reference all fields used with an inequality filter.
  • All fields that are required to be in the order_by but are not already present are appended in lexicographical ordering of the field name.
  • 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:

  • ORDER BY a becomes ORDER BY a ASC, __name__ ASC
  • ORDER BY a DESC becomes ORDER BY a DESC, __name__ DESC
  • WHERE a > 1 becomes WHERE a > 1 ORDER BY a ASC, __name__ ASC
  • WHERE __name__ > ... AND a > 1 becomes WHERE __name__ > ... AND a > 1 ORDER BY a ASC, __name__ ASC

Returns

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

  The order to apply to the query results.

  Firestore allows callers to provide a full ordering, a partial ordering, or no ordering at all. In all cases, Firestore guarantees a stable ordering through the following rules:

  • The order_by is required to reference all fields used with an inequality filter.
  • All fields that are required to be in the order_by but are not already present are appended in lexicographical ordering of the field name.
  • 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:

  • ORDER BY a becomes ORDER BY a ASC, __name__ ASC
  • ORDER BY a DESC becomes ORDER BY a DESC, __name__ DESC
  • WHERE a > 1 becomes WHERE a > 1 ORDER BY a ASC, __name__ ASC
  • WHERE __name__ > ... AND a > 1 becomes WHERE __name__ > ... AND a > 1 ORDER BY a ASC, __name__ ASC

#select

def select() -> ::Google::Cloud::Firestore::V1::StructuredQuery::Projection

Returns

• (::Google::Cloud::Firestore::V1::StructuredQuery::Projection) — The projection to return.

#select=

def select=(value) -> ::Google::Cloud::Firestore::V1::StructuredQuery::Projection

Parameter

• value (::Google::Cloud::Firestore::V1::StructuredQuery::Projection) — The projection to return.

Returns

• (::Google::Cloud::Firestore::V1::StructuredQuery::Projection) — The projection to return.

#start_at

def start_at() -> ::Google::Cloud::Firestore::V1::Cursor

Returns

• (::Google::Cloud::Firestore::V1::Cursor) — A starting point for the query results.

#start_at=

def start_at=(value) -> ::Google::Cloud::Firestore::V1::Cursor

Parameter

• value (::Google::Cloud::Firestore::V1::Cursor) — A starting point for the query results.

Returns

• (::Google::Cloud::Firestore::V1::Cursor) — A starting point for the query results.

#where

def where() -> ::Google::Cloud::Firestore::V1::StructuredQuery::Filter

Returns

• (::Google::Cloud::Firestore::V1::StructuredQuery::Filter) — The filter to apply.

#where=

def where=(value) -> ::Google::Cloud::Firestore::V1::StructuredQuery::Filter

Parameter

• value (::Google::Cloud::Firestore::V1::StructuredQuery::Filter) — The filter to apply.

Returns

• (::Google::Cloud::Firestore::V1::StructuredQuery::Filter) — The filter to apply.