Skip to content

Commit 16e8be8

Browse files
committed
impl(v3): remove deprecated Bigtable Admin classes
1 parent 2b9130f commit 16e8be8

28 files changed

Lines changed: 597 additions & 4667 deletions

doc/v3-migration-guide.md

Lines changed: 114 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -487,6 +487,120 @@ internal legacy files.
487487

488488
</details>
489489

490+
<details>
491+
<summary>Removed <code>bigtable::AdminClient</code> and <code>bigtable::TableAdmin</code></summary>
492+
493+
The `bigtable::AdminClient` class and `bigtable::TableAdmin` class have been
494+
replaced with `bigtable_admin::BigtableTableAdminClient`.
495+
496+
**Before:**
497+
498+
```cpp
499+
500+
std::shared_ptr<bigtable::AdminClient> admin_client =
501+
bigtable::MakeAdminClient("project-id");
502+
auto table_admin = std::make_unique<bigtable::TableAdmin>(
503+
admin_client, "instance-id");
504+
505+
// Drop a selection of rows by key prefix.
506+
auto result = table_admin.DropRowByPrefix("table-id", "row-key-prefix");
507+
508+
// Drop all rows.
509+
result = table_admin.DropAllRows("table-id");
510+
```
511+
512+
**After:**
513+
514+
```cpp
515+
#include "google/cloud/bigtable/admin/bigtable_table_admin_client.h"
516+
517+
auto table_admin = bigtable_admin::BigtableTableAdminClient(
518+
bigtable_admin::MakeBigtableAdminConnection());
519+
auto table_name = bigtable::TableName("project-id", "instance-id", "table-id");
520+
521+
// Drop a selection of rows by key prefix.
522+
google::bigtable::admin::v2::DropRowRangeRequest drop_rows_by_prefix;
523+
drop_rows_by_prefix.set_name(table_name);
524+
drop_rows_by_prefix.set_row_key_prefix("row-key-prefix");
525+
auto result = table_admin.DropRowRange(drop_rows_by_prefix);
526+
527+
// Drop all rows.
528+
google::bigtable::admin::v2::DropRowRangeRequest drop_all_rows;
529+
drop_all_rows.set_name(table_name);
530+
drop_all_rows.set_delete_all_data_from_table(true);
531+
result = table_admin.DropRowRange(drop_all_rows);
532+
```
533+
534+
</details>
535+
536+
<details><summary><code>WaitForConsistency</code> is now a free function</summary>
537+
538+
With the removal of the `bigtable::TableAdmin` class, `WaitForConsistency` is
539+
now a free function.
540+
541+
**Before:**
542+
543+
```cpp
544+
545+
std::shared_ptr<bigtable::AdminClient> admin_client =
546+
bigtable::MakeAdminClient("project-id");
547+
auto table_admin = std::make_unique<bigtable::TableAdmin>(
548+
admin_client, "instance-id");
549+
550+
auto token = table_admin.GenerateConsistencyToken("table-id");
551+
if (!token) throw std::runtime_error(token.status().message());
552+
auto result = table_admin.WaitForConsistency("table-id", *token);
553+
```
554+
555+
**After:**
556+
557+
```cpp
558+
#include "google/cloud/bigtable/admin/bigtable_table_admin_client.h"
559+
#include "google/cloud/bigtable/wait_for_consistency.h"
560+
561+
auto connection = bigtable_admin::MakeBigtableAdminConnection();
562+
auto table_admin = bigtable_admin::BigtableTableAdminClient(connection);
563+
auto table_name = bigtable::TableName("project-id", "instance-id", "table-id");
564+
565+
auto token = table_admin.GenerateConsistencyToken(table_name);
566+
if (!token) throw std::runtime_error(token.status().message());
567+
auto result = bigtable_admin::WaitForConsistency(connection, table_name,
568+
token->consistency_token());
569+
```
570+
571+
</details>
572+
573+
<details>
574+
<summary>Removed <code>bigtable::InstanceAdminClient</code> and <code>bigtable::InstanceAdmin</code></summary>
575+
576+
The `bigtable::InstanceAdminClient` class and `bigtable::InstanceAdmin` class
577+
have been replaced with `bigtable_admin::BigtableInstanceAdminClient`.
578+
579+
**Before:**
580+
581+
```cpp
582+
auto instance_admin_client = bigtable::MakeInstanceAdminClient("project-id");
583+
auto instance_admin =
584+
std::make_unique<bigtable::InstanceAdmin>(instance_admin_client);
585+
586+
auto clusters = instance_admin->ListClusters();
587+
```
588+
589+
**After:**
590+
591+
```cpp
592+
#include "google/cloud/bigtable/admin/bigtable_instance_admin_client.h"
593+
594+
auto instance_admin =
595+
std::make_unique<bigtable_admin::BigtableInstanceAdminClient>(
596+
bigtable_admin::MakeBigtableInstanceAdminConnection());
597+
598+
auto clusters = instance_admin->ListClusters(
599+
InstanceName("project-id", "instance-id"));
600+
```
601+
602+
</details>
603+
490604
### Pubsub
491605
492606
<details>

