airflow.providers.google.firebase.hooks.firestore¶
Google Cloud Firestore 服务的 Hook。
模块内容¶
类¶
用于 Google Firestore API 的 Hook。 |
属性¶
- class airflow.providers.google.firebase.hooks.firestore.CloudFirestoreHook(api_version='v1', gcp_conn_id='google_cloud_default', impersonation_chain=None)[源代码]¶
基类:
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 所需的链式帐户列表，该帐户将在请求中被模拟。如果设置为字符串，则该帐户必须授予原始帐户“服务帐户令牌创建者”IAM 角色。如果设置为序列，则列表中标识必须将“服务帐户令牌创建者”IAM 角色授予紧接其之前的标识，并且列表中的第一个帐户必须将此角色授予原始帐户。
- export_documents(body, database_id='(default)', project_id=PROVIDE_PROJECT_ID)[源代码]¶
使用指定的配置开始导出。
- 参数
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。