Cloud Firestore Python Client

The library uses standard Python logging to log RPC events. By default, logging events are not handled and must be explicitly configured.

Important Notes:

• Logs may contain sensitive information; restrict access if saving logs.
• Do not depend on the immutability of log messages or levels.
• By default, logging events do not propagate to the root logger. To enable propagation, set logging.getLogger("google").propagate = True.

Install the google-cloud-firestore library within a virtual environment to avoid dependency conflicts.

Supported Python Versions:

• Python >= 3.7 (including 3.14)
• Python <= 3.6 is unsupported.

Note: This repository is archived. The project has moved to google-cloud-python.

### Mac/Linux
python3 -m venv <your-env>
source <your-env>/bin/activate
pip install google-cloud-firestore

### Windows
py -m venv <your-env>
.\<your-env>\Scripts\activate
pip install google-cloud-firestore

Before using the Python client, complete these prerequisite steps in the Google Cloud Console:

1. Select or create a Cloud Platform project.
2. Enable billing for your project.
3. Enable the Cloud Firestore API.
4. Set up Authentication.

You can enable logging without changing your code by setting the GOOGLE_SDK_PYTHON_LOGGING_SCOPE environment variable. This configures a default handler for events at logging.DEBUG or higher, emitting them in a structured format.

A logging scope is a period-separated namespace starting with google (e.g., google, google.cloud.firestore).

# Enabling the default handler for all Google-based loggers
export GOOGLE_SDK_PYTHON_LOGGING_SCOPE=google

# Enabling the default handler for a specific Google module
export GOOGLE_SDK_PYTHON_LOGGING_SCOPE=google.cloud.library_v1

Use Python's standard logging module to configure handlers for specific Google modules or the entire google namespace.

import logging
from google.cloud import library_v1

# Configuring a handler for all Google-based loggers
base_logger = logging.getLogger("google")
base_logger.addHandler(logging.StreamHandler())
base_logger.setLevel(logging.DEBUG)

# Configuring a handler for a specific Google module
module_logger = logging.getLogger("google.cloud.library_v1")
module_logger.addHandler(logging.StreamHandler())
module_logger.setLevel(logging.DEBUG)