firebase_admin.firestore_async module

Cloud Firestore Async module.

This module contains utilities for asynchronusly accessing the Google Cloud Firestore databasesassociated with Firebase apps. This requires thegoogle-cloud-firestore Python module.

Functions

client

firebase_admin.firestore_async.client(app:App|None=None,database_id:str|None=None)→AsyncClient

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:

AFirestore Async Client.

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.

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2024-11-07 UTC.