-
Notifications
You must be signed in to change notification settings - Fork 1.6k
feat(bigtable): wrap admin client #14534
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,72 @@ | ||
| // Copyright 2026 Google LLC | ||
| // | ||
| // Licensed under the Apache License, Version 2.0 (the "License"); | ||
| // you may not use this file except in compliance with the License. | ||
| // You may obtain a copy of the License at | ||
| // | ||
| // https://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, software | ||
| // distributed under the License is distributed on an "AS IS" BASIS, | ||
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| // See the License for the specific language governing permissions and | ||
| // limitations under the License. | ||
|
|
||
| package admin | ||
|
|
||
| import ( | ||
| "context" | ||
| "time" | ||
|
|
||
| adminpb "cloud.google.com/go/bigtable/admin/apiv2/adminpb" | ||
| gax "github.com/googleapis/gax-go/v2" | ||
| ) | ||
|
|
||
| // RestoreTable creates a new table by restoring from a backup. | ||
| func (c *BigtableTableAdminClient) RestoreTable(ctx context.Context, req *adminpb.RestoreTableRequest, opts ...gax.CallOption) error { | ||
| op, err := c.restoreTable(ctx, req, opts...) | ||
| if err != nil { | ||
| return err | ||
| } | ||
|
|
||
| // Poll the LRO until the table is usable | ||
| if _, err := op.Wait(ctx, opts...); err != nil { | ||
| return err | ||
| } | ||
|
|
||
| return nil | ||
| } | ||
|
|
||
| // WaitForConsistency waits until all the writes committed before the call started have been propagated to all the clusters in the instance via replication. | ||
| func (c *BigtableTableAdminClient) WaitForConsistency(ctx context.Context, tableName string, opts ...gax.CallOption) error { | ||
| // Get the token. | ||
| tokenResp, err := c.GenerateConsistencyToken(ctx, &adminpb.GenerateConsistencyTokenRequest{ | ||
| Name: tableName, | ||
| }, opts...) | ||
| if err != nil { | ||
| return err | ||
| } | ||
| token := tokenResp.GetConsistencyToken() | ||
|
|
||
| // Periodically check if the token is consistent. | ||
| timer := time.NewTicker(time.Second * 10) | ||
| defer timer.Stop() | ||
| for { | ||
| consistentResp, err := c.CheckConsistency(ctx, &adminpb.CheckConsistencyRequest{ | ||
| Name: tableName, | ||
| ConsistencyToken: token, | ||
| }, opts...) | ||
| if err != nil { | ||
| return err | ||
| } | ||
| if consistentResp.GetConsistent() { | ||
| return nil | ||
| } | ||
| // Sleep for a bit or until the ctx is cancelled. | ||
| select { | ||
| case <-ctx.Done(): | ||
| return ctx.Err() | ||
| case <-timer.C: | ||
| } | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,204 @@ | ||
| // Copyright 2026 Google LLC | ||
| // | ||
| // Licensed under the Apache License, Version 2.0 (the "License"); | ||
| // you may not use this file except in compliance with the License. | ||
| // You may obtain a copy of the License at | ||
| // | ||
| // https://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, software | ||
| // distributed under the License is distributed on an "AS IS" BASIS, | ||
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| // See the License for the specific language governing permissions and | ||
| // limitations under the License. | ||
|
|
||
| package admin | ||
|
|
||
| import ( | ||
| "context" | ||
| "fmt" | ||
| "os" | ||
| "testing" | ||
| "time" | ||
|
|
||
| adminpb "cloud.google.com/go/bigtable/admin/apiv2/adminpb" | ||
| "google.golang.org/api/option" | ||
| "google.golang.org/grpc" | ||
| "google.golang.org/grpc/codes" | ||
| "google.golang.org/grpc/credentials/insecure" | ||
| "google.golang.org/grpc/status" | ||
| "google.golang.org/protobuf/types/known/timestamppb" | ||
| ) | ||
|
|
||
| type testEnv struct { | ||
| client *BigtableTableAdminClient | ||
| project string | ||
| instance string | ||
| cluster string | ||
| } | ||
|
|
||
| func setupIntegration(t *testing.T) *testEnv { | ||
| t.Helper() | ||
| if testing.Short() { | ||
| t.Skip("Skipping integration test in short mode") | ||
| } | ||
|
|
||
| ctx := context.Background() | ||
| emulatorHost := os.Getenv("BIGTABLE_EMULATOR_HOST") | ||
| var opts []option.ClientOption | ||
| project := os.Getenv("GCLOUD_TESTS_GOLANG_PROJECT_ID") | ||
| instance := os.Getenv("GCLOUD_TESTS_BIGTABLE_INSTANCE") | ||
| cluster := os.Getenv("GCLOUD_TESTS_BIGTABLE_CLUSTER") | ||
|
|
||
| if emulatorHost != "" { | ||
| t.Logf("Using emulator at %s", emulatorHost) | ||
| opts = append(opts, | ||
| option.WithEndpoint(emulatorHost), | ||
| option.WithGRPCDialOption(grpc.WithTransportCredentials(insecure.NewCredentials())), | ||
| ) | ||
| if project == "" { | ||
| project = "test-project" | ||
| } | ||
| if instance == "" { | ||
| instance = "test-instance" | ||
| } | ||
| if cluster == "" { | ||
| cluster = "test-cluster" | ||
| } | ||
| } else if project == "" || instance == "" { | ||
| t.Skip("Missing GCLOUD_TESTS_GOLANG_PROJECT_ID or GCLOUD_TESTS_BIGTABLE_INSTANCE for non-emulator run") | ||
| } | ||
|
|
||
| client, err := NewBigtableTableAdminClient(ctx, opts...) | ||
| if err != nil { | ||
| t.Fatalf("Failed to create client: %v", err) | ||
| } | ||
| t.Cleanup(func() { | ||
| client.Close() | ||
| }) | ||
|
|
||
| return &testEnv{ | ||
| client: client, | ||
| project: project, | ||
| instance: instance, | ||
| cluster: cluster, | ||
| } | ||
| } | ||
|
|
||
| func TestIntegration_RestoreTable(t *testing.T) { | ||
| env := setupIntegration(t) | ||
| if os.Getenv("BIGTABLE_EMULATOR_HOST") == "" && env.cluster == "" { | ||
| t.Skip("Missing GCLOUD_TESTS_BIGTABLE_CLUSTER for non-emulator run") | ||
| } | ||
|
|
||
| ctx := context.Background() | ||
| client := env.client | ||
|
|
||
| suffix := time.Now().Format("20060102-150405") | ||
| sourceTableID := fmt.Sprintf("src-table-%s", suffix) | ||
| backupID := fmt.Sprintf("backup-%s", suffix) | ||
| restoredTableID := fmt.Sprintf("restored-table-%s", suffix) | ||
|
|
||
| instancePath := fmt.Sprintf("projects/%s/instances/%s", env.project, env.instance) | ||
| sourceTablePath := fmt.Sprintf("%s/tables/%s", instancePath, sourceTableID) | ||
| clusterPath := fmt.Sprintf("%s/clusters/%s", instancePath, env.cluster) | ||
| backupPath := fmt.Sprintf("%s/backups/%s", clusterPath, backupID) | ||
| restoredTablePath := fmt.Sprintf("%s/tables/%s", instancePath, restoredTableID) | ||
|
|
||
| // 1. Create source table | ||
| _, err := client.CreateTable(ctx, &adminpb.CreateTableRequest{ | ||
| Parent: instancePath, | ||
| TableId: sourceTableID, | ||
| Table: &adminpb.Table{}, | ||
| }) | ||
| if err != nil { | ||
| t.Fatalf("Failed to create source table: %v", err) | ||
| } | ||
| t.Cleanup(func() { | ||
| client.DeleteTable(ctx, &adminpb.DeleteTableRequest{Name: sourceTablePath}) | ||
| }) | ||
|
|
||
| // 2. Create backup | ||
| expireTime := time.Now().Add(7 * time.Hour) | ||
| opCreateBackup, err := client.CreateBackup(ctx, &adminpb.CreateBackupRequest{ | ||
| Parent: clusterPath, | ||
| BackupId: backupID, | ||
| Backup: &adminpb.Backup{ | ||
| SourceTable: sourceTablePath, | ||
| ExpireTime: timestamppb.New(expireTime), | ||
| }, | ||
| }) | ||
| if err != nil { | ||
| st, ok := status.FromError(err) | ||
| if ok && st.Code() == codes.Unimplemented { | ||
| t.Skip("Emulator does not support CreateBackup") | ||
| } | ||
| t.Fatalf("Failed to initiate backup: %v", err) | ||
| } | ||
| t.Cleanup(func() { | ||
| client.DeleteBackup(ctx, &adminpb.DeleteBackupRequest{Name: backupPath}) | ||
| }) | ||
|
|
||
| _, err = opCreateBackup.Wait(ctx) | ||
| if err != nil { | ||
| t.Fatalf("Backup LRO failed: %v", err) | ||
| } | ||
|
|
||
| // 3. Restore table | ||
| err = client.RestoreTable(ctx, &adminpb.RestoreTableRequest{ | ||
| Parent: instancePath, | ||
| TableId: restoredTableID, | ||
| Source: &adminpb.RestoreTableRequest_Backup{ | ||
| Backup: backupPath, | ||
| }, | ||
| }) | ||
| if err != nil { | ||
| t.Fatalf("RestoreTable failed: %v", err) | ||
| } | ||
| t.Cleanup(func() { | ||
| client.DeleteTable(ctx, &adminpb.DeleteTableRequest{Name: restoredTablePath}) | ||
| }) | ||
|
|
||
| // 4. Verify restored table exists | ||
| restoredTable, err := client.GetTable(ctx, &adminpb.GetTableRequest{ | ||
| Name: restoredTablePath, | ||
| }) | ||
| if err != nil { | ||
| t.Fatalf("Failed to get restored table: %v", err) | ||
| } | ||
|
|
||
| if restoredTable.Name != restoredTablePath { | ||
| t.Errorf("Expected restored table name %q, got %q", restoredTablePath, restoredTable.Name) | ||
| } | ||
| } | ||
|
|
||
| func TestIntegration_WaitForConsistency(t *testing.T) { | ||
| env := setupIntegration(t) | ||
|
|
||
| ctx := context.Background() | ||
| client := env.client | ||
|
|
||
| suffix := time.Now().Format("20060102-150405") | ||
| tableID := fmt.Sprintf("repl-test-table-%s", suffix) | ||
| instancePath := fmt.Sprintf("projects/%s/instances/%s", env.project, env.instance) | ||
| tablePath := fmt.Sprintf("%s/tables/%s", instancePath, tableID) | ||
|
|
||
| // Create table | ||
| _, err := client.CreateTable(ctx, &adminpb.CreateTableRequest{ | ||
| Parent: instancePath, | ||
| TableId: tableID, | ||
| Table: &adminpb.Table{}, | ||
| }) | ||
| if err != nil { | ||
| t.Fatalf("Failed to create table: %v", err) | ||
| } | ||
| t.Cleanup(func() { | ||
| client.DeleteTable(ctx, &adminpb.DeleteTableRequest{Name: tablePath}) | ||
| }) | ||
|
|
||
| // Wait for replication | ||
| err = client.WaitForConsistency(ctx, tablePath) | ||
| if err != nil { | ||
| t.Fatalf("WaitForConsistency failed: %v", err) | ||
| } | ||
| } |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.