google/cloud/bigtable/CMakeLists.txt

Lines changed: 0 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -104,8 +104,6 @@ add_library(
104104
admin/internal/bigtable_table_admin_tracing_connection.h
105105
admin/internal/bigtable_table_admin_tracing_stub.cc
106106
admin/internal/bigtable_table_admin_tracing_stub.h
107-
admin_client.cc
108-
admin_client.h
109107
app_profile_config.cc
110108
app_profile_config.h
111109
bound_query.cc
@@ -131,10 +129,6 @@ add_library(
131129
iam_policy.h
132130
idempotent_mutation_policy.cc
133131
idempotent_mutation_policy.h
134-
instance_admin.cc
135-
instance_admin.h
136-
instance_admin_client.cc
137-
instance_admin_client.h
138132
instance_config.cc
139133
instance_config.h
140134
instance_list_responses.h
@@ -259,8 +253,6 @@ add_library(
259253
sql_statement.h
260254
table.cc
261255
table.h
262-
table_admin.cc
263-
table_admin.h
264256
table_config.cc
265257
table_config.h
266258
table_resource.cc
@@ -424,7 +416,6 @@ if (BUILD_TESTING)
424416
# List the unit tests, then setup the targets and dependencies.
425417
set(bigtable_client_unit_tests
426418
# cmake-format: sort
427-
admin_client_test.cc
428419
app_profile_config_test.cc
429420
async_read_stream_test.cc
430421
bigtable_version_test.cc
@@ -441,8 +432,6 @@ if (BUILD_TESTING)
441432
iam_binding_test.cc
442433
iam_policy_test.cc
443434
idempotent_mutation_policy_test.cc
444-
instance_admin_client_test.cc
445-
instance_admin_test.cc
446435
instance_config_test.cc
447436
instance_resource_test.cc
448437
instance_update_config_test.cc
@@ -490,7 +479,6 @@ if (BUILD_TESTING)
490479
rpc_backoff_policy_test.cc
491480
rpc_retry_policy_test.cc
492481
sql_statement_test.cc
493-
table_admin_test.cc
494482
table_config_test.cc
495483
table_resource_test.cc
496484
table_test.cc

google/cloud/bigtable/admin_client.cc

Lines changed: 0 additions & 34 deletions
This file was deleted.

google/cloud/bigtable/admin_client.h

Lines changed: 0 additions & 73 deletions
This file was deleted.

google/cloud/bigtable/admin_client_test.cc

Lines changed: 0 additions & 34 deletions
This file was deleted.

google/cloud/bigtable/bigtable_client_unit_tests.bzl

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,6 @@
1717
"""Automatically generated unit tests list - DO NOT EDIT."""
1818

1919
bigtable_client_unit_tests = [
20-
"admin_client_test.cc",
2120
"app_profile_config_test.cc",
2221
"async_read_stream_test.cc",
2322
"bigtable_version_test.cc",
@@ -34,8 +33,6 @@ bigtable_client_unit_tests = [
3433
"iam_binding_test.cc",
3534
"iam_policy_test.cc",
3635
"idempotent_mutation_policy_test.cc",
37-
"instance_admin_client_test.cc",
38-
"instance_admin_test.cc",
3936
"instance_config_test.cc",
4037
"instance_resource_test.cc",
4138
"instance_update_config_test.cc",
@@ -83,7 +80,6 @@ bigtable_client_unit_tests = [
8380
"rpc_backoff_policy_test.cc",
8481
"rpc_retry_policy_test.cc",
8582
"sql_statement_test.cc",
86-
"table_admin_test.cc",
8783
"table_config_test.cc",
8884
"table_resource_test.cc",
8985
"table_test.cc",

google/cloud/bigtable/ci/run_integration_tests_emulator_bazel.sh

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -59,8 +59,8 @@ source module /google/cloud/bigtable/tools/run_emulator_utils.sh
5959
production_only_targets=(
6060
"//google/cloud/bigtable/examples:bigtable_table_admin_backup_snippets"
6161
"//google/cloud/bigtable/examples:table_admin_iam_policy_snippets"
62-
"//google/cloud/bigtable/tests:admin_backup_integration_test"
63-
"//google/cloud/bigtable/tests:admin_iam_policy_integration_test"
62+
"//google/cloud/bigtable/tests:table_admin_backup_integration_test"
63+
"//google/cloud/bigtable/tests:table_admin_iam_policy_integration_test"
6464
)
6565

6666
# Coverage builds are more subject to flakiness, as we must explicitly disable

0 commit comments

Comments
 (0)