`airflow.providers.google.cloud.operators.bigtable`¶

此模块包含 Google Cloud Bigtable 操作符。

模块内容¶

类¶

`BigtableValidationMixin`	用于验证所需字段的 Cloud Bigtable 操作符的通用类。
`BigtableCreateInstanceOperator`	创建一个新的 Cloud Bigtable 实例。
`BigtableUpdateInstanceOperator`	更新现有的 Cloud Bigtable 实例。
`BigtableDeleteInstanceOperator`	删除 Cloud Bigtable 实例，包括其集群和所有相关表。
`BigtableCreateTableOperator`	在 Cloud Bigtable 实例中创建表。
`BigtableDeleteTableOperator`	删除 Cloud Bigtable 表。
`BigtableUpdateClusterOperator`	更新 Cloud Bigtable 集群。

class airflow.providers.google.cloud.operators.bigtable.BigtableValidationMixin[源代码]¶

用于验证所需字段的 Cloud Bigtable 操作符的通用类。

REQUIRED_ATTRIBUTES: collections.abc.Iterable[str] = [][源代码]¶

class airflow.providers.google.cloud.operators.bigtable.BigtableCreateInstanceOperator(*, instance_id, main_cluster_id, main_cluster_zone, project_id=PROVIDE_PROJECT_ID, replica_clusters=None, instance_display_name=None, instance_type=None, instance_labels=None, cluster_nodes=None, cluster_storage_type=None, timeout=None, gcp_conn_id='google_cloud_default', impersonation_chain=None, **kwargs)[源代码]¶

基类：airflow.providers.google.cloud.operators.cloud_base.GoogleCloudBaseOperator，BigtableValidationMixin

创建一个新的 Cloud Bigtable 实例。

如果存在具有给定 ID 的 Cloud Bigtable 实例，则操作符不会比较其配置并立即成功。不会对现有实例进行任何更改。

有关实例创建的更多详细信息，请查看以下参考：https://googleapis.github.io/google-cloud-python/latest/bigtable/instance.html#google.cloud.bigtable.instance.Instance.create

另请参阅

有关如何使用此操作符的更多信息，请查看指南：BigtableCreateInstanceOperator

参数

instance_id (str) – 要创建的 Cloud Bigtable 实例的 ID。
main_cluster_id (str) – 新实例的主集群的 ID。
main_cluster_zone (str) – 主集群的区域。有关更多详细信息，请参阅 https://cloud.google.com/bigtable/docs/locations。
project_id (str) – （可选）Google Cloud 项目的 ID。如果设置为 None 或缺失，则使用来自 Google Cloud 连接的默认 project_id。
replica_clusters (list[dict[str, str]] | None) – （可选）新实例的副本集群列表。每个集群字典都包含一个 ID 和一个区域。例如：[{"id": "replica-1", "zone": "us-west1-a"}]
instance_type (google.cloud.bigtable.enums.Instance.Type | None) – （可选）实例的类型。
instance_display_name (str | None) – （可选）实例的人类可读名称。默认为 instance_id。
instance_labels (dict | None) – （可选）要与实例关联的标签字典。
cluster_nodes (int | None) – （可选）集群的节点数。
cluster_storage_type (google.cloud.bigtable.enums.StorageType | None) – （可选）存储类型。
timeout (float | None) – （可选）实例创建的超时时间（以秒为单位）。如果未指定 None，则操作符将无限期等待。
gcp_conn_id (str) – 用于连接到 Google Cloud 的连接 ID。
impersonation_chain (str | collections.abc.Sequence[str] | None) – 可选服务帐户，用于使用短期凭据模拟，或者用于获取列表中最后一个帐户的 access_token 的链式帐户列表，该帐户将在请求中被模拟。如果设置为字符串，则该帐户必须授予原始帐户“服务帐户令牌创建者”IAM 角色。如果设置为序列，则列表中的身份必须将“服务帐户令牌创建者”IAM 角色授予紧随其后的身份，列表中的第一个帐户将此角色授予原始帐户（已模板化）。

