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

client firebase_admin.firestore.client(app=None) → Client
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.

client

firebase_admin.firestore.client(app=None) → Client

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.

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

Last updated 2024-01-23 UTC.