A CollectionReference object can be used for adding documents, getting document references, and querying for documents (using the methods inherited from Query).

Firestore represents a Firestore Database and is the entry point for all Firestore operations.

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 the data property or by using subscript syntax to access a specific field.

For a DocumentSnapshot that points to a non-existing document, any data access will return nil. You can use the exists property to explicitly verify a documents existence.

Transaction provides methods to read and write data within a transaction.

A write batch is used to perform multiple writes as a single atomic unit.

A WriteBatch object can be acquired by calling Firestore.batch(). It provides methods for adding writes to the write batch. None of the writes will be committed (or visible locally) until WriteBatch.commit() is called.

Unlike transactions, write batches are persisted offline and therefore are preferable when you don’t need to condition your writes on read data.

Sentinel values that can be used when writing document fields with setData() or updateData().

Represents an aggregation that can be performed by Firestore.

A query that calculates aggregations over an underlying query.

The results of executing an AggregateQuery.

A DocumentChange represents a change to the documents matching a query. It contains the document affected and the type of change that occurred (added, modified, or removed).

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 the data property or by using subscript syntax to access a specific field.

A QueryDocumentSnapshot offers the same API surface as a DocumentSnapshot. As deleted documents are not returned from queries, its exists property will always be true and data() will never return nil.

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 Query.

Settings used to configure a Firestore instance.

An immutable object representing a geographical point in Firestore. The point is represented as a latitude/longitude pair.

Latitude values are in the range of [-90, 90]. Longitude values are in the range of [-180, 180].

Represents a progress update or a final state from loading bundles.

Represents the task of loading a Firestore bundle. Observers can be registered with this task to observe the bundle loading progress, as well as task completion and error events.

Configures the SDK to use a persistent cache. Firestore documents and mutations are persisted across App restart.

This is the default cache type unless explicitly specified otherwise.

To use, create an instance using one of the initializers, then set the instance to FirestoreSettings.cacheSettings, and use FirestoreSettings instance to configure Firestore SDK.

Configures the SDK to use an eager garbage collector for memory cache.

Once configured, the SDK will remove any Firestore documents from memory as soon as they are not used by any active queries.

To use, create an instance using the initializer, then initialize MemoryCacheSettings with this instance. This is the default garbage collector, so alternatively you can use the default initializer of MemoryCacheSettings.

Configures the SDK to use a least-recently-used garbage collector for memory cache.

Once configured, the SDK will attempt to remove documents that are least recently used in batches, if the current cache size is larger than the given target cache size. Default cache size is 100MB.

To use, create an instance using one of the initializers, then initialize MemoryCacheSettings with this instance.

Configures the SDK to use a memory cache. Firestore documents and mutations are NOT persisted across App restart.

To use, create an instance using one of the initializer, then set the instance to FirestoreSettings.cacheSettings, and use FirestoreSettings instance to configure Firestore SDK.

Undocumented

Undocumented

Undocumented

Undocumented

Undocumented

Undocumented

Undocumented

Undocumented

Undocumented

Undocumented

Undocumented

Undocumented

Undocumented

Undocumented

Undocumented

Undocumented

Undocumented

Undocumented

Undocumented

Undocumented

Undocumented

Undocumented

Undocumented

Undocumented

Undocumented

Undocumented

Undocumented

Undocumented

Undocumented

Undocumented

Undocumented

Undocumented

Undocumented

A Query refers to a query which you can read or listen to. You can also construct refined Query objects by adding filters and ordering.

A QuerySnapshot contains zero or more DocumentSnapshot objects. It can be enumerated using the documents property and its size can be inspected with isEmpty and count.

Options to configure the behavior of Firestore.addSnapshotListenerWithOptions(). Instances of this class control settings like whether metadata-only changes trigger events and the preferred data source.

Metadata about a snapshot, describing the state of the snapshot.

Options to customize the behavior of Firestore.runTransactionWithOptions().

Represents an aggregate function in a pipeline.

An AggregateFunction is a function that computes a single value from a set of input values.

AggregateFunctions are typically used in the aggregate stage of a pipeline.

Represents an aggregation that counts all documents in the input set.

CountAll is used within the aggregate pipeline stage to get the total number of documents that match the query criteria up to that point.

Example usage:

// Count all books in the collection
firestore.pipeline()
  .collection("books")
  .aggregate([
    CountAll().as("totalBooks")
  ])

// Count all sci-fi books published after 1960
firestore.pipeline()
  .collection("books")
  .where(Field("genre").equal("Science Fiction") && Field("published").greaterThan(1960))
  .aggregate([
    CountAll().as("sciFiBooksCount")
  ])

An expression that represents an array of values.

ArrayExpression is used to construct an array from a list of Sendable values, which can include literals (like numbers and strings) as well as other Expression instances. This allows for the creation of dynamic arrays within a pipeline.

Example:

ArrayExpression([
  1,
  2,
  Field("genre"),
  Field("rating").multiply(10),
  ArrayExpression([Field("title")]),
  MapExpression(["published": Field("published")]),
]).as("metadataArray")

A ConditionalExpression is a FunctionExpression that evaluates to one of two expressions based on a boolean condition.

This is equivalent to a ternary operator (condition ? then : else).

Example of using ConditionalExpression:

// Create a new field "status" based on the "rating" field.
// If rating > 4.5, status is "top_rated", otherwise "regular".
firestore.pipeline()
  .collection("products")
  .addFields([
    ConditionalExpression(
      Field("rating").greaterThan(4.5),
      then: Constant("top_rated"),
      else: Constant("regular")
    ).as("status")
  ])

An expression that represents a server-side timestamp.

CurrentTimestamp is used to generate a timestamp on the server. This is useful for recording current date and time.

Example:

CurrentTimestamp().as("createdAt")

An expression that produces an error with a custom error message. This is primarily used for debugging purposes.

Example:

ErrorExpression("This is a custom error message").as("errorResult")

Represents a function call in a pipeline.

A FunctionExpression is an expression that represents a function call with a given name and arguments.

FunctionExpressions are typically used to perform operations on data in a pipeline, such as mathematical calculations, string manipulations, or array operations.

An expression that represents a map (or dictionary) of key-value pairs.

MapExpression is used to construct a map from a dictionary of String keys and Sendable values. The values can be literals (like numbers and strings) or other Expression instances, allowing for the creation of dynamic nested objects within a pipeline.

Example:

MapExpression([
  "genre": Field("genre"),
  "rating": Field("rating").multiply(10),
  "nestedArray": ArrayExpression([Field("title")]),
  "nestedMap": MapExpression(["published": Field("published")]),
]).as("metadata")