airflow.providers.google.firebase.hooks.firestore¶
Hook for Google Cloud Firestore service
Module Contents¶
-
class
airflow.providers.google.firebase.hooks.firestore.CloudFirestoreHook(api_version: str = 'v1', gcp_conn_id: str = 'google_cloud_default', delegate_to: Optional[str] = None, impersonation_chain: Optional[Union[str, Sequence[str]]] = None)[source]¶ Bases:
airflow.providers.google.common.hooks.base_google.GoogleBaseHookHook 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.
delegate_to (str) – The account to impersonate using domain-wide delegation of authority, if any. For this to work, the service account making the request must have domain-wide delegation enabled.
impersonation_chain (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.
-
get_conn(self)[source]¶ Retrieves the connection to Cloud Firestore.
- Returns
Google Cloud Firestore services object.
-
export_documents(self, body: Dict, database_id: str = '(default)', project_id: Optional[str] = None)[source]¶ Starts a export with the specified configuration.
- 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 (str) – Optional, Google Cloud Project project_id where the database belongs. If set to None or missing, the default project_id from the Google Cloud connection is used.