Cloud Firestore module.
This module contains utilities for accessing the Google Cloud Firestore databases associated with
Firebase apps. This requires the google-cloud-firestore
Python module.
Functions
clientfirebase_admin.firestore.client(app: App | None = None, database_id: str | None = None) → Client |
---|
Returns a client that can be used to interact with Google Cloud Firestore.
- Parameters:
app – An App instance (optional).
database_id – The database ID of the Google Cloud Firestore database to be used.
Defaults to the default Firestore database ID if not specified or an empty string
(optional).
- Returns:
A Firestore Client.
- Return type:
google.cloud.firestore.Firestore
- Raises:
ValueError – If the specified database ID is not a valid string, or if a project ID is not
specified either via options, credentials or environment variables, or if the specified
project ID is not a valid string.
|