Export from Cloud Firestore to GCS

CloudQuery is an open-source data integration platform that allows you to export data from any source to any destination.

The CloudQuery Cloud Firestore plugin allows you to sync data from Cloud Firestore to any destination, including GCS. It's free, open source, requires no account, and takes only minutes to get started.

Ready? Let's dive right in!

Step 1. Install the CloudQuery CLI

The CloudQuery CLI is a command-line tool that runs the sync. It supports MacOS, Linux and Windows.

brew install cloudquery/tap/cloudquery

Step 2. Configure the Cloud Firestore source plugin

Create a configuration file for the Cloud Firestore plugin and set up authentication.

Configuration

Create a file called firestore.yaml and add the following contents:

kind: source
spec:
  # Source spec section
  name: firestore
  path: cloudquery/firestore
  version: "v1.0.2"
  tables: ["*"]
  destinations: ["gcs"]
  spec:
    # Firestore specific configuration goes here

Fine-tune this configuration to match your needs. For more information, see the Cloud Firestore Plugin ↗ page in the docs.

Authentication

The Firestore plugin authenticates using your Application Default Credentials (opens in a new tab). Available options are all the same options described here (opens in a new tab) in detail:

Local Environment:

gcloud auth application-default login (recommended when running locally)

Google Cloud cloud-based development environment:

When you run on Cloud Shell or Cloud Code credentials are already available.

Google Cloud containerized environment:

When running on GKE use workload identity (opens in a new tab).

Google Cloud services that support attaching a service account (opens in a new tab):

Services such as Compute Engine, App Engine and functions supporting attaching a user-managed service account which will CloudQuery will be able to utilize.

On-premises or another cloud provider

The suggested way is to use Workload identity federation (opens in a new tab)
If not available you can always use service account keys and export the location of the key via GOOGLE_APPLICATION_CREDENTIALS. Highly not recommended as long-lived keys are a security risk

Step 3. Configure the GCS destination plugin

Create a configuration file for the GCS plugin and set up authentication.

Configuration

Create a file called gcs.yaml and add the following contents:

This example configures a GCS destination, to create CSV files in gcs://bucket_name/path/to/files.

kind: destination
spec:
  name: "gcs"
  path: "cloudquery/gcs"
  version: "v3.2.0"
  write_mode: "append" # gcs only supports 'append' mode
  # batch_size: 10000 # optional
  # batch_size_bytes: 5242880 # optional
  spec:
    bucket: "bucket_name"
    path: "path/to/files"
    format: "csv"
    format_spec:
      delimiter: ","

Note that the GCS plugin only supports append write-mode. The (top level) spec section is described in the Destination Spec Reference.

Fine-tune this configuration to match your needs. For more information, see the GCS Plugin ↗ page in the docs.

Authentication

The GCS plugin authenticates using your Application Default Credentials (opens in a new tab). Available options are all the same options described here (opens in a new tab) in detail:

Local Environment:

gcloud auth application-default login (recommended when running locally)

Google Cloud cloud-based development environment:

When you run on Cloud Shell or Cloud Code credentials are already available.

Google Cloud containerized environment:

When running on GKE use workload identity (opens in a new tab).

Google Cloud services that support attaching a service account (opens in a new tab):

Services such as Compute Engine, App Engine and functions supporting attaching a user-managed service account which will CloudQuery will be able to utilize.

On-premises or another cloud provider

The suggested way is to use Workload identity federation (opens in a new tab)
If not available you can always use service account keys and export the location of the key via GOOGLE_APPLICATION_CREDENTIALS. (Not recommended as long-lived keys are a security risk)

Step 4. Start the Sync

Run the following command in your terminal to start the sync

cloudquery sync firestore.yaml gcs.yaml

And away we go! 🚀 The sync will run until completion, fetching all selected tables from Cloud Firestore. Any errors will be logged to a file called cloudquery.log.

Export from Cloud Firestore to GCS

Step 1. Install the CloudQuery CLI

Step 2. Configure the Cloud Firestore source plugin

Configuration

Authentication

Step 3. Configure the GCS destination plugin

Configuration

Authentication

Step 4. Start the Sync

Further Reading