diff --git a/docs/snippets.py b/docs/snippets.py index 32fdfcb24..dda59079d 100644 --- a/docs/snippets.py +++ b/docs/snippets.py @@ -109,7 +109,7 @@ def teardown_module(): def test_bigtable_create_instance(): - # [START bigtable_create_prod_instance] + # [START bigtable_api_create_prod_instance] from google.cloud.bigtable import Client from google.cloud.bigtable import enums @@ -134,7 +134,7 @@ def test_bigtable_create_instance(): # We want to make sure the operation completes. operation.result(timeout=100) - # [END bigtable_create_prod_instance] + # [END bigtable_api_create_prod_instance] try: assert instance.exists() @@ -143,7 +143,7 @@ def test_bigtable_create_instance(): def test_bigtable_create_additional_cluster(): - # [START bigtable_create_cluster] + # [START bigtable_api_create_cluster] from google.cloud.bigtable import Client from google.cloud.bigtable import enums @@ -169,7 +169,7 @@ def test_bigtable_create_additional_cluster(): operation = cluster.create() # We want to make sure the operation completes. operation.result(timeout=100) - # [END bigtable_create_cluster] + # [END bigtable_api_create_cluster] try: assert cluster.exists() @@ -180,7 +180,7 @@ def test_bigtable_create_additional_cluster(): def test_bigtable_create_reload_delete_app_profile(): import re - # [START bigtable_create_app_profile] + # [START bigtable_api_create_app_profile] from google.cloud.bigtable import Client from google.cloud.bigtable import enums @@ -199,9 +199,9 @@ def test_bigtable_create_reload_delete_app_profile(): ) app_profile = app_profile.create(ignore_warnings=True) - # [END bigtable_create_app_profile] + # [END bigtable_api_create_app_profile] - # [START bigtable_app_profile_name] + # [START bigtable_api_app_profile_name] from google.cloud.bigtable import Client client = Client(admin=True) @@ -209,7 +209,7 @@ def test_bigtable_create_reload_delete_app_profile(): app_profile = instance.app_profile(APP_PROFILE_ID) app_profile_name = app_profile.name - # [END bigtable_app_profile_name] + # [END bigtable_api_app_profile_name] _profile_name_re = re.compile( r"^projects/(?P[^/]+)/" r"instances/(?P[^/]+)/" @@ -218,7 +218,7 @@ def test_bigtable_create_reload_delete_app_profile(): ) assert _profile_name_re.match(app_profile_name) - # [START bigtable_app_profile_exists] + # [START bigtable_api_app_profile_exists] from google.cloud.bigtable import Client client = Client(admin=True) @@ -226,10 +226,10 @@ def test_bigtable_create_reload_delete_app_profile(): app_profile = instance.app_profile(APP_PROFILE_ID) app_profile_exists = app_profile.exists() - # [END bigtable_app_profile_exists] + # [END bigtable_api_app_profile_exists] assert app_profile_exists - # [START bigtable_reload_app_profile] + # [START bigtable_api_reload_app_profile] from google.cloud.bigtable import Client client = Client(admin=True) @@ -237,10 +237,10 @@ def test_bigtable_create_reload_delete_app_profile(): app_profile = instance.app_profile(APP_PROFILE_ID) app_profile.reload() - # [END bigtable_reload_app_profile] + # [END bigtable_api_reload_app_profile] assert app_profile.routing_policy_type == ROUTING_POLICY_TYPE - # [START bigtable_update_app_profile] + # [START bigtable_api_update_app_profile] from google.cloud.bigtable import Client client = Client(admin=True) @@ -251,10 +251,10 @@ def test_bigtable_create_reload_delete_app_profile(): description = "My new app profile" app_profile.description = description app_profile.update() - # [END bigtable_update_app_profile] + # [END bigtable_api_update_app_profile] assert app_profile.description == description - # [START bigtable_delete_app_profile] + # [START bigtable_api_delete_app_profile] from google.cloud.bigtable import Client client = Client(admin=True) @@ -263,40 +263,40 @@ def test_bigtable_create_reload_delete_app_profile(): app_profile.reload() app_profile.delete(ignore_warnings=True) - # [END bigtable_delete_app_profile] + # [END bigtable_api_delete_app_profile] assert not app_profile.exists() def test_bigtable_list_instances(): - # [START bigtable_list_instances] + # [START bigtable_api_list_instances] from google.cloud.bigtable import Client client = Client(admin=True) (instances_list, failed_locations_list) = client.list_instances() - # [END bigtable_list_instances] + # [END bigtable_api_list_instances] assert len(instances_list) > 0 def test_bigtable_list_clusters_on_instance(): - # [START bigtable_list_clusters_on_instance] + # [START bigtable_api_list_clusters_on_instance] from google.cloud.bigtable import Client client = Client(admin=True) instance = client.instance(INSTANCE_ID) (clusters_list, failed_locations_list) = instance.list_clusters() - # [END bigtable_list_clusters_on_instance] + # [END bigtable_api_list_clusters_on_instance] assert len(clusters_list) > 0 def test_bigtable_list_clusters_in_project(): - # [START bigtable_list_clusters_in_project] + # [START bigtable_api_list_clusters_in_project] from google.cloud.bigtable import Client client = Client(admin=True) (clusters_list, failed_locations_list) = client.list_clusters() - # [END bigtable_list_clusters_in_project] + # [END bigtable_api_list_clusters_in_project] assert len(clusters_list) > 0 @@ -308,14 +308,14 @@ def test_bigtable_list_app_profiles(): ) app_profile = app_profile.create(ignore_warnings=True) - # [START bigtable_list_app_profiles] + # [START bigtable_api_list_app_profiles] from google.cloud.bigtable import Client client = Client(admin=True) instance = client.instance(INSTANCE_ID) app_profiles_list = instance.list_app_profiles() - # [END bigtable_list_app_profiles] + # [END bigtable_api_list_app_profiles] try: assert len(app_profiles_list) > 0 @@ -324,57 +324,57 @@ def test_bigtable_list_app_profiles(): def test_bigtable_instance_exists(): - # [START bigtable_check_instance_exists] + # [START bigtable_api_check_instance_exists] from google.cloud.bigtable import Client client = Client(admin=True) instance = client.instance(INSTANCE_ID) instance_exists = instance.exists() - # [END bigtable_check_instance_exists] + # [END bigtable_api_check_instance_exists] assert instance_exists def test_bigtable_cluster_exists(): - # [START bigtable_check_cluster_exists] + # [START bigtable_api_check_cluster_exists] from google.cloud.bigtable import Client client = Client(admin=True) instance = client.instance(INSTANCE_ID) cluster = instance.cluster(CLUSTER_ID) cluster_exists = cluster.exists() - # [END bigtable_check_cluster_exists] + # [END bigtable_api_check_cluster_exists] assert cluster_exists def test_bigtable_reload_instance(): - # [START bigtable_reload_instance] + # [START bigtable_api_reload_instance] from google.cloud.bigtable import Client client = Client(admin=True) instance = client.instance(INSTANCE_ID) instance.reload() - # [END bigtable_reload_instance] + # [END bigtable_api_reload_instance] assert instance.type_ == PRODUCTION.value def test_bigtable_reload_cluster(): - # [START bigtable_reload_cluster] + # [START bigtable_api_reload_cluster] from google.cloud.bigtable import Client client = Client(admin=True) instance = client.instance(INSTANCE_ID) cluster = instance.cluster(CLUSTER_ID) cluster.reload() - # [END bigtable_reload_cluster] + # [END bigtable_api_reload_cluster] assert cluster.serve_nodes == SERVER_NODES def test_bigtable_update_instance(): - # [START bigtable_update_instance] + # [START bigtable_api_update_instance] from google.cloud.bigtable import Client client = Client(admin=True) @@ -382,13 +382,13 @@ def test_bigtable_update_instance(): display_name = "My new instance" instance.display_name = display_name instance.update() - # [END bigtable_update_instance] + # [END bigtable_api_update_instance] assert instance.display_name == display_name def test_bigtable_update_cluster(): - # [START bigtable_update_cluster] + # [START bigtable_api_update_cluster] from google.cloud.bigtable import Client client = Client(admin=True) @@ -396,13 +396,13 @@ def test_bigtable_update_cluster(): cluster = instance.cluster(CLUSTER_ID) cluster.serve_nodes = 4 cluster.update() - # [END bigtable_update_cluster] + # [END bigtable_api_update_cluster] assert cluster.serve_nodes == 4 def test_bigtable_create_table(): - # [START bigtable_create_table] + # [START bigtable_api_create_table] from google.api_core import exceptions from google.api_core import retry from google.cloud.bigtable import Client @@ -420,7 +420,7 @@ def test_bigtable_create_table(): retry_504 = retry.Retry(predicate_504) retry_504(table.create)(column_families={"cf1": max_versions_rule}) - # [END bigtable_create_table] + # [END bigtable_api_create_table] try: assert table.exists() @@ -430,13 +430,13 @@ def test_bigtable_create_table(): def test_bigtable_list_tables(): - # [START bigtable_list_tables] + # [START bigtable_api_list_tables] from google.cloud.bigtable import Client client = Client(admin=True) instance = client.instance(INSTANCE_ID) tables_list = instance.list_tables() - # [END bigtable_list_tables] + # [END bigtable_api_list_tables] # Check if returned list has expected table table_names = [table.name for table in tables_list] @@ -460,7 +460,7 @@ def test_bigtable_delete_cluster(): # We want to make sure the operation completes. operation.result(timeout=1000) - # [START bigtable_delete_cluster] + # [START bigtable_api_delete_cluster] from google.cloud.bigtable import Client client = Client(admin=True) @@ -468,7 +468,7 @@ def test_bigtable_delete_cluster(): cluster_to_delete = instance.cluster(cluster_id) cluster_to_delete.delete() - # [END bigtable_delete_cluster] + # [END bigtable_api_delete_cluster] assert not cluster_to_delete.exists() @@ -495,14 +495,14 @@ def test_bigtable_delete_instance(): # Make sure this instance gets deleted after the test case. INSTANCES_TO_DELETE.append(instance) - # [START bigtable_delete_instance] + # [START bigtable_api_delete_instance] from google.cloud.bigtable import Client client = Client(admin=True) instance_to_delete = client.instance(instance_id) instance_to_delete.delete() - # [END bigtable_delete_instance] + # [END bigtable_api_delete_instance] assert not instance_to_delete.exists() @@ -511,7 +511,7 @@ def test_bigtable_delete_instance(): def test_bigtable_test_iam_permissions(): - # [START bigtable_test_iam_permissions] + # [START bigtable_api_test_iam_permissions] from google.cloud.bigtable import Client client = Client(admin=True) @@ -519,7 +519,7 @@ def test_bigtable_test_iam_permissions(): instance.reload() permissions = ["bigtable.clusters.create", "bigtable.tables.create"] permissions_allowed = instance.test_iam_permissions(permissions) - # [END bigtable_test_iam_permissions] + # [END bigtable_api_test_iam_permissions] assert permissions_allowed == permissions @@ -527,7 +527,7 @@ def test_bigtable_test_iam_permissions(): def test_bigtable_set_iam_policy_then_get_iam_policy(): service_account_email = Config.CLIENT._credentials.service_account_email - # [START bigtable_set_iam_policy] + # [START bigtable_api_set_iam_policy] from google.cloud.bigtable import Client from google.cloud.bigtable.policy import Policy from google.cloud.bigtable.policy import BIGTABLE_ADMIN_ROLE @@ -539,17 +539,17 @@ def test_bigtable_set_iam_policy_then_get_iam_policy(): new_policy[BIGTABLE_ADMIN_ROLE] = [Policy.service_account(service_account_email)] policy_latest = instance.set_iam_policy(new_policy) - # [END bigtable_set_iam_policy] + # [END bigtable_api_set_iam_policy] assert len(policy_latest.bigtable_admins) > 0 - # [START bigtable_get_iam_policy] + # [START bigtable_api_get_iam_policy] from google.cloud.bigtable import Client client = Client(admin=True) instance = client.instance(INSTANCE_ID) policy = instance.get_iam_policy() - # [END bigtable_get_iam_policy] + # [END bigtable_api_get_iam_policy] assert len(policy.bigtable_admins) > 0 @@ -557,45 +557,45 @@ def test_bigtable_set_iam_policy_then_get_iam_policy(): def test_bigtable_project_path(): import re - # [START bigtable_project_path] + # [START bigtable_api_project_path] from google.cloud.bigtable import Client client = Client(admin=True) project_path = client.project_path - # [END bigtable_project_path] + # [END bigtable_api_project_path] def test_bigtable_table_data_client(): - # [START bigtable_table_data_client] + # [START bigtable_api_table_data_client] from google.cloud.bigtable import Client client = Client(admin=True) table_data_client = client.table_data_client - # [END bigtable_table_data_client] + # [END bigtable_api_table_data_client] def test_bigtable_table_admin_client(): - # [START bigtable_table_admin_client] + # [START bigtable_api_table_admin_client] from google.cloud.bigtable import Client client = Client(admin=True) table_admin_client = client.table_admin_client - # [END bigtable_table_admin_client] + # [END bigtable_api_table_admin_client] def test_bigtable_instance_admin_client(): - # [START bigtable_instance_admin_client] + # [START bigtable_api_instance_admin_client] from google.cloud.bigtable import Client client = Client(admin=True) instance_admin_client = client.instance_admin_client - # [END bigtable_instance_admin_client] + # [END bigtable_api_instance_admin_client] def test_bigtable_admins_policy(): service_account_email = Config.CLIENT._credentials.service_account_email - # [START bigtable_admins_policy] + # [START bigtable_api_admins_policy] from google.cloud.bigtable import Client from google.cloud.bigtable.policy import Policy from google.cloud.bigtable.policy import BIGTABLE_ADMIN_ROLE @@ -608,7 +608,7 @@ def test_bigtable_admins_policy(): policy_latest = instance.set_iam_policy(new_policy) policy = policy_latest.bigtable_admins - # [END bigtable_admins_policy] + # [END bigtable_api_admins_policy] assert len(policy) > 0 @@ -616,7 +616,7 @@ def test_bigtable_admins_policy(): def test_bigtable_readers_policy(): service_account_email = Config.CLIENT._credentials.service_account_email - # [START bigtable_readers_policy] + # [START bigtable_api_readers_policy] from google.cloud.bigtable import Client from google.cloud.bigtable.policy import Policy from google.cloud.bigtable.policy import BIGTABLE_READER_ROLE @@ -629,7 +629,7 @@ def test_bigtable_readers_policy(): policy_latest = instance.set_iam_policy(new_policy) policy = policy_latest.bigtable_readers - # [END bigtable_readers_policy] + # [END bigtable_api_readers_policy] assert len(policy) > 0 @@ -637,7 +637,7 @@ def test_bigtable_readers_policy(): def test_bigtable_users_policy(): service_account_email = Config.CLIENT._credentials.service_account_email - # [START bigtable_users_policy] + # [START bigtable_api_users_policy] from google.cloud.bigtable import Client from google.cloud.bigtable.policy import Policy from google.cloud.bigtable.policy import BIGTABLE_USER_ROLE @@ -650,7 +650,7 @@ def test_bigtable_users_policy(): policy_latest = instance.set_iam_policy(new_policy) policy = policy_latest.bigtable_users - # [END bigtable_users_policy] + # [END bigtable_api_users_policy] assert len(policy) > 0 @@ -658,7 +658,7 @@ def test_bigtable_users_policy(): def test_bigtable_viewers_policy(): service_account_email = Config.CLIENT._credentials.service_account_email - # [START bigtable_viewers_policy] + # [START bigtable_api_viewers_policy] from google.cloud.bigtable import Client from google.cloud.bigtable.policy import Policy from google.cloud.bigtable.policy import BIGTABLE_VIEWER_ROLE @@ -671,7 +671,7 @@ def test_bigtable_viewers_policy(): policy_latest = instance.set_iam_policy(new_policy) policy = policy_latest.bigtable_viewers - # [END bigtable_viewers_policy] + # [END bigtable_api_viewers_policy] assert len(policy) > 0 @@ -679,30 +679,30 @@ def test_bigtable_viewers_policy(): def test_bigtable_instance_name(): import re - # [START bigtable_instance_name] + # [START bigtable_api_instance_name] from google.cloud.bigtable import Client client = Client(admin=True) instance = client.instance(INSTANCE_ID) instance_name = instance.name - # [END bigtable_instance_name] + # [END bigtable_api_instance_name] def test_bigtable_cluster_name(): import re - # [START bigtable_cluster_name] + # [START bigtable_api_cluster_name] from google.cloud.bigtable import Client client = Client(admin=True) instance = client.instance(INSTANCE_ID) cluster = instance.cluster(CLUSTER_ID) cluster_name = cluster.name - # [END bigtable_cluster_name] + # [END bigtable_api_cluster_name] def test_bigtable_instance_from_pb(): - # [START bigtable_instance_from_pb] + # [START bigtable_api_instance_from_pb] from google.cloud.bigtable import Client from google.cloud.bigtable_admin_v2.types import instance_pb2 @@ -715,13 +715,13 @@ def test_bigtable_instance_from_pb(): ) instance2 = instance.from_pb(instance_pb, client) - # [END bigtable_instance_from_pb] + # [END bigtable_api_instance_from_pb] assert instance2.name == instance.name def test_bigtable_cluster_from_pb(): - # [START bigtable_cluster_from_pb] + # [START bigtable_api_cluster_from_pb] from google.cloud.bigtable import Client from google.cloud.bigtable_admin_v2.types import instance_pb2 @@ -741,32 +741,32 @@ def test_bigtable_cluster_from_pb(): ) cluster2 = cluster.from_pb(cluster_pb, instance) - # [END bigtable_cluster_from_pb] + # [END bigtable_api_cluster_from_pb] assert cluster2.name == cluster.name def test_bigtable_instance_state(): - # [START bigtable_instance_state] + # [START bigtable_api_instance_state] from google.cloud.bigtable import Client client = Client(admin=True) instance = client.instance(INSTANCE_ID) instance_state = instance.state - # [END bigtable_instance_state] + # [END bigtable_api_instance_state] assert not instance_state def test_bigtable_cluster_state(): - # [START bigtable_cluster_state] + # [START bigtable_api_cluster_state] from google.cloud.bigtable import Client client = Client(admin=True) instance = client.instance(INSTANCE_ID) cluster = instance.cluster(CLUSTER_ID) cluster_state = cluster.state - # [END bigtable_cluster_state] + # [END bigtable_api_cluster_state] assert not cluster_state diff --git a/docs/snippets_table.py b/docs/snippets_table.py index a20918c03..4c3304fd0 100644 --- a/docs/snippets_table.py +++ b/docs/snippets_table.py @@ -112,7 +112,7 @@ def teardown_module(): def test_bigtable_create_table(): - # [START bigtable_create_table] + # [START bigtable_api_create_table] from google.cloud.bigtable import Client from google.cloud.bigtable import column_family @@ -129,7 +129,7 @@ def test_bigtable_create_table(): max_versions_rule = column_family.MaxVersionsGCRule(2) table2.create(column_families={"cf1": max_versions_rule}) - # [END bigtable_create_table] + # [END bigtable_api_create_table] assert table1.exists() assert table2.exists() table1.delete() @@ -142,7 +142,7 @@ def test_bigtable_sample_row_keys(): table_sample.create(initial_split_keys=initial_split_keys) assert table_sample.exists() - # [START bigtable_sample_row_keys] + # [START bigtable_api_sample_row_keys] from google.cloud.bigtable import Client client = Client(admin=True) @@ -151,14 +151,14 @@ def test_bigtable_sample_row_keys(): table = instance.table("table_id1_samplerow") data = table.sample_row_keys() actual_keys, offset = zip(*[(rk.row_key, rk.offset_bytes) for rk in data]) - # [END bigtable_sample_row_keys] + # [END bigtable_api_sample_row_keys] initial_split_keys.append(b"") assert list(actual_keys) == initial_split_keys table.delete() def test_bigtable_write_read_drop_truncate(): - # [START bigtable_mutate_rows] + # [START bigtable_api_mutate_rows] from google.cloud.bigtable import Client client = Client(admin=True) @@ -187,9 +187,9 @@ def test_bigtable_write_read_drop_truncate(): for i, status in enumerate(response): if status.code != 0: print("Row number {} failed to write".format(i)) - # [END bigtable_mutate_rows] + # [END bigtable_api_mutate_rows] assert len(response) == len(rows) - # [START bigtable_read_row] + # [START bigtable_api_read_row] from google.cloud.bigtable import Client client = Client(admin=True) @@ -197,9 +197,9 @@ def test_bigtable_write_read_drop_truncate(): table = instance.table(TABLE_ID) row_key = "row_key_1" row = table.read_row(row_key) - # [END bigtable_read_row] + # [END bigtable_api_read_row] assert row.row_key.decode("utf-8") == row_key - # [START bigtable_read_rows] + # [START bigtable_api_read_rows] from google.cloud.bigtable import Client client = Client(admin=True) @@ -215,9 +215,9 @@ def test_bigtable_write_read_drop_truncate(): cell = row.cells[COLUMN_FAMILY_ID][col_name][0] print(cell.value.decode("utf-8")) total_rows.append(cell) - # [END bigtable_read_rows] + # [END bigtable_api_read_rows] assert len(total_rows) == len(rows) - # [START bigtable_drop_by_prefix] + # [START bigtable_api_drop_by_prefix] from google.cloud.bigtable import Client client = Client(admin=True) @@ -225,19 +225,19 @@ def test_bigtable_write_read_drop_truncate(): table = instance.table(TABLE_ID) row_key_prefix = b"row_key_2" table.drop_by_prefix(row_key_prefix, timeout=200) - # [END bigtable_drop_by_prefix] + # [END bigtable_api_drop_by_prefix] dropped_row_keys = [b"row_key_2", b"row_key_20", b"row_key_22", b"row_key_200"] for row in table.read_rows(): assert row.row_key.decode("utf-8") not in dropped_row_keys - # [START bigtable_truncate_table] + # [START bigtable_api_truncate_table] from google.cloud.bigtable import Client client = Client(admin=True) instance = client.instance(INSTANCE_ID) table = instance.table(TABLE_ID) table.truncate(timeout=200) - # [END bigtable_truncate_table] + # [END bigtable_api_truncate_table] rows_data_after_truncate = [] for row in table.read_rows(): rows_data_after_truncate.append(row.row_key) @@ -245,14 +245,14 @@ def test_bigtable_write_read_drop_truncate(): def test_bigtable_mutations_batcher(): - # [START bigtable_mutations_batcher] + # [START bigtable_api_mutations_batcher] from google.cloud.bigtable import Client client = Client(admin=True) instance = client.instance(INSTANCE_ID) table = instance.table(TABLE_ID) batcher = table.mutations_batcher() - # [END bigtable_mutations_batcher] + # [END bigtable_api_mutations_batcher] # Below code will be used while creating batcher.py snippets. # So not removing this code as of now. @@ -296,7 +296,7 @@ def test_bigtable_mutations_batcher(): def test_bigtable_table_column_family(): - # [START bigtable_table_column_family] + # [START bigtable_api_table_column_family] from google.cloud.bigtable import Client client = Client(admin=True) @@ -304,26 +304,26 @@ def test_bigtable_table_column_family(): table = instance.table(TABLE_ID) column_family_obj = table.column_family(COLUMN_FAMILY_ID) - # [END bigtable_table_column_family] + # [END bigtable_api_table_column_family] assert column_family_obj.column_family_id == COLUMN_FAMILY_ID def test_bigtable_list_tables(): - # [START bigtable_list_tables] + # [START bigtable_api_list_tables] from google.cloud.bigtable import Client client = Client(admin=True) instance = client.instance(INSTANCE_ID) tables_list = instance.list_tables() - # [END bigtable_list_tables] + # [END bigtable_api_list_tables] assert len(tables_list) != 0 def test_bigtable_table_name(): import re - # [START bigtable_table_name] + # [START bigtable_api_table_name] from google.cloud.bigtable import Client client = Client(admin=True) @@ -331,7 +331,7 @@ def test_bigtable_table_name(): table = instance.table(TABLE_ID) table_name = table.name - # [END bigtable_table_name] + # [END bigtable_api_table_name] _table_name_re = re.compile( r"^projects/(?P[^/]+)/" r"instances/(?P[^/]+)/tables/" @@ -341,7 +341,7 @@ def test_bigtable_table_name(): def test_bigtable_list_column_families(): - # [START bigtable_list_column_families] + # [START bigtable_api_list_column_families] from google.cloud.bigtable import Client client = Client(admin=True) @@ -349,13 +349,13 @@ def test_bigtable_list_column_families(): table = instance.table(TABLE_ID) column_family_list = table.list_column_families() - # [END bigtable_list_column_families] + # [END bigtable_api_list_column_families] assert len(column_family_list) > 0 def test_bigtable_get_cluster_states(): - # [START bigtable_get_cluster_states] + # [START bigtable_api_get_cluster_states] from google.cloud.bigtable import Client client = Client(admin=True) @@ -363,7 +363,7 @@ def test_bigtable_get_cluster_states(): table = instance.table(TABLE_ID) get_cluster_states = table.get_cluster_states() - # [END bigtable_get_cluster_states] + # [END bigtable_api_get_cluster_states] assert CLUSTER_ID in get_cluster_states @@ -373,7 +373,7 @@ def test_bigtable_table_test_iam_permissions(): table_policy.create() assert table_policy.exists - # [START bigtable_table_test_iam_permissions] + # [START bigtable_api_table_test_iam_permissions] from google.cloud.bigtable import Client client = Client(admin=True) @@ -382,7 +382,7 @@ def test_bigtable_table_test_iam_permissions(): permissions = ["bigtable.tables.mutateRows", "bigtable.tables.readRows"] permissions_allowed = table.test_iam_permissions(permissions) - # [END bigtable_table_test_iam_permissions] + # [END bigtable_api_table_test_iam_permissions] assert permissions_allowed == permissions @@ -391,7 +391,7 @@ def test_bigtable_table_set_iam_policy_then_get_iam_policy(): assert table_policy.exists service_account_email = Config.CLIENT._credentials.service_account_email - # [START bigtable_table_set_iam_policy] + # [START bigtable_api_table_set_iam_policy] from google.cloud.bigtable import Client from google.cloud.bigtable.policy import Policy from google.cloud.bigtable.policy import BIGTABLE_ADMIN_ROLE @@ -403,29 +403,29 @@ def test_bigtable_table_set_iam_policy_then_get_iam_policy(): new_policy[BIGTABLE_ADMIN_ROLE] = [Policy.service_account(service_account_email)] policy_latest = table.set_iam_policy(new_policy) - # [END bigtable_table_set_iam_policy] + # [END bigtable_api_table_set_iam_policy] assert len(policy_latest.bigtable_admins) > 0 - # [START bigtable_table_get_iam_policy] + # [START bigtable_api_table_get_iam_policy] from google.cloud.bigtable import Client client = Client(admin=True) instance = client.instance(INSTANCE_ID) table = instance.table("table_id_iam_policy") policy = table.get_iam_policy() - # [END bigtable_table_get_iam_policy] + # [END bigtable_api_table_get_iam_policy] assert len(policy.bigtable_admins) > 0 def test_bigtable_table_exists(): - # [START bigtable_check_table_exists] + # [START bigtable_api_check_table_exists] from google.cloud.bigtable import Client client = Client(admin=True) instance = client.instance(INSTANCE_ID) table = instance.table(TABLE_ID) table_exists = table.exists() - # [END bigtable_check_table_exists] + # [END bigtable_api_check_table_exists] assert table_exists @@ -434,7 +434,7 @@ def test_bigtable_delete_table(): table_del.create() assert table_del.exists() - # [START bigtable_delete_table] + # [START bigtable_api_delete_table] from google.cloud.bigtable import Client client = Client(admin=True) @@ -442,12 +442,12 @@ def test_bigtable_delete_table(): table = instance.table("table_id_del") table.delete() - # [END bigtable_delete_table] + # [END bigtable_api_delete_table] assert not table.exists() def test_bigtable_table_row(): - # [START bigtable_table_row] + # [START bigtable_api_table_row] from google.cloud.bigtable import Client client = Client(admin=True) @@ -457,7 +457,7 @@ def test_bigtable_table_row(): row_keys = [b"row_key_1", b"row_key_2"] row1_obj = table.row(row_keys[0]) row2_obj = table.row(row_keys[1]) - # [END bigtable_table_row] + # [END bigtable_api_table_row] row1_obj.set_cell(COLUMN_FAMILY_ID, COL_NAME1, CELL_VAL1) row1_obj.commit() @@ -474,7 +474,7 @@ def test_bigtable_table_row(): def test_bigtable_table_append_row(): - # [START bigtable_table_append_row] + # [START bigtable_api_table_append_row] from google.cloud.bigtable import Client client = Client(admin=True) @@ -484,7 +484,7 @@ def test_bigtable_table_append_row(): row_keys = [b"row_key_1", b"row_key_2"] row1_obj = table.append_row(row_keys[0]) row2_obj = table.append_row(row_keys[1]) - # [END bigtable_table_append_row] + # [END bigtable_api_table_append_row] row1_obj.append_cell_value(COLUMN_FAMILY_ID, COL_NAME1, CELL_VAL1) row1_obj.commit() @@ -501,7 +501,7 @@ def test_bigtable_table_append_row(): def test_bigtable_table_direct_row(): - # [START bigtable_table_direct_row] + # [START bigtable_api_table_direct_row] from google.cloud.bigtable import Client client = Client(admin=True) @@ -511,7 +511,7 @@ def test_bigtable_table_direct_row(): row_keys = [b"row_key_1", b"row_key_2"] row1_obj = table.direct_row(row_keys[0]) row2_obj = table.direct_row(row_keys[1]) - # [END bigtable_table_direct_row] + # [END bigtable_api_table_direct_row] row1_obj.set_cell(COLUMN_FAMILY_ID, COL_NAME1, CELL_VAL1) row1_obj.commit() @@ -528,7 +528,7 @@ def test_bigtable_table_direct_row(): def test_bigtable_table_conditional_row(): - # [START bigtable_table_conditional_row] + # [START bigtable_api_table_conditional_row] from google.cloud.bigtable import Client from google.cloud.bigtable.row_filters import PassAllFilter @@ -540,7 +540,7 @@ def test_bigtable_table_conditional_row(): filter_ = PassAllFilter(True) row1_obj = table.conditional_row(row_keys[0], filter_=filter_) row2_obj = table.conditional_row(row_keys[1], filter_=filter_) - # [END bigtable_table_conditional_row] + # [END bigtable_api_table_conditional_row] row1_obj.set_cell(COLUMN_FAMILY_ID, COL_NAME1, CELL_VAL1, state=False) row1_obj.commit() @@ -557,7 +557,7 @@ def test_bigtable_table_conditional_row(): def test_bigtable_column_family_name(): - # [START bigtable_column_family_name] + # [START bigtable_api_column_family_name] from google.cloud.bigtable import Client client = Client(admin=True) @@ -567,7 +567,7 @@ def test_bigtable_column_family_name(): column_families = table.list_column_families() column_family_obj = column_families[COLUMN_FAMILY_ID] column_family_name = column_family_obj.name - # [END bigtable_column_family_name] + # [END bigtable_api_column_family_name] import re _cf_name_re = re.compile( @@ -580,7 +580,7 @@ def test_bigtable_column_family_name(): def test_bigtable_create_update_delete_column_family(): - # [START bigtable_create_column_family] + # [START bigtable_api_create_column_family] from google.cloud.bigtable import Client from google.cloud.bigtable import column_family @@ -593,11 +593,11 @@ def test_bigtable_create_update_delete_column_family(): column_family_obj = table.column_family(column_family_id, gc_rule=gc_rule) column_family_obj.create() - # [END bigtable_create_column_family] + # [END bigtable_api_create_column_family] column_families = table.list_column_families() assert column_families[column_family_id].gc_rule == gc_rule - # [START bigtable_update_column_family] + # [START bigtable_api_update_column_family] from google.cloud.bigtable import Client from google.cloud.bigtable import column_family @@ -611,12 +611,12 @@ def test_bigtable_create_update_delete_column_family(): max_age_rule = column_family.MaxAgeGCRule(datetime.timedelta(days=5)) column_family_obj = table.column_family(column_family_id, gc_rule=max_age_rule) column_family_obj.update() - # [END bigtable_update_column_family] + # [END bigtable_api_update_column_family] updated_families = table.list_column_families() assert updated_families[column_family_id].gc_rule == max_age_rule - # [START bigtable_delete_column_family] + # [START bigtable_api_delete_column_family] from google.cloud.bigtable import Client from google.cloud.bigtable import column_family @@ -627,7 +627,7 @@ def test_bigtable_create_update_delete_column_family(): column_family_id = "column_family_id1" column_family_obj = table.column_family(column_family_id) column_family_obj.delete() - # [END bigtable_delete_column_family] + # [END bigtable_api_delete_column_family] column_families = table.list_column_families() assert column_family_id not in column_families @@ -652,7 +652,7 @@ def test_bigtable_add_row_add_row_range_add_row_range_from_keys(): rows.append(row) Config.TABLE.mutate_rows(rows) - # [START bigtable_add_row_key] + # [START bigtable_api_add_row_key] from google.cloud.bigtable import Client from google.cloud.bigtable.row_set import RowSet @@ -662,14 +662,14 @@ def test_bigtable_add_row_add_row_range_add_row_range_from_keys(): row_set = RowSet() row_set.add_row_key(b"row_key_5") - # [END bigtable_add_row_key] + # [END bigtable_api_add_row_key] read_rows = table.read_rows(row_set=row_set) expected_row_keys = [b"row_key_5"] found_row_keys = [row.row_key for row in read_rows] assert found_row_keys == expected_row_keys - # [START bigtable_add_row_range] + # [START bigtable_api_add_row_range] from google.cloud.bigtable import Client from google.cloud.bigtable.row_set import RowSet from google.cloud.bigtable.row_set import RowRange @@ -680,14 +680,14 @@ def test_bigtable_add_row_add_row_range_add_row_range_from_keys(): row_set = RowSet() row_set.add_row_range(RowRange(start_key=b"row_key_3", end_key=b"row_key_7")) - # [END bigtable_add_row_range] + # [END bigtable_api_add_row_range] read_rows = table.read_rows(row_set=row_set) expected_row_keys = [b"row_key_3", b"row_key_4", b"row_key_5", b"row_key_6"] found_row_keys = [row.row_key for row in read_rows] assert found_row_keys == expected_row_keys - # [START bigtable_row_range_from_keys] + # [START bigtable_api_row_range_from_keys] from google.cloud.bigtable import Client from google.cloud.bigtable.row_set import RowSet @@ -697,7 +697,7 @@ def test_bigtable_add_row_add_row_range_add_row_range_from_keys(): row_set = RowSet() row_set.add_row_range_from_keys(start_key=b"row_key_3", end_key=b"row_key_7") - # [END bigtable_row_range_from_keys] + # [END bigtable_api_row_range_from_keys] read_rows = table.read_rows(row_set=row_set) expected_row_keys = [b"row_key_3", b"row_key_4", b"row_key_5", b"row_key_6"] @@ -722,7 +722,7 @@ def test_bigtable_add_row_range_with_prefix(): rows.append(row) Config.TABLE.mutate_rows(rows) - # [START bigtable_add_row_range_with_prefix] + # [START bigtable_api_add_row_range_with_prefix] from google.cloud.bigtable import Client from google.cloud.bigtable.row_set import RowSet @@ -732,7 +732,7 @@ def test_bigtable_add_row_range_with_prefix(): row_set = RowSet() row_set.add_row_range_with_prefix("row") - # [END bigtable_add_row_range_with_prefix] + # [END bigtable_api_add_row_range_with_prefix] read_rows = table.read_rows(row_set=row_set) expected_row_keys = [ @@ -746,7 +746,7 @@ def test_bigtable_add_row_range_with_prefix(): def test_bigtable_batcher_mutate_flush_mutate_rows(): - # [START bigtable_batcher_mutate] + # [START bigtable_api_batcher_mutate] from google.cloud.bigtable import Client client = Client(admin=True) @@ -766,9 +766,9 @@ def test_bigtable_batcher_mutate_flush_mutate_rows(): # reaches the max_row_bytes batcher.mutate(row) batcher.flush() - # [END bigtable_batcher_mutate] + # [END bigtable_api_batcher_mutate] - # [START bigtable_batcher_flush] + # [START bigtable_api_batcher_flush] from google.cloud.bigtable import Client client = Client(admin=True) @@ -786,7 +786,7 @@ def test_bigtable_batcher_mutate_flush_mutate_rows(): # reaches the max_row_bytes batcher.mutate(row) batcher.flush() - # [END bigtable_batcher_flush] + # [END bigtable_api_batcher_flush] rows_on_table = [] for row in table.read_rows(): @@ -794,7 +794,7 @@ def test_bigtable_batcher_mutate_flush_mutate_rows(): assert len(rows_on_table) == 2 table.truncate(timeout=200) - # [START bigtable_batcher_mutate_rows] + # [START bigtable_api_batcher_mutate_rows] from google.cloud.bigtable import Client client = Client(admin=True) @@ -818,7 +818,7 @@ def test_bigtable_batcher_mutate_flush_mutate_rows(): # reaches the max flush_count # Manually send the current batch to Cloud Bigtable batcher.flush() - # [END bigtable_batcher_mutate_rows] + # [END bigtable_api_batcher_mutate_rows] rows_on_table = [] for row in table.read_rows(): @@ -828,7 +828,7 @@ def test_bigtable_batcher_mutate_flush_mutate_rows(): def test_bigtable_create_family_gc_max_age(): - # [START bigtable_create_family_gc_max_age] + # [START bigtable_api_create_family_gc_max_age] from google.cloud.bigtable import Client from google.cloud.bigtable import column_family @@ -842,7 +842,7 @@ def test_bigtable_create_family_gc_max_age(): column_family_obj = table.column_family("cf1", max_age_rule) column_family_obj.create() - # [END bigtable_create_family_gc_max_age] + # [END bigtable_api_create_family_gc_max_age] rule = str(column_family_obj.to_pb()) assert "max_age" in rule assert "seconds: 432000" in rule @@ -850,7 +850,7 @@ def test_bigtable_create_family_gc_max_age(): def test_bigtable_create_family_gc_max_versions(): - # [START bigtable_create_family_gc_max_versions] + # [START bigtable_api_create_family_gc_max_versions] from google.cloud.bigtable import Client from google.cloud.bigtable import column_family @@ -864,14 +864,14 @@ def test_bigtable_create_family_gc_max_versions(): column_family_obj = table.column_family("cf2", max_versions_rule) column_family_obj.create() - # [END bigtable_create_family_gc_max_versions] + # [END bigtable_api_create_family_gc_max_versions] rule = str(column_family_obj.to_pb()) assert "max_num_versions: 2" in rule column_family_obj.delete() def test_bigtable_create_family_gc_union(): - # [START bigtable_create_family_gc_union] + # [START bigtable_api_create_family_gc_union] from google.cloud.bigtable import Client from google.cloud.bigtable import column_family @@ -887,7 +887,7 @@ def test_bigtable_create_family_gc_union(): column_family_obj = table.column_family("cf3", union_rule) column_family_obj.create() - # [END bigtable_create_family_gc_union] + # [END bigtable_api_create_family_gc_union] rule = str(column_family_obj.to_pb()) assert "union" in rule assert "max_age" in rule @@ -897,7 +897,7 @@ def test_bigtable_create_family_gc_union(): def test_bigtable_create_family_gc_intersection(): - # [START bigtable_create_family_gc_intersection] + # [START bigtable_api_create_family_gc_intersection] from google.cloud.bigtable import Client from google.cloud.bigtable import column_family @@ -915,7 +915,7 @@ def test_bigtable_create_family_gc_intersection(): column_family_obj = table.column_family("cf4", intersection_rule) column_family_obj.create() - # [END bigtable_create_family_gc_intersection] + # [END bigtable_api_create_family_gc_intersection] rule = str(column_family_obj.to_pb()) assert "intersection" in rule @@ -926,7 +926,7 @@ def test_bigtable_create_family_gc_intersection(): def test_bigtable_create_family_gc_nested(): - # [START bigtable_create_family_gc_nested] + # [START bigtable_api_create_family_gc_nested] from google.cloud.bigtable import Client from google.cloud.bigtable import column_family @@ -953,7 +953,7 @@ def test_bigtable_create_family_gc_nested(): column_family_obj = table.column_family("cf5", nested_rule) column_family_obj.create() - # [END bigtable_create_family_gc_nested] + # [END bigtable_api_create_family_gc_nested] rule = str(column_family_obj.to_pb()) assert "intersection" in rule @@ -977,7 +977,7 @@ def test_bigtable_row_data_cells_cell_value_cell_values(): ) row.commit() - # [START bigtable_row_data_cells] + # [START bigtable_api_row_data_cells] from google.cloud.bigtable import Client client = Client(admin=True) @@ -987,12 +987,12 @@ def test_bigtable_row_data_cells_cell_value_cell_values(): row_data = table.read_row(row_key) cells = row_data.cells - # [END bigtable_row_data_cells] + # [END bigtable_api_row_data_cells] actual_cell_value = cells[COLUMN_FAMILY_ID][COL_NAME1][0].value assert actual_cell_value == value - # [START bigtable_row_cell_value] + # [START bigtable_api_row_cell_value] from google.cloud.bigtable import Client client = Client(admin=True) @@ -1002,10 +1002,10 @@ def test_bigtable_row_data_cells_cell_value_cell_values(): row_data = table.read_row(row_key) cell_value = row_data.cell_value(COLUMN_FAMILY_ID, COL_NAME1) - # [END bigtable_row_cell_value] + # [END bigtable_api_row_cell_value] assert cell_value == value - # [START bigtable_row_cell_values] + # [START bigtable_api_row_cell_values] from google.cloud.bigtable import Client client = Client(admin=True) @@ -1015,7 +1015,7 @@ def test_bigtable_row_data_cells_cell_value_cell_values(): row_data = table.read_row(row_key) cell_values = row_data.cell_values(COLUMN_FAMILY_ID, COL_NAME1) - # [END bigtable_row_cell_values] + # [END bigtable_api_row_cell_values] for actual_value, timestamp in cell_values: assert actual_value == value @@ -1024,7 +1024,7 @@ def test_bigtable_row_data_cells_cell_value_cell_values(): row.set_cell(COLUMN_FAMILY_ID, COL_NAME2, value2) row.commit() - # [START bigtable_row_find_cells] + # [START bigtable_api_row_find_cells] from google.cloud.bigtable import Client client = Client(admin=True) @@ -1034,14 +1034,14 @@ def test_bigtable_row_data_cells_cell_value_cell_values(): row = table.read_row(row_key) cells = row.find_cells(COLUMN_FAMILY_ID, COL_NAME2) - # [END bigtable_row_find_cells] + # [END bigtable_api_row_find_cells] assert cells[0].value == value2 table.truncate(timeout=200) def test_bigtable_row_setcell_rowkey(): - # [START bigtable_row_set_cell] + # [START bigtable_api_row_set_cell] from google.cloud.bigtable import Client client = Client(admin=True) @@ -1053,14 +1053,14 @@ def test_bigtable_row_setcell_rowkey(): row.set_cell( COLUMN_FAMILY_ID, COL_NAME1, cell_val, timestamp=datetime.datetime.utcnow() ) - # [END bigtable_row_set_cell] + # [END bigtable_api_row_set_cell] response = table.mutate_rows([row]) # validate that all rows written successfully for i, status in enumerate(response): assert status.code == 0 - # [START bigtable_row_row_key] + # [START bigtable_api_row_row_key] from google.cloud.bigtable import Client client = Client(admin=True) @@ -1069,10 +1069,10 @@ def test_bigtable_row_setcell_rowkey(): row = table.row(ROW_KEY1) row_key = row.row_key - # [END bigtable_row_row_key] + # [END bigtable_api_row_row_key] assert row_key == ROW_KEY1 - # [START bigtable_row_table] + # [START bigtable_api_row_table] from google.cloud.bigtable import Client client = Client(admin=True) @@ -1081,7 +1081,7 @@ def test_bigtable_row_setcell_rowkey(): row = table.row(ROW_KEY1) table1 = row.table - # [END bigtable_row_table] + # [END bigtable_api_row_table] assert table1 == table table.truncate(timeout=200) @@ -1097,7 +1097,7 @@ def test_bigtable_row_delete(): written_row_keys.append(row.row_key) assert written_row_keys == [b"row_key_1"] - # [START bigtable_row_delete] + # [START bigtable_api_row_delete] from google.cloud.bigtable import Client client = Client(admin=True) @@ -1109,7 +1109,7 @@ def test_bigtable_row_delete(): row_obj.delete() row_obj.commit() - # [END bigtable_row_delete] + # [END bigtable_api_row_delete] written_row_keys = [] for row in table.read_rows(): @@ -1129,7 +1129,7 @@ def test_bigtable_row_delete_cell(): written_row_keys.append(row.row_key) assert written_row_keys == [row_key1] - # [START bigtable_row_delete_cell] + # [START bigtable_api_row_delete_cell] from google.cloud.bigtable import Client client = Client(admin=True) @@ -1141,7 +1141,7 @@ def test_bigtable_row_delete_cell(): row_obj.delete_cell(COLUMN_FAMILY_ID, COL_NAME1) row_obj.commit() - # [END bigtable_row_delete_cell] + # [END bigtable_api_row_delete_cell] for row in table.read_rows(): assert not row.row_key @@ -1162,7 +1162,7 @@ def test_bigtable_row_delete_cells(): written_row_keys.append(row.row_key) assert written_row_keys == [row_key1] - # [START bigtable_row_delete_cells] + # [START bigtable_api_row_delete_cells] from google.cloud.bigtable import Client client = Client(admin=True) @@ -1174,7 +1174,7 @@ def test_bigtable_row_delete_cells(): row_obj.delete_cells(COLUMN_FAMILY_ID, [COL_NAME1, COL_NAME2]) row_obj.commit() - # [END bigtable_row_delete_cells] + # [END bigtable_api_row_delete_cells] for row in table.read_rows(): assert not row.row_key @@ -1188,7 +1188,7 @@ def test_bigtable_row_clear(): mutation_size = row_obj.get_mutations_size() assert mutation_size > 0 - # [START bigtable_row_clear] + # [START bigtable_api_row_clear] from google.cloud.bigtable import Client client = Client(admin=True) @@ -1200,14 +1200,14 @@ def test_bigtable_row_clear(): row_obj.set_cell(COLUMN_FAMILY_ID, COL_NAME1, b"cell-val") row_obj.clear() - # [END bigtable_row_clear] + # [END bigtable_api_row_clear] mutation_size = row_obj.get_mutations_size() assert mutation_size == 0 def test_bigtable_row_clear_get_mutations_size(): - # [START bigtable_row_get_mutations_size] + # [START bigtable_api_row_get_mutations_size] from google.cloud.bigtable import Client client = Client(admin=True) @@ -1218,7 +1218,7 @@ def test_bigtable_row_clear_get_mutations_size(): row_obj = table.row(row_key_id) mutation_size = row_obj.get_mutations_size() - # [END bigtable_row_get_mutations_size] + # [END bigtable_api_row_get_mutations_size] row_obj.set_cell(COLUMN_FAMILY_ID, COL_NAME1, b"cell-val") mutation_size = row_obj.get_mutations_size() assert mutation_size > 0 @@ -1229,7 +1229,7 @@ def test_bigtable_row_clear_get_mutations_size(): def test_bigtable_row_setcell_commit_rowkey(): - # [START bigtable_row_set_cell] + # [START bigtable_api_row_set_cell] from google.cloud.bigtable import Client client = Client(admin=True) @@ -1240,10 +1240,10 @@ def test_bigtable_row_setcell_commit_rowkey(): cell_val = b"cell-val" row_obj = table.row(row_key) row_obj.set_cell(COLUMN_FAMILY_ID, COL_NAME1, cell_val) - # [END bigtable_row_set_cell] + # [END bigtable_api_row_set_cell] row_obj.commit() - # [START bigtable_row_commit] + # [START bigtable_api_row_commit] from google.cloud.bigtable import Client client = Client(admin=True) @@ -1255,7 +1255,7 @@ def test_bigtable_row_setcell_commit_rowkey(): row_obj = table.row(row_key) row_obj.set_cell(COLUMN_FAMILY_ID, COL_NAME1, cell_val) row_obj.commit() - # [END bigtable_row_commit] + # [END bigtable_api_row_commit] written_row_keys = [] for row in table.read_rows(): @@ -1263,7 +1263,7 @@ def test_bigtable_row_setcell_commit_rowkey(): assert written_row_keys == [b"row_key_1", b"row_key_2"] - # [START bigtable_row_row_key] + # [START bigtable_api_row_row_key] from google.cloud.bigtable import Client client = Client(admin=True) @@ -1273,7 +1273,7 @@ def test_bigtable_row_setcell_commit_rowkey(): row_key_id = b"row_key_2" row_obj = table.row(row_key_id) row_key = row_obj.row_key - # [END bigtable_row_row_key] + # [END bigtable_api_row_row_key] assert row_key == row_key_id table.truncate(timeout=300) @@ -1285,7 +1285,7 @@ def test_bigtable_row_append_cell_value(): row.set_cell(COLUMN_FAMILY_ID, COL_NAME1, cell_val1) row.commit() - # [START bigtable_row_append_cell_value] + # [START bigtable_api_row_append_cell_value] from google.cloud.bigtable import Client client = Client(admin=True) @@ -1295,14 +1295,14 @@ def test_bigtable_row_append_cell_value(): cell_val2 = b"2" row.append_cell_value(COLUMN_FAMILY_ID, COL_NAME1, cell_val2) - # [END bigtable_row_append_cell_value] + # [END bigtable_api_row_append_cell_value] row.commit() row_data = table.read_row(ROW_KEY1) actual_value = row_data.cell_value(COLUMN_FAMILY_ID, COL_NAME1) assert actual_value == cell_val1 + cell_val2 - # [START bigtable_row_commit] + # [START bigtable_api_row_commit] from google.cloud.bigtable import Client client = Client(admin=True) @@ -1312,9 +1312,9 @@ def test_bigtable_row_append_cell_value(): cell_val = 1 row.set_cell(COLUMN_FAMILY_ID, COL_NAME1, cell_val) row.commit() - # [END bigtable_row_commit] + # [END bigtable_api_row_commit] - # [START bigtable_row_increment_cell_value] + # [START bigtable_api_row_increment_cell_value] from google.cloud.bigtable import Client client = Client(admin=True) @@ -1324,7 +1324,7 @@ def test_bigtable_row_append_cell_value(): int_val = 3 row.increment_cell_value(COLUMN_FAMILY_ID, COL_NAME1, int_val) - # [END bigtable_row_increment_cell_value] + # [END bigtable_api_row_increment_cell_value] row.commit() row_data = table.read_row(ROW_KEY2) diff --git a/google/cloud/bigtable/app_profile.py b/google/cloud/bigtable/app_profile.py index 8b36eaede..ebf817c4e 100644 --- a/google/cloud/bigtable/app_profile.py +++ b/google/cloud/bigtable/app_profile.py @@ -93,8 +93,8 @@ def name(self): For example: .. literalinclude:: snippets.py - :start-after: [START bigtable_app_profile_name] - :end-before: [END bigtable_app_profile_name] + :start-after: [START bigtable_api_app_profile_name] + :end-before: [END bigtable_api_app_profile_name] :dedent: 4 The AppProfile name is of the form @@ -237,8 +237,8 @@ def reload(self): For example: .. literalinclude:: snippets.py - :start-after: [START bigtable_reload_app_profile] - :end-before: [END bigtable_reload_app_profile] + :start-after: [START bigtable_api_reload_app_profile] + :end-before: [END bigtable_api_reload_app_profile] :dedent: 4 """ @@ -254,8 +254,8 @@ def exists(self): For example: .. literalinclude:: snippets.py - :start-after: [START bigtable_app_profile_exists] - :end-before: [END bigtable_app_profile_exists] + :start-after: [START bigtable_api_app_profile_exists] + :end-before: [END bigtable_api_app_profile_exists] :dedent: 4 :rtype: bool @@ -281,8 +281,8 @@ def create(self, ignore_warnings=None): For example: .. literalinclude:: snippets.py - :start-after: [START bigtable_create_app_profile] - :end-before: [END bigtable_create_app_profile] + :start-after: [START bigtable_api_create_app_profile] + :end-before: [END bigtable_api_create_app_profile] :dedent: 4 :type: ignore_warnings: bool @@ -313,8 +313,8 @@ def update(self, ignore_warnings=None): For example: .. literalinclude:: snippets.py - :start-after: [START bigtable_update_app_profile] - :end-before: [END bigtable_update_app_profile] + :start-after: [START bigtable_api_update_app_profile] + :end-before: [END bigtable_api_update_app_profile] :dedent: 4 """ update_mask_pb = field_mask_pb2.FieldMask() @@ -339,8 +339,8 @@ def delete(self, ignore_warnings=None): For example: .. literalinclude:: snippets.py - :start-after: [START bigtable_delete_app_profile] - :end-before: [END bigtable_delete_app_profile] + :start-after: [START bigtable_api_delete_app_profile] + :end-before: [END bigtable_api_delete_app_profile] :dedent: 4 :type: ignore_warnings: bool diff --git a/google/cloud/bigtable/batcher.py b/google/cloud/bigtable/batcher.py index 782cb979a..950a198ef 100644 --- a/google/cloud/bigtable/batcher.py +++ b/google/cloud/bigtable/batcher.py @@ -71,8 +71,8 @@ def mutate(self, row): For example: .. literalinclude:: snippets.py - :start-after: [START bigtable_batcher_mutate] - :end-before: [END bigtable_batcher_mutate] + :start-after: [START bigtable_api_batcher_mutate] + :end-before: [END bigtable_api_batcher_mutate] :dedent: 4 :type row: class @@ -111,8 +111,8 @@ def mutate_rows(self, rows): For example: .. literalinclude:: snippets.py - :start-after: [START bigtable_batcher_mutate_rows] - :end-before: [END bigtable_batcher_mutate_rows] + :start-after: [START bigtable_api_batcher_mutate_rows] + :end-before: [END bigtable_api_batcher_mutate_rows] :dedent: 4 :type rows: list:[`~google.cloud.bigtable.row.DirectRow`] @@ -134,8 +134,8 @@ def flush(self): For example: .. literalinclude:: snippets.py - :start-after: [START bigtable_batcher_flush] - :end-before: [END bigtable_batcher_flush] + :start-after: [START bigtable_api_batcher_flush] + :end-before: [END bigtable_api_batcher_flush] :dedent: 4 """ diff --git a/google/cloud/bigtable/client.py b/google/cloud/bigtable/client.py index 2ee6e7c77..05f3b7761 100644 --- a/google/cloud/bigtable/client.py +++ b/google/cloud/bigtable/client.py @@ -208,8 +208,8 @@ def project_path(self): For example: .. literalinclude:: snippets.py - :start-after: [START bigtable_project_path] - :end-before: [END bigtable_project_path] + :start-after: [START bigtable_api_project_path] + :end-before: [END bigtable_api_project_path] :dedent: 4 The project name is of the form @@ -228,8 +228,8 @@ def table_data_client(self): For example: .. literalinclude:: snippets.py - :start-after: [START bigtable_table_data_client] - :end-before: [END bigtable_table_data_client] + :start-after: [START bigtable_api_table_data_client] + :end-before: [END bigtable_api_table_data_client] :dedent: 4 :rtype: :class:`.bigtable_v2.BigtableClient` @@ -249,8 +249,8 @@ def table_admin_client(self): For example: .. literalinclude:: snippets.py - :start-after: [START bigtable_table_admin_client] - :end-before: [END bigtable_table_admin_client] + :start-after: [START bigtable_api_table_admin_client] + :end-before: [END bigtable_api_table_admin_client] :dedent: 4 :rtype: :class:`.bigtable_admin_pb2.BigtableTableAdmin` @@ -276,8 +276,8 @@ def instance_admin_client(self): For example: .. literalinclude:: snippets.py - :start-after: [START bigtable_instance_admin_client] - :end-before: [END bigtable_instance_admin_client] + :start-after: [START bigtable_api_instance_admin_client] + :end-before: [END bigtable_api_instance_admin_client] :dedent: 4 :rtype: :class:`.bigtable_admin_pb2.BigtableInstanceAdmin` @@ -302,8 +302,8 @@ def instance(self, instance_id, display_name=None, instance_type=None, labels=No For example: .. literalinclude:: snippets.py - :start-after: [START bigtable_create_prod_instance] - :end-before: [END bigtable_create_prod_instance] + :start-after: [START bigtable_api_create_prod_instance] + :end-before: [END bigtable_api_create_prod_instance] :dedent: 4 :type instance_id: str @@ -352,8 +352,8 @@ def list_instances(self): For example: .. literalinclude:: snippets.py - :start-after: [START bigtable_list_instances] - :end-before: [END bigtable_list_instances] + :start-after: [START bigtable_api_list_instances] + :end-before: [END bigtable_api_list_instances] :dedent: 4 :rtype: tuple @@ -373,8 +373,8 @@ def list_clusters(self): For example: .. literalinclude:: snippets.py - :start-after: [START bigtable_list_clusters_in_project] - :end-before: [END bigtable_list_clusters_in_project] + :start-after: [START bigtable_api_list_clusters_in_project] + :end-before: [END bigtable_api_list_clusters_in_project] :dedent: 4 :rtype: tuple diff --git a/google/cloud/bigtable/cluster.py b/google/cloud/bigtable/cluster.py index 9048c94f4..1cf66f86b 100644 --- a/google/cloud/bigtable/cluster.py +++ b/google/cloud/bigtable/cluster.py @@ -97,8 +97,8 @@ def from_pb(cls, cluster_pb, instance): For example: .. literalinclude:: snippets.py - :start-after: [START bigtable_cluster_from_pb] - :end-before: [END bigtable_cluster_from_pb] + :start-after: [START bigtable_api_cluster_from_pb] + :end-before: [END bigtable_api_cluster_from_pb] :dedent: 4 :type cluster_pb: :class:`instance_pb2.Cluster` @@ -158,8 +158,8 @@ def name(self): For example: .. literalinclude:: snippets.py - :start-after: [START bigtable_cluster_name] - :end-before: [END bigtable_cluster_name] + :start-after: [START bigtable_api_cluster_name] + :end-before: [END bigtable_api_cluster_name] :dedent: 4 The cluster name is of the form @@ -180,8 +180,8 @@ def state(self): For example: .. literalinclude:: snippets.py - :start-after: [START bigtable_cluster_state] - :end-before: [END bigtable_cluster_state] + :start-after: [START bigtable_api_cluster_state] + :end-before: [END bigtable_api_cluster_state] :dedent: 4 """ @@ -207,8 +207,8 @@ def reload(self): For example: .. literalinclude:: snippets.py - :start-after: [START bigtable_reload_cluster] - :end-before: [END bigtable_reload_cluster] + :start-after: [START bigtable_api_reload_cluster] + :end-before: [END bigtable_api_reload_cluster] :dedent: 4 """ cluster_pb = self._instance._client.instance_admin_client.get_cluster(self.name) @@ -223,8 +223,8 @@ def exists(self): For example: .. literalinclude:: snippets.py - :start-after: [START bigtable_check_cluster_exists] - :end-before: [END bigtable_check_cluster_exists] + :start-after: [START bigtable_api_check_cluster_exists] + :end-before: [END bigtable_api_check_cluster_exists] :dedent: 4 :rtype: bool @@ -244,8 +244,8 @@ def create(self): For example: .. literalinclude:: snippets.py - :start-after: [START bigtable_create_cluster] - :end-before: [END bigtable_create_cluster] + :start-after: [START bigtable_api_create_cluster] + :end-before: [END bigtable_api_create_cluster] :dedent: 4 .. note:: @@ -278,8 +278,8 @@ def update(self): For example: .. literalinclude:: snippets.py - :start-after: [START bigtable_update_cluster] - :end-before: [END bigtable_update_cluster] + :start-after: [START bigtable_api_update_cluster] + :end-before: [END bigtable_api_update_cluster] :dedent: 4 .. note:: @@ -311,8 +311,8 @@ def delete(self): For example: .. literalinclude:: snippets.py - :start-after: [START bigtable_delete_cluster] - :end-before: [END bigtable_delete_cluster] + :start-after: [START bigtable_api_delete_cluster] + :end-before: [END bigtable_api_delete_cluster] :dedent: 4 Marks a cluster and all of its tables for permanent deletion in 7 days. diff --git a/google/cloud/bigtable/column_family.py b/google/cloud/bigtable/column_family.py index 0e884fa89..eb854cb8b 100644 --- a/google/cloud/bigtable/column_family.py +++ b/google/cloud/bigtable/column_family.py @@ -46,8 +46,8 @@ class MaxVersionsGCRule(GarbageCollectionRule): For example: .. literalinclude:: snippets_table.py - :start-after: [START bigtable_create_family_gc_max_versions] - :end-before: [END bigtable_create_family_gc_max_versions] + :start-after: [START bigtable_api_create_family_gc_max_versions] + :end-before: [END bigtable_api_create_family_gc_max_versions] :dedent: 4 :type max_num_versions: int @@ -80,8 +80,8 @@ class MaxAgeGCRule(GarbageCollectionRule): For example: .. literalinclude:: snippets_table.py - :start-after: [START bigtable_create_family_gc_max_age] - :end-before: [END bigtable_create_family_gc_max_age] + :start-after: [START bigtable_api_create_family_gc_max_age] + :end-before: [END bigtable_api_create_family_gc_max_age] :dedent: 4 :type max_age: :class:`datetime.timedelta` @@ -115,8 +115,8 @@ class GCRuleUnion(GarbageCollectionRule): For example: .. literalinclude:: snippets_table.py - :start-after: [START bigtable_create_family_gc_union] - :end-before: [END bigtable_create_family_gc_union] + :start-after: [START bigtable_api_create_family_gc_union] + :end-before: [END bigtable_api_create_family_gc_union] :dedent: 4 :type rules: list @@ -150,8 +150,8 @@ class GCRuleIntersection(GarbageCollectionRule): For example: .. literalinclude:: snippets_table.py - :start-after: [START bigtable_create_family_gc_intersection] - :end-before: [END bigtable_create_family_gc_intersection] + :start-after: [START bigtable_api_create_family_gc_intersection] + :end-before: [END bigtable_api_create_family_gc_intersection] :dedent: 4 :type rules: list @@ -214,8 +214,8 @@ def name(self): For example: .. literalinclude:: snippets_table.py - :start-after: [START bigtable_column_family_name] - :end-before: [END bigtable_column_family_name] + :start-after: [START bigtable_api_column_family_name] + :end-before: [END bigtable_api_column_family_name] :dedent: 4 .. note:: @@ -261,8 +261,8 @@ def create(self): For example: .. literalinclude:: snippets_table.py - :start-after: [START bigtable_create_column_family] - :end-before: [END bigtable_create_column_family] + :start-after: [START bigtable_api_create_column_family] + :end-before: [END bigtable_api_create_column_family] :dedent: 4 """ @@ -284,8 +284,8 @@ def update(self): For example: .. literalinclude:: snippets_table.py - :start-after: [START bigtable_update_column_family] - :end-before: [END bigtable_update_column_family] + :start-after: [START bigtable_api_update_column_family] + :end-before: [END bigtable_api_update_column_family] :dedent: 4 .. note:: @@ -311,8 +311,8 @@ def delete(self): For example: .. literalinclude:: snippets_table.py - :start-after: [START bigtable_delete_column_family] - :end-before: [END bigtable_delete_column_family] + :start-after: [START bigtable_api_delete_column_family] + :end-before: [END bigtable_api_delete_column_family] :dedent: 4 """ diff --git a/google/cloud/bigtable/instance.py b/google/cloud/bigtable/instance.py index 3656f40a4..a126ee27a 100644 --- a/google/cloud/bigtable/instance.py +++ b/google/cloud/bigtable/instance.py @@ -132,8 +132,8 @@ def from_pb(cls, instance_pb, client): For example: .. literalinclude:: snippets.py - :start-after: [START bigtable_instance_from_pb] - :end-before: [END bigtable_instance_from_pb] + :start-after: [START bigtable_api_instance_from_pb] + :end-before: [END bigtable_api_instance_from_pb] :dedent: 4 :type instance_pb: :class:`instance_pb2.Instance` @@ -177,8 +177,8 @@ def name(self): For example: .. literalinclude:: snippets.py - :start-after: [START bigtable_instance_name] - :end-before: [END bigtable_instance_name] + :start-after: [START bigtable_api_instance_name] + :end-before: [END bigtable_api_instance_name] :dedent: 4 The instance name is of the form @@ -199,8 +199,8 @@ def state(self): For example: .. literalinclude:: snippets.py - :start-after: [START bigtable_instance_state] - :end-before: [END bigtable_instance_state] + :start-after: [START bigtable_api_instance_state] + :end-before: [END bigtable_api_instance_state] :dedent: 4 """ @@ -232,8 +232,8 @@ def create( For example: .. literalinclude:: snippets.py - :start-after: [START bigtable_create_prod_instance] - :end-before: [END bigtable_create_prod_instance] + :start-after: [START bigtable_api_create_prod_instance] + :end-before: [END bigtable_api_create_prod_instance] :dedent: 4 .. note:: @@ -333,8 +333,8 @@ def exists(self): For example: .. literalinclude:: snippets.py - :start-after: [START bigtable_check_instance_exists] - :end-before: [END bigtable_check_instance_exists] + :start-after: [START bigtable_api_check_instance_exists] + :end-before: [END bigtable_api_check_instance_exists] :dedent: 4 :rtype: bool @@ -353,8 +353,8 @@ def reload(self): For example: .. literalinclude:: snippets.py - :start-after: [START bigtable_reload_instance] - :end-before: [END bigtable_reload_instance] + :start-after: [START bigtable_api_reload_instance] + :end-before: [END bigtable_api_reload_instance] :dedent: 4 """ instance_pb = self._client.instance_admin_client.get_instance(self.name) @@ -369,8 +369,8 @@ def update(self): For example: .. literalinclude:: snippets.py - :start-after: [START bigtable_update_instance] - :end-before: [END bigtable_update_instance] + :start-after: [START bigtable_api_update_instance] + :end-before: [END bigtable_api_update_instance] :dedent: 4 .. note:: @@ -416,8 +416,8 @@ def delete(self): For example: .. literalinclude:: snippets.py - :start-after: [START bigtable_delete_instance] - :end-before: [END bigtable_delete_instance] + :start-after: [START bigtable_api_delete_instance] + :end-before: [END bigtable_api_delete_instance] :dedent: 4 Marks an instance and all of its tables for permanent deletion @@ -447,8 +447,8 @@ def get_iam_policy(self, requested_policy_version=None): For example: .. literalinclude:: snippets.py - :start-after: [START bigtable_get_iam_policy] - :end-before: [END bigtable_get_iam_policy] + :start-after: [START bigtable_api_get_iam_policy] + :end-before: [END bigtable_api_get_iam_policy] :dedent: 4 :type requested_policy_version: int or ``NoneType`` @@ -487,8 +487,8 @@ class `google.cloud.bigtable.policy.Policy` For example: .. literalinclude:: snippets.py - :start-after: [START bigtable_set_iam_policy] - :end-before: [END bigtable_set_iam_policy] + :start-after: [START bigtable_api_set_iam_policy] + :end-before: [END bigtable_api_set_iam_policy] :dedent: 4 :type policy: :class:`google.cloud.bigtable.policy.Policy` @@ -511,8 +511,8 @@ def test_iam_permissions(self, permissions): For example: .. literalinclude:: snippets.py - :start-after: [START bigtable_test_iam_permissions] - :end-before: [END bigtable_test_iam_permissions] + :start-after: [START bigtable_api_test_iam_permissions] + :end-before: [END bigtable_api_test_iam_permissions] :dedent: 4 :type permissions: list @@ -541,8 +541,8 @@ def cluster( For example: .. literalinclude:: snippets.py - :start-after: [START bigtable_create_cluster] - :end-before: [END bigtable_create_cluster] + :start-after: [START bigtable_api_create_cluster] + :end-before: [END bigtable_api_create_cluster] :dedent: 4 :type cluster_id: str @@ -585,8 +585,8 @@ def list_clusters(self): For example: .. literalinclude:: snippets.py - :start-after: [START bigtable_list_clusters_on_instance] - :end-before: [END bigtable_list_clusters_on_instance] + :start-after: [START bigtable_api_list_clusters_on_instance] + :end-before: [END bigtable_api_list_clusters_on_instance] :dedent: 4 :rtype: tuple @@ -606,8 +606,8 @@ def table(self, table_id, mutation_timeout=None, app_profile_id=None): For example: .. literalinclude:: snippets.py - :start-after: [START bigtable_create_table] - :end-before: [END bigtable_create_table] + :start-after: [START bigtable_api_create_table] + :end-before: [END bigtable_api_create_table] :dedent: 4 :type table_id: str @@ -632,8 +632,8 @@ def list_tables(self): For example: .. literalinclude:: snippets.py - :start-after: [START bigtable_list_tables] - :end-before: [END bigtable_list_tables] + :start-after: [START bigtable_api_list_tables] + :end-before: [END bigtable_api_list_tables] :dedent: 4 :rtype: list of :class:`Table ` @@ -668,8 +668,8 @@ def app_profile( For example: .. literalinclude:: snippets.py - :start-after: [START bigtable_create_app_profile] - :end-before: [END bigtable_create_app_profile] + :start-after: [START bigtable_api_create_app_profile] + :end-before: [END bigtable_api_create_app_profile] :dedent: 4 :type app_profile_id: str @@ -715,8 +715,8 @@ def list_app_profiles(self): For example: .. literalinclude:: snippets.py - :start-after: [START bigtable_list_app_profiles] - :end-before: [END bigtable_list_app_profiles] + :start-after: [START bigtable_api_list_app_profiles] + :end-before: [END bigtable_api_list_app_profiles] :dedent: 4 :rtype: :list:[`~google.cloud.bigtable.app_profile.AppProfile`] diff --git a/google/cloud/bigtable/policy.py b/google/cloud/bigtable/policy.py index 1fd749424..f5558b6f0 100644 --- a/google/cloud/bigtable/policy.py +++ b/google/cloud/bigtable/policy.py @@ -104,8 +104,8 @@ def bigtable_admins(self): For example: .. literalinclude:: snippets.py - :start-after: [START bigtable_admins_policy] - :end-before: [END bigtable_admins_policy] + :start-after: [START bigtable_api_admins_policy] + :end-before: [END bigtable_api_admins_policy] :dedent: 4 """ result = set() @@ -122,8 +122,8 @@ def bigtable_readers(self): For example: .. literalinclude:: snippets.py - :start-after: [START bigtable_readers_policy] - :end-before: [END bigtable_readers_policy] + :start-after: [START bigtable_api_readers_policy] + :end-before: [END bigtable_api_readers_policy] :dedent: 4 """ result = set() @@ -140,8 +140,8 @@ def bigtable_users(self): For example: .. literalinclude:: snippets.py - :start-after: [START bigtable_users_policy] - :end-before: [END bigtable_users_policy] + :start-after: [START bigtable_api_users_policy] + :end-before: [END bigtable_api_users_policy] :dedent: 4 """ result = set() @@ -158,8 +158,8 @@ def bigtable_viewers(self): For example: .. literalinclude:: snippets.py - :start-after: [START bigtable_viewers_policy] - :end-before: [END bigtable_viewers_policy] + :start-after: [START bigtable_api_viewers_policy] + :end-before: [END bigtable_api_viewers_policy] :dedent: 4 """ result = set() diff --git a/google/cloud/bigtable/row.py b/google/cloud/bigtable/row.py index 87a268056..f3e4231e1 100644 --- a/google/cloud/bigtable/row.py +++ b/google/cloud/bigtable/row.py @@ -59,8 +59,8 @@ def row_key(self): For example: .. literalinclude:: snippets_table.py - :start-after: [START bigtable_row_row_key] - :end-before: [END bigtable_row_row_key] + :start-after: [START bigtable_api_row_row_key] + :end-before: [END bigtable_api_row_row_key] :dedent: 4 :rtype: bytes @@ -75,8 +75,8 @@ def table(self): For example: .. literalinclude:: snippets_table.py - :start-after: [START bigtable_row_table] - :end-before: [END bigtable_row_table] + :start-after: [START bigtable_api_row_table] + :end-before: [END bigtable_api_row_table] :dedent: 4 :rtype: table: :class:`Table ` @@ -300,8 +300,8 @@ def get_mutations_size(self): For example: .. literalinclude:: snippets_table.py - :start-after: [START bigtable_row_get_mutations_size] - :end-before: [END bigtable_row_get_mutations_size] + :start-after: [START bigtable_api_row_get_mutations_size] + :end-before: [END bigtable_api_row_get_mutations_size] :dedent: 4 """ @@ -328,8 +328,8 @@ def set_cell(self, column_family_id, column, value, timestamp=None): For example: .. literalinclude:: snippets_table.py - :start-after: [START bigtable_row_set_cell] - :end-before: [END bigtable_row_set_cell] + :start-after: [START bigtable_api_row_set_cell] + :end-before: [END bigtable_api_row_set_cell] :dedent: 4 :type column_family_id: str @@ -364,8 +364,8 @@ def delete(self): For example: .. literalinclude:: snippets_table.py - :start-after: [START bigtable_row_delete] - :end-before: [END bigtable_row_delete] + :start-after: [START bigtable_api_row_delete] + :end-before: [END bigtable_api_row_delete] :dedent: 4 """ self._delete(state=None) @@ -383,8 +383,8 @@ def delete_cell(self, column_family_id, column, time_range=None): For example: .. literalinclude:: snippets_table.py - :start-after: [START bigtable_row_delete_cell] - :end-before: [END bigtable_row_delete_cell] + :start-after: [START bigtable_api_row_delete_cell] + :end-before: [END bigtable_api_row_delete_cell] :dedent: 4 :type column_family_id: str @@ -417,8 +417,8 @@ def delete_cells(self, column_family_id, columns, time_range=None): For example: .. literalinclude:: snippets_table.py - :start-after: [START bigtable_row_delete_cells] - :end-before: [END bigtable_row_delete_cells] + :start-after: [START bigtable_api_row_delete_cells] + :end-before: [END bigtable_api_row_delete_cells] :dedent: 4 :type column_family_id: str @@ -453,8 +453,8 @@ def commit(self): For example: .. literalinclude:: snippets_table.py - :start-after: [START bigtable_row_commit] - :end-before: [END bigtable_row_commit] + :start-after: [START bigtable_api_row_commit] + :end-before: [END bigtable_api_row_commit] :dedent: 4 :rtype: :class:`~google.rpc.status_pb2.Status` @@ -475,8 +475,8 @@ def clear(self): For example: .. literalinclude:: snippets_table.py - :start-after: [START bigtable_row_clear] - :end-before: [END bigtable_row_clear] + :start-after: [START bigtable_api_row_clear] + :end-before: [END bigtable_api_row_clear] :dedent: 4 """ del self._pb_mutations[:] @@ -567,8 +567,8 @@ def commit(self): For example: .. literalinclude:: snippets_table.py - :start-after: [START bigtable_row_commit] - :end-before: [END bigtable_row_commit] + :start-after: [START bigtable_api_row_commit] + :end-before: [END bigtable_api_row_commit] :dedent: 4 :rtype: bool @@ -621,8 +621,8 @@ def set_cell(self, column_family_id, column, value, timestamp=None, state=True): For example: .. literalinclude:: snippets_table.py - :start-after: [START bigtable_row_set_cell] - :end-before: [END bigtable_row_set_cell] + :start-after: [START bigtable_api_row_set_cell] + :end-before: [END bigtable_api_row_set_cell] :dedent: 4 :type column_family_id: str @@ -663,8 +663,8 @@ def delete(self, state=True): For example: .. literalinclude:: snippets_table.py - :start-after: [START bigtable_row_delete] - :end-before: [END bigtable_row_delete] + :start-after: [START bigtable_api_row_delete] + :end-before: [END bigtable_api_row_delete] :dedent: 4 :type state: bool @@ -686,8 +686,8 @@ def delete_cell(self, column_family_id, column, time_range=None, state=True): For example: .. literalinclude:: snippets_table.py - :start-after: [START bigtable_row_delete_cell] - :end-before: [END bigtable_row_delete_cell] + :start-after: [START bigtable_api_row_delete_cell] + :end-before: [END bigtable_api_row_delete_cell] :dedent: 4 :type column_family_id: str @@ -724,8 +724,8 @@ def delete_cells(self, column_family_id, columns, time_range=None, state=True): For example: .. literalinclude:: snippets_table.py - :start-after: [START bigtable_row_delete_cells] - :end-before: [END bigtable_row_delete_cells] + :start-after: [START bigtable_api_row_delete_cells] + :end-before: [END bigtable_api_row_delete_cells] :dedent: 4 :type column_family_id: str @@ -759,8 +759,8 @@ def clear(self): For example: .. literalinclude:: snippets_table.py - :start-after: [START bigtable_row_clear] - :end-before: [END bigtable_row_clear] + :start-after: [START bigtable_api_row_clear] + :end-before: [END bigtable_api_row_clear] :dedent: 4 """ del self._true_pb_mutations[:] @@ -798,8 +798,8 @@ def clear(self): For example: .. literalinclude:: snippets_table.py - :start-after: [START bigtable_row_clear] - :end-before: [END bigtable_row_clear] + :start-after: [START bigtable_api_row_clear] + :end-before: [END bigtable_api_row_clear] :dedent: 4 """ del self._rule_pb_list[:] @@ -817,8 +817,8 @@ def append_cell_value(self, column_family_id, column, value): For example: .. literalinclude:: snippets_table.py - :start-after: [START bigtable_row_append_cell_value] - :end-before: [END bigtable_row_append_cell_value] + :start-after: [START bigtable_api_row_append_cell_value] + :end-before: [END bigtable_api_row_append_cell_value] :dedent: 4 :type column_family_id: str @@ -858,8 +858,8 @@ def increment_cell_value(self, column_family_id, column, int_value): For example: .. literalinclude:: snippets_table.py - :start-after: [START bigtable_row_increment_cell_value] - :end-before: [END bigtable_row_increment_cell_value] + :start-after: [START bigtable_api_row_increment_cell_value] + :end-before: [END bigtable_api_row_increment_cell_value] :dedent: 4 :type column_family_id: str @@ -905,8 +905,8 @@ def commit(self): For example: .. literalinclude:: snippets_table.py - :start-after: [START bigtable_row_commit] - :end-before: [END bigtable_row_commit] + :start-after: [START bigtable_api_row_commit] + :end-before: [END bigtable_api_row_commit] :dedent: 4 :rtype: dict diff --git a/google/cloud/bigtable/row_data.py b/google/cloud/bigtable/row_data.py index 8760d77b0..1cc442f2c 100644 --- a/google/cloud/bigtable/row_data.py +++ b/google/cloud/bigtable/row_data.py @@ -182,8 +182,8 @@ def cells(self): For example: .. literalinclude:: snippets_table.py - :start-after: [START bigtable_row_data_cells] - :end-before: [END bigtable_row_data_cells] + :start-after: [START bigtable_api_row_data_cells] + :end-before: [END bigtable_api_row_data_cells] :dedent: 4 :rtype: dict @@ -209,8 +209,8 @@ def find_cells(self, column_family_id, column): For example: .. literalinclude:: snippets_table.py - :start-after: [START bigtable_row_find_cells] - :end-before: [END bigtable_row_find_cells] + :start-after: [START bigtable_api_row_find_cells] + :end-before: [END bigtable_api_row_find_cells] :dedent: 4 Args: @@ -247,8 +247,8 @@ def cell_value(self, column_family_id, column, index=0): For example: .. literalinclude:: snippets_table.py - :start-after: [START bigtable_row_cell_value] - :end-before: [END bigtable_row_cell_value] + :start-after: [START bigtable_api_row_cell_value] + :end-before: [END bigtable_api_row_cell_value] :dedent: 4 Args: @@ -289,8 +289,8 @@ def cell_values(self, column_family_id, column, max_count=None): For example: .. literalinclude:: snippets_table.py - :start-after: [START bigtable_row_cell_values] - :end-before: [END bigtable_row_cell_values] + :start-after: [START bigtable_api_row_cell_values] + :end-before: [END bigtable_api_row_cell_values] :dedent: 4 Args: diff --git a/google/cloud/bigtable/row_set.py b/google/cloud/bigtable/row_set.py index e229c805a..7697af4f7 100644 --- a/google/cloud/bigtable/row_set.py +++ b/google/cloud/bigtable/row_set.py @@ -56,8 +56,8 @@ def add_row_key(self, row_key): For example: .. literalinclude:: snippets_table.py - :start-after: [START bigtable_add_row_key] - :end-before: [END bigtable_add_row_key] + :start-after: [START bigtable_api_add_row_key] + :end-before: [END bigtable_api_add_row_key] :dedent: 4 :type row_key: bytes @@ -71,8 +71,8 @@ def add_row_range(self, row_range): For example: .. literalinclude:: snippets_table.py - :start-after: [START bigtable_add_row_range] - :end-before: [END bigtable_add_row_range] + :start-after: [START bigtable_api_add_row_range] + :end-before: [END bigtable_api_add_row_range] :dedent: 4 :type row_range: class:`RowRange` @@ -88,8 +88,8 @@ def add_row_range_from_keys( For example: .. literalinclude:: snippets_table.py - :start-after: [START bigtable_row_range_from_keys] - :end-before: [END bigtable_row_range_from_keys] + :start-after: [START bigtable_api_row_range_from_keys] + :end-before: [END bigtable_api_row_range_from_keys] :dedent: 4 :type start_key: bytes @@ -118,8 +118,8 @@ def add_row_range_with_prefix(self, row_key_prefix): For example: .. literalinclude:: snippets_table.py - :start-after: [START bigtable_add_row_range_with_prefix] - :end-before: [END bigtable_add_row_range_with_prefix] + :start-after: [START bigtable_api_add_row_range_with_prefix] + :end-before: [END bigtable_api_add_row_range_with_prefix] :type row_key_prefix: str :param row_key_prefix: To retrieve all rows that start with this row key prefix. diff --git a/google/cloud/bigtable/table.py b/google/cloud/bigtable/table.py index 35ca43d24..887b74b02 100644 --- a/google/cloud/bigtable/table.py +++ b/google/cloud/bigtable/table.py @@ -120,8 +120,8 @@ def name(self): For example: .. literalinclude:: snippets_table.py - :start-after: [START bigtable_table_name] - :end-before: [END bigtable_table_name] + :start-after: [START bigtable_api_table_name] + :end-before: [END bigtable_api_table_name] :dedent: 4 .. note:: @@ -149,8 +149,8 @@ def get_iam_policy(self): For example: .. literalinclude:: snippets_table.py - :start-after: [START bigtable_table_get_iam_policy] - :end-before: [END bigtable_table_get_iam_policy] + :start-after: [START bigtable_api_table_get_iam_policy] + :end-before: [END bigtable_api_table_get_iam_policy] :dedent: 4 :rtype: :class:`google.cloud.bigtable.policy.Policy` @@ -170,8 +170,8 @@ class `google.cloud.bigtable.policy.Policy` For example: .. literalinclude:: snippets_table.py - :start-after: [START bigtable_table_set_iam_policy] - :end-before: [END bigtable_table_set_iam_policy] + :start-after: [START bigtable_api_table_set_iam_policy] + :end-before: [END bigtable_api_table_set_iam_policy] :dedent: 4 :type policy: :class:`google.cloud.bigtable.policy.Policy` @@ -192,8 +192,8 @@ def test_iam_permissions(self, permissions): For example: .. literalinclude:: snippets_table.py - :start-after: [START bigtable_table_test_iam_permissions] - :end-before: [END bigtable_table_test_iam_permissions] + :start-after: [START bigtable_api_table_test_iam_permissions] + :end-before: [END bigtable_api_table_test_iam_permissions] :dedent: 4 :type permissions: list @@ -220,8 +220,8 @@ def column_family(self, column_family_id, gc_rule=None): For example: .. literalinclude:: snippets_table.py - :start-after: [START bigtable_table_column_family] - :end-before: [END bigtable_table_column_family] + :start-after: [START bigtable_api_table_column_family] + :end-before: [END bigtable_api_table_column_family] :dedent: 4 :type column_family_id: str @@ -243,8 +243,8 @@ def row(self, row_key, filter_=None, append=False): For example: .. literalinclude:: snippets_table.py - :start-after: [START bigtable_table_row] - :end-before: [END bigtable_table_row] + :start-after: [START bigtable_api_table_row] + :end-before: [END bigtable_api_table_row] :dedent: 4 .. warning:: @@ -291,8 +291,8 @@ def append_row(self, row_key): For example: .. literalinclude:: snippets_table.py - :start-after: [START bigtable_table_append_row] - :end-before: [END bigtable_table_append_row] + :start-after: [START bigtable_api_table_append_row] + :end-before: [END bigtable_api_table_append_row] :dedent: 4 Args: @@ -309,8 +309,8 @@ def direct_row(self, row_key): For example: .. literalinclude:: snippets_table.py - :start-after: [START bigtable_table_direct_row] - :end-before: [END bigtable_table_direct_row] + :start-after: [START bigtable_api_table_direct_row] + :end-before: [END bigtable_api_table_direct_row] :dedent: 4 Args: @@ -327,8 +327,8 @@ def conditional_row(self, row_key, filter_): For example: .. literalinclude:: snippets_table.py - :start-after: [START bigtable_table_conditional_row] - :end-before: [END bigtable_table_conditional_row] + :start-after: [START bigtable_api_table_conditional_row] + :end-before: [END bigtable_api_table_conditional_row] :dedent: 4 Args: @@ -356,8 +356,8 @@ def create(self, initial_split_keys=[], column_families={}): For example: .. literalinclude:: snippets_table.py - :start-after: [START bigtable_create_table] - :end-before: [END bigtable_create_table] + :start-after: [START bigtable_api_create_table] + :end-before: [END bigtable_api_create_table] :dedent: 4 .. note:: @@ -401,8 +401,8 @@ def exists(self): For example: .. literalinclude:: snippets_table.py - :start-after: [START bigtable_check_table_exists] - :end-before: [END bigtable_check_table_exists] + :start-after: [START bigtable_api_check_table_exists] + :end-before: [END bigtable_api_check_table_exists] :dedent: 4 :rtype: bool @@ -421,8 +421,8 @@ def delete(self): For example: .. literalinclude:: snippets_table.py - :start-after: [START bigtable_delete_table] - :end-before: [END bigtable_delete_table] + :start-after: [START bigtable_api_delete_table] + :end-before: [END bigtable_api_delete_table] :dedent: 4 """ table_client = self._instance._client.table_admin_client @@ -434,8 +434,8 @@ def list_column_families(self): For example: .. literalinclude:: snippets_table.py - :start-after: [START bigtable_list_column_families] - :end-before: [END bigtable_list_column_families] + :start-after: [START bigtable_api_list_column_families] + :end-before: [END bigtable_api_list_column_families] :dedent: 4 :rtype: dict @@ -462,8 +462,8 @@ def get_cluster_states(self): For example: .. literalinclude:: snippets_table.py - :start-after: [START bigtable_get_cluster_states] - :end-before: [END bigtable_get_cluster_states] + :start-after: [START bigtable_api_get_cluster_states] + :end-before: [END bigtable_api_get_cluster_states] :dedent: 4 :rtype: dict @@ -487,8 +487,8 @@ def read_row(self, row_key, filter_=None): For example: .. literalinclude:: snippets_table.py - :start-after: [START bigtable_read_row] - :end-before: [END bigtable_read_row] + :start-after: [START bigtable_api_read_row] + :end-before: [END bigtable_api_read_row] :dedent: 4 :type row_key: bytes @@ -527,8 +527,8 @@ def read_rows( For example: .. literalinclude:: snippets_table.py - :start-after: [START bigtable_read_rows] - :end-before: [END bigtable_read_rows] + :start-after: [START bigtable_api_read_rows] + :end-before: [END bigtable_api_read_rows] :dedent: 4 :type start_key: bytes @@ -631,8 +631,8 @@ def mutate_rows(self, rows, retry=DEFAULT_RETRY, timeout=DEFAULT): For example: .. literalinclude:: snippets_table.py - :start-after: [START bigtable_mutate_rows] - :end-before: [END bigtable_mutate_rows] + :start-after: [START bigtable_api_mutate_rows] + :end-before: [END bigtable_api_mutate_rows] :dedent: 4 The method tries to update all specified rows. @@ -682,8 +682,8 @@ def sample_row_keys(self): For example: .. literalinclude:: snippets_table.py - :start-after: [START bigtable_sample_row_keys] - :end-before: [END bigtable_sample_row_keys] + :start-after: [START bigtable_api_sample_row_keys] + :end-before: [END bigtable_api_sample_row_keys] :dedent: 4 The returned row keys will delimit contiguous sections of the table of @@ -727,8 +727,8 @@ def truncate(self, timeout=None): For example: .. literalinclude:: snippets_table.py - :start-after: [START bigtable_truncate_table] - :end-before: [END bigtable_truncate_table] + :start-after: [START bigtable_api_truncate_table] + :end-before: [END bigtable_api_truncate_table] :dedent: 4 :type timeout: float @@ -758,8 +758,8 @@ def drop_by_prefix(self, row_key_prefix, timeout=None): For example: .. literalinclude:: snippets_table.py - :start-after: [START bigtable_drop_by_prefix] - :end-before: [END bigtable_drop_by_prefix] + :start-after: [START bigtable_api_drop_by_prefix] + :end-before: [END bigtable_api_drop_by_prefix] :dedent: 4 :type row_key_prefix: bytes @@ -793,8 +793,8 @@ def mutations_batcher(self, flush_count=FLUSH_COUNT, max_row_bytes=MAX_ROW_BYTES For example: .. literalinclude:: snippets_table.py - :start-after: [START bigtable_mutations_batcher] - :end-before: [END bigtable_mutations_batcher] + :start-after: [START bigtable_api_mutations_batcher] + :end-before: [END bigtable_api_mutations_batcher] :dedent: 4 :type flush_count: int