airflow.providers.google.firebase.operators.firestore

Module Contents

Classes

CloudFirestoreExportDatabaseOperator

Exports a copy of all or a subset of documents from Google Cloud Firestore to another storage system,

class airflow.providers.google.firebase.operators.firestore.CloudFirestoreExportDatabaseOperator(*, body, database_id='(default)', project_id=None, gcp_conn_id='google_cloud_default', api_version='v1', impersonation_chain=None, **kwargs)[source]

Bases: airflow.models.BaseOperator

Exports a copy of all or a subset of documents from Google Cloud Firestore to another storage system, such as Google Cloud Storage.

See also

For more information on how to use this operator, take a look at the guide: Export database

Parameters
  • database_id (str) -- The Database ID.

  • body (Dict) -- The request body. See: https://firebase.google.com/docs/firestore/reference/rest/v1beta1/projects.databases/exportDocuments

  • project_id (Optional[str]) -- ID of the Google Cloud project if None then default project_id is used.

  • gcp_conn_id (str) -- The connection ID to use to connect to Google Cloud.

  • api_version (str) -- API version used (for example v1 or v1beta1).

  • impersonation_chain (Optional[Union[str, Sequence[str]]]) -- Optional service account to impersonate using short-term credentials, or chained list of accounts required to get the access_token of the last account in the list, which will be impersonated in the request. If set as a string, the account must grant the originating account the Service Account Token Creator IAM role. If set as a sequence, the identities from the list must grant Service Account Token Creator IAM role to the directly preceding identity, with first account from the list granting this role to the originating account (templated).

template_fields :Sequence[str] = ['body', 'gcp_conn_id', 'api_version', 'impersonation_chain'][source]
execute(self, context)[source]

This is the main method to derive when creating an operator. Context is the same dictionary used as when rendering jinja templates.

Refer to get_template_context for more context.

Was this entry helpful?