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')[原始碼]
execute(context)[原始碼]

在建立運算子時衍生。

Context 是與呈現 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)[原始碼]

基底類別: 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'][原始碼]
template_fields: collections.abc.Sequence[str] = ('project_id', 'instance_id', 'impersonation_chain')[原始碼]
execute(context)[原始碼]

在建立運算子時衍生。

Context 是與呈現 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)[原始碼]

基底類別: 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',)[原始碼]
template_fields: collections.abc.Sequence[str] = ('project_id', 'instance_id', 'impersonation_chain')[原始碼]
execute(context)[原始碼]

在建立運算子時衍生。

Context 是與呈現 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)[原始碼]

基底類別: 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) – (選用) 要建立的資料行對應。key 是 column_id 字串,value 是 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')[原始碼]
template_fields: collections.abc.Sequence[str] = ('project_id', 'instance_id', 'table_id', 'impersonation_chain')[原始碼]
execute(context)[原始碼]

在建立運算子時衍生。

Context 是與呈現 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)[原始碼]

基底類別: 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')[原始碼]
template_fields: collections.abc.Sequence[str] = ('project_id', 'instance_id', 'table_id', 'impersonation_chain')[原始碼]
execute(context)[source]

在建立運算子時衍生。

Context 是與呈現 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]
execute(context)[source]

在建立運算子時衍生。

Context 是與呈現 Jinja 範本時使用的相同字典。

請參閱 get_template_context 以取得更多上下文。

這個項目有幫助嗎?