Skip to content

Commit 46847d2

Browse files
authored
impl(v3): remove deprecated Bigtable admin classes (#15920)
1 parent 918cac8 commit 46847d2

30 files changed

Lines changed: 508 additions & 5315 deletions
-28.8 KB
Binary file not shown.

doc/v3-migration-guide.md

Lines changed: 116 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -487,6 +487,122 @@ 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` has
539+
been moved to `bigtable_admin::BigtableTableAdminClient::WaitForConsistency`.
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+
560+
auto connection = bigtable_admin::MakeBigtableAdminConnection();
561+
auto table_admin = bigtable_admin::BigtableTableAdminClient(connection);
562+
auto table_name = bigtable::TableName("project-id", "instance-id", "table-id");
563+
564+
auto token = table_admin.GenerateConsistencyToken(table_name);
565+
if (!token) throw std::runtime_error(token.status().message());
566+
567+
google::bigtable::admin::v2::CheckConsistencyRequest wait_request;
568+
wait_request.set_name(table_name);
569+
wait_request.set_consistency_token(token->consistency_token());
570+
auto wait_response = table_admin.WaitForConsistency(wait_request).get();
571+
```
572+
573+
</details>
574+
575+
<details>
576+
<summary>Removed <code>bigtable::InstanceAdminClient</code> and <code>bigtable::InstanceAdmin</code></summary>
577+
578+
The `bigtable::InstanceAdminClient` class and `bigtable::InstanceAdmin` class
579+
have been replaced with `bigtable_admin::BigtableInstanceAdminClient`.
580+
581+
**Before:**
582+
583+
```cpp
584+
auto instance_admin_client = bigtable::MakeInstanceAdminClient("project-id");
585+
auto instance_admin =
586+
std::make_unique<bigtable::InstanceAdmin>(instance_admin_client);
587+
588+
auto clusters = instance_admin->ListClusters();
589+
```
590+
591+
**After:**
592+
593+
```cpp
594+
#include "google/cloud/bigtable/admin/bigtable_instance_admin_client.h"
595+
596+
auto instance_admin =
597+
std::make_unique<bigtable_admin::BigtableInstanceAdminClient>(
598+
bigtable_admin::MakeBigtableInstanceAdminConnection());
599+
600+
auto clusters = instance_admin->ListClusters(
601+
InstanceName("project-id", "instance-id"));
602+
```
603+
604+
</details>
605+
490606
### Pubsub
491607
492608
<details>

google/cloud/bigtable/CMakeLists.txt

Lines changed: 2 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -105,8 +105,6 @@ add_library(
105105
admin/internal/bigtable_table_admin_tracing_connection.h
106106
admin/internal/bigtable_table_admin_tracing_stub.cc
107107
admin/internal/bigtable_table_admin_tracing_stub.h
108-
admin_client.cc
109-
admin_client.h
110108
app_profile_config.cc
111109
app_profile_config.h
112110
bound_query.cc
@@ -132,10 +130,6 @@ add_library(
132130
iam_policy.h
133131
idempotent_mutation_policy.cc
134132
idempotent_mutation_policy.h
135-
instance_admin.cc
136-
instance_admin.h
137-
instance_admin_client.cc
138-
instance_admin_client.h
139133
instance_config.cc
140134
instance_config.h
141135
instance_list_responses.h
@@ -260,8 +254,6 @@ add_library(
260254
sql_statement.h
261255
table.cc
262256
table.h
263-
table_admin.cc
264-
table_admin.h
265257
table_config.cc
266258
table_config.h
267259
table_resource.cc
@@ -272,9 +264,7 @@ add_library(
272264
value.h
273265
version.cc
274266
version.h
275-
version_info.h
276-
wait_for_consistency.cc
277-
wait_for_consistency.h)
267+
version_info.h)
278268
target_link_libraries(
279269
google_cloud_cpp_bigtable
280270
PUBLIC absl::memory
@@ -425,7 +415,6 @@ if (BUILD_TESTING)
425415
# List the unit tests, then setup the targets and dependencies.
426416
set(bigtable_client_unit_tests
427417
# cmake-format: sort
428-
admin_client_test.cc
429418
app_profile_config_test.cc
430419
async_read_stream_test.cc
431420
bigtable_version_test.cc
@@ -442,8 +431,6 @@ if (BUILD_TESTING)
442431
iam_binding_test.cc
443432
iam_policy_test.cc
444433
idempotent_mutation_policy_test.cc
445-
instance_admin_client_test.cc
446-
instance_admin_test.cc
447434
instance_config_test.cc
448435
instance_resource_test.cc
449436
instance_update_config_test.cc
@@ -491,15 +478,13 @@ if (BUILD_TESTING)
491478
rpc_backoff_policy_test.cc
492479
rpc_retry_policy_test.cc
493480
sql_statement_test.cc
494-
table_admin_test.cc
495481
table_config_test.cc
496482
table_resource_test.cc
497483
table_test.cc
498484
testing/cleanup_stale_resources_test.cc
499485
testing/random_names_test.cc
500486
timestamp_test.cc
501-
value_test.cc
502-
wait_for_consistency_test.cc)
487+
value_test.cc)
503488

504489
# Export the list of unit tests so the Bazel BUILD file can pick it up.
505490
export_list_to_bazel("bigtable_client_unit_tests.bzl"

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 & 5 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,13 +80,11 @@ 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",
9086
"testing/cleanup_stale_resources_test.cc",
9187
"testing/random_names_test.cc",
9288
"timestamp_test.cc",
9389
"value_test.cc",
94-
"wait_for_consistency_test.cc",
9590
]

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

google/cloud/bigtable/examples/table_admin_snippets.cc

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,10 +14,8 @@
1414

1515
#include "google/cloud/bigtable/admin/bigtable_table_admin_client.h"
1616
#include "google/cloud/bigtable/examples/bigtable_examples_common.h"
17-
#include "google/cloud/bigtable/table_admin.h"
1817
#include "google/cloud/bigtable/testing/cleanup_stale_resources.h"
1918
#include "google/cloud/bigtable/testing/random_names.h"
20-
#include "google/cloud/bigtable/wait_for_consistency.h"
2119
#include "google/cloud/internal/getenv.h"
2220
#include "google/cloud/log.h"
2321
#include <chrono>

0 commit comments

Comments
 (0)