This is an automated email from the ASF dual-hosted git repository.
shahar pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/airflow.git
The following commit(s) were added to refs/heads/main by this push:
new dc812411582 Improve Bigtable operator documentation (#61277)
dc812411582 is described below
commit dc8124115825dbb4d7b19d786d0adfc15c5884db
Author: sawantbandita <[email protected]>
AuthorDate: Sat Jan 31 23:38:48 2026 +0530
Improve Bigtable operator documentation (#61277)
---
providers/google/docs/operators/cloud/bigtable.rst | 38 ++++++++++++++++++++--
1 file changed, 36 insertions(+), 2 deletions(-)
diff --git a/providers/google/docs/operators/cloud/bigtable.rst
b/providers/google/docs/operators/cloud/bigtable.rst
index d93c05dd09e..2d57b720766 100644
--- a/providers/google/docs/operators/cloud/bigtable.rst
+++ b/providers/google/docs/operators/cloud/bigtable.rst
@@ -33,6 +33,11 @@ BigtableCreateInstanceOperator
Use the
:class:`~airflow.providers.google.cloud.operators.bigtable.BigtableCreateInstanceOperator`
to create a Google Cloud Bigtable instance.
+This operator provisions a Bigtable instance along with one or more clusters.
+It is typically used during environment setup or infrastructure provisioning
+before running tasks that depend on Bigtable.
+
+
If the Cloud Bigtable instance with the given ID exists, the operator does not
compare its configuration
and immediately succeeds. No changes are made to the existing instance.
@@ -56,6 +61,10 @@ BigtableUpdateInstanceOperator
Use the
:class:`~airflow.providers.google.cloud.operators.bigtable.BigtableUpdateInstanceOperator`
to update an existing Google Cloud Bigtable instance.
+This operator allows modifying instance properties such as display name,
+instance type, and labels without recreating the instance. It is useful
+for configuration updates while keeping the existing data and clusters intact.
+
Only the following configuration can be updated for an existing instance:
instance_display_name, instance_type and instance_labels.
@@ -79,6 +88,11 @@ BigtableDeleteInstanceOperator
Use the
:class:`~airflow.providers.google.cloud.operators.bigtable.BigtableDeleteInstanceOperator`
to delete a Google Cloud Bigtable instance.
+This operator permanently removes a Bigtable instance and all associated
+clusters and tables. Use it carefully, typically during cleanup or
+infrastructure teardown tasks.
+
+
Using the operator
""""""""""""""""""
@@ -99,6 +113,11 @@ BigtableUpdateClusterOperator
Use the
:class:`~airflow.providers.google.cloud.operators.bigtable.BigtableUpdateClusterOperator`
to modify number of nodes in a Cloud Bigtable cluster.
+This operator updates the size of an existing cluster by increasing or
+decreasing the number of nodes. It helps scale Bigtable capacity up or down
+based on workload requirements.
+
+
Using the operator
""""""""""""""""""
@@ -116,10 +135,16 @@ it will be retrieved from the Google Cloud connection
used. Both variants are sh
BigtableCreateTableOperator
-----------------------------
-Creates a table in a Cloud Bigtable instance.
+Use the
:class:`~airflow.providers.google.cloud.operators.bigtable.BigtableCreateTableOperator`
+to create a table in a Cloud Bigtable instance.
+
+This operator creates a new table with specified column families and optional
+split keys. It is typically used when initializing schema or preparing storage
+for application data.
+
If the table with given ID exists in the Cloud Bigtable instance, the operator
compares the Column Families.
-If the Column Families are identical operator succeeds. Otherwise, the
operator fails with the appropriate
+If the Column Families are identical, the operator succeeds. Otherwise, the
operator fails with the appropriate
error message.
@@ -151,6 +176,10 @@ BigtableDeleteTableOperator
Use the
:class:`~airflow.providers.google.cloud.operators.bigtable.BigtableDeleteTableOperator`
to delete a table in Google Cloud Bigtable.
+This operator removes a table from an instance. It is commonly used for
+cleanup tasks or when decommissioning unused datasets.
+
+
Using the operator
""""""""""""""""""
@@ -174,6 +203,11 @@ it will be retrieved from the Google Cloud connection
used. Both variants are sh
Use the
:class:`~airflow.providers.google.cloud.sensors.bigtable.BigtableTableReplicationCompletedSensor`
to wait for the table to replicate fully.
+This sensor periodically checks the replication status and blocks execution
+until replication is complete. It is useful in workflows that depend on data
+being fully available across clusters.
+
+
The same arguments apply to this sensor as the BigtableCreateTableOperator.
**Note:** If the table or the Cloud Bigtable instance does not exist, this
sensor waits for the table until
