StructuredQuery

google.firestore.v1beta1. StructuredQuery

Represents a StructuredQuery.

Constructor

new StructuredQuery(propertiesopt)

Constructs a new StructuredQuery.

Parameters:
Name Type Attributes Description
properties google.firestore.v1beta1.IStructuredQuery <optional>

Properties to set

Implements:
  • IStructuredQuery

Classes

CollectionSelector
CompositeFilter
FieldFilter
FieldReference
Filter
Order
Projection
UnaryFilter

Members

(static) Direction :string

Direction enum.

Properties:
Name Type Description
DIRECTION_UNSPECIFIED string

DIRECTION_UNSPECIFIED value

ASCENDING string

ASCENDING value

DESCENDING string

DESCENDING value

endAt :google.firestore.v1beta1.ICursor|null|undefined

StructuredQuery endAt.

from :Array.<google.firestore.v1beta1.StructuredQuery.ICollectionSelector>

StructuredQuery from.

limit :google.protobuf.IInt32Value|null|undefined

StructuredQuery limit.

offset :number

StructuredQuery offset.

orderBy :Array.<google.firestore.v1beta1.StructuredQuery.IOrder>

StructuredQuery orderBy.

select :google.firestore.v1beta1.StructuredQuery.IProjection|null|undefined

StructuredQuery select.

startAt :google.firestore.v1beta1.ICursor|null|undefined

StructuredQuery startAt.

where :google.firestore.v1beta1.StructuredQuery.IFilter|null|undefined

StructuredQuery where.

Methods

(static) fromObject(object) → {google.firestore.v1beta1.StructuredQuery}

Creates a StructuredQuery message from a plain object. Also converts values to their respective internal types.

Parameters:
Name Type Description
object Object.<string, *>

Plain object

(static) toObject(message, optionsopt) → {Object.<string, *>}

Creates a plain object from a StructuredQuery message. Also converts values to other types if specified.

Parameters:
Name Type Attributes Description
message google.firestore.v1beta1.StructuredQuery

StructuredQuery

options $protobuf.IConversionOptions <optional>

Conversion options

toJSON() → {Object.<string, *>}

Converts this StructuredQuery to JSON.