REQUIRED_ATTRIBUTES: collections.abc.Iterable[str] = ('instance_id', 'main_cluster_id', 'main_cluster_zone')[源代码]¶

template_fields: collections.abc.Sequence[str] = ('project_id', 'instance_id', 'main_cluster_id', 'main_cluster_zone', 'impersonation_chain')[source]¶

operator_extra_links = ()[source]¶

execute(context)[source]¶

在创建运算符时派生。

上下文是与渲染 Jinja 模板时使用的字典相同的字典。

有关更多上下文，请参阅 get_template_context。

class airflow.providers.google.cloud.operators.bigtable.BigtableUpdateInstanceOperator(*, instance_id, project_id=PROVIDE_PROJECT_ID, instance_display_name=None, instance_type=None, instance_labels=None, timeout=None, gcp_conn_id='google_cloud_default', impersonation_chain=None, **kwargs)[source]¶

基类：airflow.providers.google.cloud.operators.cloud_base.GoogleCloudBaseOperator，BigtableValidationMixin

更新现有的 Cloud Bigtable 实例。

有关实例创建的更多详细信息，请查看参考资料：https://googleapis.dev/python/bigtable/latest/instance.html#google.cloud.bigtable.instance.Instance.update

另请参阅

有关如何使用此运算符的更多信息，请查看指南：BigtableUpdateInstanceOperator

参数

instance_id (str) – 要更新的 Cloud Bigtable 实例的 ID。
project_id (str) – （可选）Google Cloud 项目的 ID。如果设置为 None 或缺失，则使用来自 Google Cloud 连接的默认 project_id。
instance_display_name (str | None) – (可选) 实例的人类可读名称。
instance_type (google.cloud.bigtable.enums.Instance.Type | enum.IntEnum | None) – (可选) 实例的类型。
instance_labels (dict | None) – （可选）要与实例关联的标签字典。
timeout (float | None) – (可选) 实例更新的超时时间（以秒为单位）。如果未指定 None，则运算符将无限期等待。
gcp_conn_id (str) – 用于连接到 Google Cloud 的连接 ID。
impersonation_chain (str | collections.abc.Sequence[str] | None) – 可选服务帐户，用于使用短期凭据模拟，或者用于获取列表中最后一个帐户的 access_token 的链式帐户列表，该帐户将在请求中被模拟。如果设置为字符串，则该帐户必须授予原始帐户“服务帐户令牌创建者”IAM 角色。如果设置为序列，则列表中的身份必须将“服务帐户令牌创建者”IAM 角色授予紧随其后的身份，列表中的第一个帐户将此角色授予原始帐户（已模板化）。

REQUIRED_ATTRIBUTES: collections.abc.Iterable[str] = ['instance_id'][source]¶

template_fields: collections.abc.Sequence[str] = ('project_id', 'instance_id', 'impersonation_chain')[source]¶

operator_extra_links = ()[source]¶

execute(context)[source]¶

在创建运算符时派生。

上下文是与渲染 Jinja 模板时使用的字典相同的字典。

有关更多上下文，请参阅 get_template_context。

class airflow.providers.google.cloud.operators.bigtable.BigtableDeleteInstanceOperator(*, instance_id, project_id=PROVIDE_PROJECT_ID, gcp_conn_id='google_cloud_default', impersonation_chain=None, **kwargs)[source]¶

基类：airflow.providers.google.cloud.operators.cloud_base.GoogleCloudBaseOperator，BigtableValidationMixin

删除 Cloud Bigtable 实例，包括其集群和所有相关表。

有关删除实例的更多详细信息，请查看参考资料：https://googleapis.github.io/google-cloud-python/latest/bigtable/instance.html#google.cloud.bigtable.instance.Instance.delete

另请参阅

有关如何使用此运算符的更多信息，请查看指南：BigtableDeleteInstanceOperator

参数

