This module contains utilities for asynchronusly accessing the Google Cloud Firestore databases
associated with Firebase apps. This requires the google-cloud-firestore Python module.
Returns an async 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).
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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-11-07 UTC."],[],[],null,["# firebase_admin.firestore_async module\n\nCloud Firestore Async module.\n\nThis module contains utilities for asynchronusly accessing the Google Cloud Firestore databases\nassociated with Firebase apps. This requires the google-cloud-firestore Python module.\n\nFunctions\n---------\n\n| ### client firebase_admin.firestore_async.client(*app: [App](/docs/reference/admin/python/firebase_admin#firebase_admin.App \"firebase_admin.App\") \\| None = None* , *database_id: str \\| None = None* ) → AsyncClient |\n|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| Returns an async 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 Async Client](https://cloud.google.com/python/docs/reference/firestore/latest/google.cloud.firestore_v1.async_client.AsyncClient). Return type: : google.cloud.firestore.Firestore_Async 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. |"]]
