airflow.providers.google.firebase.hooks.firestore¶

Google Cloud Firestore 服务的 Hook。

属性¶

TIME_TO_SLEEP_IN_SECONDS

类¶

CloudFirestoreHook

用于 Google Firestore API 的 Hook。

模块内容¶

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]¶

基类: airflow.providers.google.common.hooks.base_google.GoogleBaseHook

用于 Google Firestore API 的 Hook。

Hook 中所有使用 project_id 的方法都必须使用关键字参数调用，而不是位置参数。

参数:

api_version (str) – 使用的 API 版本（例如 v1 或 v1beta1）。
gcp_conn_id (str) – 获取连接信息时使用的连接 ID。
impersonation_chain (str | collections.abc.Sequence[str] | None) – 可选的服务账号，用于使用短期凭据进行模拟，或者获取列表中最后一个账号的 access_token 所需的账号链，该账号将在请求中被模拟。如果设置为字符串，该账号必须授予原始账号 Service Account Token Creator IAM 角色。如果设置为序列，列表中的身份必须向直接前一个身份授予 Service Account Token Creator IAM 角色，列表中第一个账号将此角色授予原始账号。

api_version = 'v1'[source]¶

get_conn()[source]¶

检索到 Cloud Firestore 的连接。

返回:: Google Cloud Firestore 服务对象。

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

使用指定的配置开始导出。

参数:

database_id (str) – 数据库 ID。
body (dict) – 请求体。参阅：https://firebase.google.com/docs/firestore/reference/rest/v1beta1/projects.databases/exportDocuments
project_id (str) – 可选，数据库所属的 Google Cloud Project 的 project_id。如果设置为 None 或缺失，将使用 Google Cloud 连接中的默认 project_id。