Package firestore is an auto-generated package for the Cloud Firestore API.

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.

FieldTransformIncrement returns a special value that can be used with Set, Create, or Update that tells the server to transform the field's current value by the given value.

FieldTransformMaximum returns a special value that can be used with Set, Create, or Update that tells the server to set the field to the maximum of the field's current value and the given value.

FieldTransformMinimum returns a special value that can be used with Set, Create, or Update that tells the server to set the field to the minimum of the field's current value and the given value.

Increment is an alias for FieldTransformIncrement.

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.

NewClientWithDatabase creates a new Firestore client that accesses the specified database.

Ptr returns a pointer to its argument.

ReadTime specifies a time-specific snapshot of the database to read.

WithCommitResponseTo returns a TransactionOption that specifies where the CommitResponse should be written on successful commit.

Asc sorts results from smallest to largest.

DefaultDatabaseID is name of the default database.

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.

DetectProjectID is a sentinel value that instructs NewClient to detect the project ID.

DistanceMeasureCosine compares vectors based on the angle between them, which allows you to measure similarity that isn't based on the vectors magnitude.

DistanceMeasureDotProduct is similar to cosine but is affected by the magnitude of the vectors.

DistanceMeasureEuclidean is used to measures the Euclidean distance between the vectors.

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.

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.

AggregationQuery allows for generating aggregation results of an underlying basic query.

AggregationResponse contains AggregationResult and response from the run options in the query.

AndFilter represents the intersection of two or more filters.

A BulkWriter supports concurrent writes to multiple documents.

BulkWriterJob provides read-only access to the results of a BulkWriter write attempt.

A Client provides access to the Firestore service.

A CollectionGroupRef is a reference to a group of collections sharing the same ID.

CollectionIterator is an iterator over sub-collections of a document.

A CollectionRef is a reference to Firestore collection.

CommitResponse exposes information about a committed transaction.

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.

DocumentRefIterator is an iterator over DocumentRefs.

A DocumentSnapshot contains document data and metadata.

DocumentSnapshotIterator is an iterator over snapshots of a document.

ExecutionStats represents execution statistics for the query.

ExplainMetrics represents explain metrics for the query.

ExplainOptions are Query Explain options.

FindNearestOptions are options for a FindNearest vector query.

OrFilter represents a union of two or more filters.

PlanSummary represents planning phase information for the query.

PropertyFilter represents a filter on single property.

PropertyPathFilter represents a filter on single property.

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.

VectorQuery represents a query that uses [Query.FindNearest] or [Query.FindNearestPath].

A WriteBatch holds multiple database updates.

A WriteResult is returned by methods that write documents.

CompositeFilter represents a composite Firestore filter.

EntityFilter represents a Firestore filter.

A Precondition modifies a Firestore update or delete operation.

A Queryer is a Query or a CollectionRef.

ReadOption interface allows for abstraction of computing read time settings.

RunOption are options used while running a query.

A SetOption modifies a Firestore set operation.

SimpleFilter represents a simple Firestore filter.

A TransactionOption is an option passed to Client.Transaction.

AggregationResult contains the results of an aggregation query.

Direction is the sort direction for result ordering.

DistanceMeasure is the distance measure to use when comparing vectors with [Query.FindNearest] or [Query.FindNearestPath].

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.

Vector32 is an embedding vector of float32s.

Vector64 is an embedding vector of float64s.