A CollectionReference object can be used for adding documents, getting
document references, and querying for documents (using the methods
inherited from Query).
A DocumentReference refers to a document location in a Firestore database
and can be used to write, read, or listen to the location. The document at
the referenced location may or may not exist. A DocumentReference can
also be used to create a CollectionReference to a subcollection.
A DocumentSnapshot contains data read from a document in your Firestore
database. The data can be extracted with .data() or .get(<field>) to
get a specific field.
A FieldPath refers to a field in a document. The path may consist of a
single field name (referring to a top-level field in the document), or a
list of field names (referring to a nested field in the document).
A Filter represents a restriction on one or more field values and can
be used to refine the results of a {@link Query}.
Filterss are created by invoking {@link Filter#where}, {@link Filter#or},
or {@link Filter#and} and can then be passed to {@link Query#where}
to create a new {@link Query} instance that also contains this Filter.
An options object that configures conditional behavior of update() and
delete() calls in DocumentReference, WriteBatch, and Transaction.
Using Preconditions, these calls can be restricted to only apply to
documents that match the specified restrictions.
A QueryDocumentSnapshot contains data read from a document in your
Firestore database as part of a query. The document is guaranteed to exist
and its data can be extracted with .data() or .get(<field>) to get a
specific field.
A split point that can be used in a query as a starting and/or end point for
the query results. The cursors returned by {@link #startAt} and {@link
#endBefore} can only be used in a query that matches the constraint of query
that produced this partition.
A QuerySnapshot contains zero or more QueryDocumentSnapshot objects
representing the results of a query. The documents can be accessed as an
array via the docs property or enumerated using the forEach method. The
number of documents can be determined via the empty and size
properties.
An options object that can be used to configure the behavior of getAll()
calls. By providing a fieldMask, these calls can be configured to only
return a subset of fields.
An options object that configures the behavior of set() calls in
DocumentReference, WriteBatch and Transaction. These calls can be
configured to perform granular merges instead of overwriting the target
documents in their entirety.
An options object that configures the behavior of set() calls in
DocumentReference, WriteBatch and Transaction. These calls can be
configured to perform granular merges instead of overwriting the target
documents in their entirety.
A Timestamp represents a point in time independent of any time zone or
calendar, represented as seconds and fractions of seconds at nanosecond
resolution in UTC Epoch time. It is encoded using the Proleptic Gregorian
Calendar which extends the Gregorian calendar backwards to year one. It is
encoded assuming all minutes are 60 seconds long, i.e. leap seconds are
"smeared" so that no leap second table is needed for interpretation. Range
is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z.
A reference to a transaction.
The Transaction object passed to a transaction's updateFunction provides
the methods to read and write data within the transaction context. See
Firestore.runTransaction().
A VectorQuerySnapshot contains zero or more QueryDocumentSnapshot objects
representing the results of a query. The documents can be accessed as an
array via the docs property or enumerated using the forEach method. The
number of documents can be determined via the empty and size
properties.