instance_id (str) – 要删除的 Cloud Bigtable 实例的 ID。
project_id (str) – （可选）Google Cloud 项目的 ID。如果设置为 None 或缺失，则使用来自 Google Cloud 连接的默认 project_id。
gcp_conn_id (str) – 用于连接到 Google Cloud 的连接 ID。
impersonation_chain (str | collections.abc.Sequence[str] | None) – 可选服务帐户，用于使用短期凭据模拟，或者用于获取列表中最后一个帐户的 access_token 的链式帐户列表，该帐户将在请求中被模拟。如果设置为字符串，则该帐户必须授予原始帐户“服务帐户令牌创建者”IAM 角色。如果设置为序列，则列表中的身份必须将“服务帐户令牌创建者”IAM 角色授予紧随其后的身份，列表中的第一个帐户将此角色授予原始帐户（已模板化）。

REQUIRED_ATTRIBUTES: collections.abc.Iterable[str] = ('instance_id',)[source]¶

template_fields: collections.abc.Sequence[str] = ('project_id', 'instance_id', 'impersonation_chain')[source]¶

execute(context)[source]¶

在创建运算符时派生。

上下文是与渲染 Jinja 模板时使用的字典相同的字典。

有关更多上下文，请参阅 get_template_context。

class airflow.providers.google.cloud.operators.bigtable.BigtableCreateTableOperator(*, instance_id, table_id, project_id=PROVIDE_PROJECT_ID, initial_split_keys=None, column_families=None, gcp_conn_id='google_cloud_default', impersonation_chain=None, **kwargs)[source]¶

基类：airflow.providers.google.cloud.operators.cloud_base.GoogleCloudBaseOperator，BigtableValidationMixin

在 Cloud Bigtable 实例中创建表。

有关创建表的更多详细信息，请查看以下参考链接：https://googleapis.github.io/google-cloud-python/latest/bigtable/table.html#google.cloud.bigtable.table.Table.create

另请参阅

有关如何使用此操作符的更多信息，请查看以下指南：BigtableCreateTableOperator

参数

instance_id (str) – 将保存新表的 Cloud Bigtable 实例的 ID。
table_id (str) – 要创建的表的 ID。
project_id (str) – （可选）Google Cloud 项目的 ID。如果设置为 None 或缺失，则使用来自 Google Cloud 连接的默认 project_id。
initial_split_keys (list | None) – （可选）字节形式的行键列表，用于最初将表拆分为多个平板。
column_families (dict[str, google.cloud.bigtable.column_family.GarbageCollectionRule] | None) – （可选）要创建的列的映射。键是 column_id 字符串，值是 google.cloud.bigtable.column_family.GarbageCollectionRule
gcp_conn_id (str) – 用于连接到 Google Cloud 的连接 ID。
impersonation_chain (str | collections.abc.Sequence[str] | None) – 可选服务帐户，用于使用短期凭据模拟，或者用于获取列表中最后一个帐户的 access_token 的链式帐户列表，该帐户将在请求中被模拟。如果设置为字符串，则该帐户必须授予原始帐户“服务帐户令牌创建者”IAM 角色。如果设置为序列，则列表中的身份必须将“服务帐户令牌创建者”IAM 角色授予紧随其后的身份，列表中的第一个帐户将此角色授予原始帐户（已模板化）。

REQUIRED_ATTRIBUTES: collections.abc.Iterable[str] = ('instance_id', 'table_id')[source]¶

template_fields: collections.abc.Sequence[str] = ('project_id', 'instance_id', 'table_id', 'impersonation_chain')[source]¶

operator_extra_links = ()[source]¶

execute(context)[source]¶

在创建运算符时派生。

上下文是与渲染 Jinja 模板时使用的字典相同的字典。

有关更多上下文，请参阅 get_template_context。

class airflow.providers.google.cloud.operators.bigtable.BigtableDeleteTableOperator(*, instance_id, table_id, project_id=PROVIDE_PROJECT_ID, app_profile_id=None, gcp_conn_id='google_cloud_default', impersonation_chain=None, **kwargs)[source]¶

基类：airflow.providers.google.cloud.operators.cloud_base.GoogleCloudBaseOperator，BigtableValidationMixin

删除 Cloud Bigtable 表。

