Reference API documentation for google-cloud-firestore.
Packages
types
API documentation for firestore_v1.types package.
Modules
client
API documentation for firestore_admin_v1.services.firestore_admin.client module.
bundle
Classes for representing bundles for the Google Cloud Firestore API.
async_batch
Helpers for batch requests to the Google Cloud Firestore API.
async_client
Client for interacting with the Google Cloud Firestore API.
This is the base from which all interactions with the API occur.
In the hierarchy of API concepts
- a Client owns a AsyncCollectionReference
- a Client owns a AsyncDocumentReference
async_collection
Classes for representing collections for the Google Cloud Firestore API.
async_document
Classes for representing documents for the Google Cloud Firestore API.
async_query
Classes for representing queries for the Google Cloud Firestore API.
A Query can be created directly from a Collection and that can be a more common way to create a query than direct usage of the constructor.
async_transaction
Helpers for applying Google Cloud Firestore changes in a transaction.
base_batch
Helpers for batch requests to the Google Cloud Firestore API.
base_client
Client for interacting with the Google Cloud Firestore API.
This is the base from which all interactions with the API occur.
In the hierarchy of API concepts
- a Client owns a CollectionReference
- a Client owns a DocumentReference
base_collection
Classes for representing collections for the Google Cloud Firestore API.
base_document
Classes for representing documents for the Google Cloud Firestore API.
base_query
Classes for representing queries for the Google Cloud Firestore API.
A Query can be created directly from a Collection and that can be a more common way to create a query than direct usage of the constructor.
base_transaction
Helpers for applying Google Cloud Firestore changes in a transaction.
batch
Helpers for batch requests to the Google Cloud Firestore API.
client
Client for interacting with the Google Cloud Firestore API.
This is the base from which all interactions with the API occur.
In the hierarchy of API concepts
- a Client owns a CollectionReference
- a Client owns a DocumentReference
collection
Classes for representing collections for the Google Cloud Firestore API.
document
Classes for representing documents for the Google Cloud Firestore API.
field_path
Utilities for managing / converting field paths to / from strings.
query
Classes for representing queries for the Google Cloud Firestore API.
A Query can be created directly from a Collection and that can be a more common way to create a query than direct usage of the constructor.
transaction
Helpers for applying Google Cloud Firestore changes in a transaction.
transforms
Helpful constants to use for Google Cloud Firestore.