# Packages
Package firestore is an auto-generated package for the Google Cloud Firestore API.
No description provided by the author
# Functions
ArrayRemove specifies elements to be removed from whatever array already exists in the server.
ArrayUnion specifies elements to be added to whatever array already exists in the server, or to create an array if no value exists.
LastUpdateTime returns a Precondition that checks that a resource must exist and must have last been updated at the given time.
MaxAttempts is a TransactionOption that configures the maximum number of times to try a transaction.
Merge returns a SetOption that causes only the given field paths to be overwritten.
NewClient creates a new Firestore client that uses the given project.
# Constants
Asc sorts results from smallest to largest.
DefaultTransactionMaxAttempts is the default number of times to attempt a transaction.
Delete is used as a value in a call to Update or Set with merge to indicate that the corresponding key should be deleted.
Desc sorts results from largest to smallest.
DocumentAdded indicates that the document was added for the first time.
DocumentID is the special field name representing the ID of a document in queries.
DocumentModified indicates that the document was modified.
DocumentRemoved indicates that the document was removed.
ServerTimestamp is used as a value in a call to Update to indicate that the key's value should be set to the time at which the server processed the request.
# Variables
Exists is a Precondition that checks for the existence of a resource before writing to it.
LogWatchStreams controls whether watch stream status changes are logged.
MergeAll is a SetOption that causes all the field paths given in the data argument to Set to be overwritten.
ReadOnly is a TransactionOption that makes the transaction read-only.
# Structs
A Client provides access to the Firestore service.
CollectionIterator is an iterator over sub-collections of a document.
A CollectionRef is a reference to Firestore collection.
A DocumentChange describes the change to a document from one query snapshot to the next.
DocumentIterator is an iterator over documents returned by a query.
A DocumentRef is a reference to a Firestore document.
A DocumentSnapshot contains document data and metadata.
DocumentSnapshotIterator is an iterator over snapshots of a document.
Query represents a Firestore query.
A QuerySnapshot is a snapshot of query results.
QuerySnapshotIterator is an iterator over snapshots of a query.
Transaction represents a Firestore transaction.
An Update describes an update to a value referred to by a path.
A WriteBatch holds multiple database updates.
A WriteResult is returned by methods that write documents.
# Interfaces
A Precondition modifies a Firestore update or delete operation.
A Queryer is a Query or a CollectionRef.
A SetOption modifies a Firestore set operation.
A TransactionOption is an option passed to Client.Transaction.
# Type aliases
Direction is the sort direction for result ordering.
DocumentChangeKind describes the kind of change to a document between query snapshots.
A FieldPath is a non-empty sequence of non-empty fields that reference a value.