有关删除表的更多详细信息，请查看以下参考链接：https://googleapis.github.io/google-cloud-python/latest/bigtable/table.html#google.cloud.bigtable.table.Table.delete

另请参阅

有关如何使用此操作符的更多信息，请查看以下指南：BigtableDeleteTableOperator

参数

instance_id (str) – Cloud Bigtable 实例的 ID。
table_id (str) – 要删除的表的 ID。
project_id (str) – （可选）Google Cloud 项目的 ID。如果设置为 None 或缺失，则使用来自 Google Cloud 连接的默认 project_id。
app_profile_id (str | None) – 应用程序配置文件。
gcp_conn_id (str) – 用于连接到 Google Cloud 的连接 ID。
impersonation_chain (str | collections.abc.Sequence[str] | None) – 可选服务帐户，用于使用短期凭据模拟，或者用于获取列表中最后一个帐户的 access_token 的链式帐户列表，该帐户将在请求中被模拟。如果设置为字符串，则该帐户必须授予原始帐户“服务帐户令牌创建者”IAM 角色。如果设置为序列，则列表中的身份必须将“服务帐户令牌创建者”IAM 角色授予紧随其后的身份，列表中的第一个帐户将此角色授予原始帐户（已模板化）。

REQUIRED_ATTRIBUTES: collections.abc.Iterable[str] = ('instance_id', 'table_id')[source]¶

template_fields: collections.abc.Sequence[str] = ('project_id', 'instance_id', 'table_id', 'impersonation_chain')[source]¶

execute(context)[source]¶

在创建运算符时派生。

上下文是与渲染 Jinja 模板时使用的字典相同的字典。

有关更多上下文，请参阅 get_template_context。

class airflow.providers.google.cloud.operators.bigtable.BigtableUpdateClusterOperator(*, instance_id, cluster_id, nodes, project_id=PROVIDE_PROJECT_ID, gcp_conn_id='google_cloud_default', impersonation_chain=None, **kwargs)[source]¶

基类：airflow.providers.google.cloud.operators.cloud_base.GoogleCloudBaseOperator，BigtableValidationMixin

更新 Cloud Bigtable 集群。

有关更新 Cloud Bigtable 集群的更多详细信息，请参阅以下参考资料：https://googleapis.github.io/google-cloud-python/latest/bigtable/cluster.html#google.cloud.bigtable.cluster.Cluster.update

另请参阅

有关如何使用此运算符的更多信息，请查看以下指南：BigtableUpdateClusterOperator

参数

instance_id (str) – Cloud Bigtable 实例的 ID。
cluster_id (str) – 要更新的 Cloud Bigtable 集群的 ID。
nodes (int) – Cloud Bigtable 集群所需的节点数量。
project_id (str) – 可选，Google Cloud 项目的 ID。
gcp_conn_id (str) – 用于连接到 Google Cloud 的连接 ID。
impersonation_chain (str | collections.abc.Sequence[str] | None) – 可选服务帐户，用于使用短期凭据模拟，或者用于获取列表中最后一个帐户的 access_token 的链式帐户列表，该帐户将在请求中被模拟。如果设置为字符串，则该帐户必须授予原始帐户“服务帐户令牌创建者”IAM 角色。如果设置为序列，则列表中的身份必须将“服务帐户令牌创建者”IAM 角色授予紧随其后的身份，列表中的第一个帐户将此角色授予原始帐户（已模板化）。

REQUIRED_ATTRIBUTES: collections.abc.Iterable[str] = ('instance_id', 'cluster_id', 'nodes')[source]¶

template_fields: collections.abc.Sequence[str] = ('project_id', 'instance_id', 'cluster_id', 'nodes', 'impersonation_chain')[source]¶

operator_extra_links = ()[source]¶

execute(context)[source]¶

在创建运算符时派生。

上下文是与渲染 Jinja 模板时使用的字典相同的字典。

有关更多上下文，请参阅 get_template_context。

airflow.providers.google.cloud.operators.bigtable¶

模块内容¶

类¶

`airflow.providers.google.cloud.operators.bigtable`¶