airflow.providers.google.firebase.hooks.firestore

Hook for Google Cloud Firestore service.

Module Contents

Classes

CloudFirestoreHook

Hook for the Google Firestore APIs.

Attributes

TIME_TO_SLEEP_IN_SECONDS

airflow.providers.google.firebase.hooks.firestore.TIME_TO_SLEEP_IN_SECONDS = 5[source]
class airflow.providers.google.firebase.hooks.firestore.CloudFirestoreHook(api_version='v1', gcp_conn_id='google_cloud_default', impersonation_chain=None)[source]

Bases: airflow.providers.google.common.hooks.base_google.GoogleBaseHook

Hook for the Google Firestore APIs.

All the methods in the hook where project_id is used must be called with keyword arguments rather than positional.

Parameters

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

  • gcp_conn_id (str) – The connection ID to use when fetching connection info.

  • impersonation_chain (str | collections.abc.Sequence[str] | None) – 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.

get_conn()[source]

Retrieve the connection to Cloud Firestore.

Returns

Google Cloud Firestore services object.

export_documents(body, database_id='(default)', project_id=PROVIDE_PROJECT_ID)[source]

Start a export with the specified configuration.

Parameters

Was this entry helpful?