firebase_admin.firestore module

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

firebase_admin.firestore.client(app=None)

Returns a client that can be used to interact with Google Cloud Firestore.

Parameters:app – An App instance (optional).
Returns:A Firestore Client.
Return type:google.cloud.firestore.Firestore
Raises:ValueError – 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.

Send feedback about...

Need help? Visit our support page.