Google Cloud Firestore Operators¶

Cloud Firestore is a flexible, scalable database for mobile, web, and server development from Firebase and Google Cloud. Like Firebase Realtime Database, it keeps your data in sync across client apps through realtime listeners and offers offline support for mobile and web so you can build responsive apps that work regardless of network latency or Internet connectivity. Cloud Firestore also offers seamless integration with other Firebase and Google Cloud products, including Cloud Functions.

Prerequisite Tasks¶

To use these operators, you must do a few things:

Select or create a Cloud Platform project using the Cloud Console.

Enable billing for your project, as described in the Google Cloud documentation.

Enable the API, as described in the Cloud Console documentation.
Install API libraries via pip.
pip install 'apache-airflow[google]'
Detailed information is available for Installation.
Setup a Google Cloud Connection.

Export database¶

Exports a copy of all or a subset of documents from Google Cloud Firestore to Google Cloud Storage is performed with the CloudFirestoreExportDatabaseOperator operator.

tests/system/providers/google/cloud/gcs/example_firestore.py[source]

export_database_to_gcs = CloudFirestoreExportDatabaseOperator(
    task_id="export_database_to_gcs",
    project_id=PROJECT_ID,
    body={"outputUriPrefix": EXPORT_DESTINATION_URL, "collectionIds": [EXPORT_COLLECTION_ID]},
)

You can use Jinja templating with body, gcp_conn_id, api_version, impersonation_chain parameters which allows you to dynamically determine values.

Reference¶

For further information, look at: