Skip to content

samples(bigtable): migrate all admin snippets and tests to modern V2 clients #13392

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.

Sign up for GitHub

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

Open
jinseopkim0 wants to merge 8 commits into
base: main
Choose a base branch
from
+879 −353
Open

samples(bigtable): migrate all admin snippets and tests to modern V2 clients #13392

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
527541a
samples(bigtable): migrate admin snippets to modern V2 clients
jinseopkim0 Jun 8, 2026
678aae4
samples(bigtable): migrate secondary admin samples to V2 clients
jinseopkim0 Jun 8, 2026
922dd1d
chore(bigtable-samples): address gemini-code-assist review feedback
jinseopkim0 Jun 8, 2026
8889599
chore(bigtable-samples): address gemini review optimizations
jinseopkim0 Jun 8, 2026
6b4e77d
chore: generate libraries at Mon Jun 8 19:33:45 UTC 2026
cloud-java-bot Jun 8, 2026
96d45f9
chore(bigtable-samples): implement exception safe cleanup and strongl…
jinseopkim0 Jun 8, 2026
ee45f5d
Merge branch 'main' into bigtable-v2-samples
jinseopkim0 Jun 8, 2026
9514cf8
refactor(bigtable-samples): import V2 classes to shorten fully qualif…
jinseopkim0 Jun 8, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
197 changes: 142 additions & 55 deletions java-bigtable/samples/snippets/src/main/java/com/example/bigtable/AuthorizedViewExample.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,15 +21,17 @@
import com.google.api.gax.rpc.NotFoundException;
import com.google.api.gax.rpc.PermissionDeniedException;
import com.google.api.gax.rpc.ServerStream;
import com.google.cloud.bigtable.admin.v2.BigtableTableAdminClient;
import com.google.cloud.bigtable.admin.v2.BigtableTableAdminSettings;
import com.google.cloud.bigtable.admin.v2.models.AuthorizedView;
import com.google.cloud.bigtable.admin.v2.models.CreateAuthorizedViewRequest;
import com.google.cloud.bigtable.admin.v2.models.CreateTableRequest;
import com.google.cloud.bigtable.admin.v2.models.FamilySubsets;
import com.google.cloud.bigtable.admin.v2.models.SubsetView;
import com.google.cloud.bigtable.admin.v2.models.Table;
import com.google.cloud.bigtable.admin.v2.models.UpdateAuthorizedViewRequest;
import com.google.bigtable.admin.v2.AuthorizedView;
import com.google.bigtable.admin.v2.AuthorizedViewName;
import com.google.bigtable.admin.v2.ColumnFamily;
import com.google.bigtable.admin.v2.CreateAuthorizedViewRequest;
import com.google.bigtable.admin.v2.CreateTableRequest;
import com.google.bigtable.admin.v2.GetTableRequest;
import com.google.bigtable.admin.v2.ListAuthorizedViewsRequest;
import com.google.bigtable.admin.v2.Table;
import com.google.bigtable.admin.v2.UpdateAuthorizedViewRequest;
import com.google.cloud.bigtable.admin.v2.BaseBigtableTableAdminSettings;
import com.google.cloud.bigtable.admin.v2.BigtableTableAdminClientV2;
import com.google.cloud.bigtable.data.v2.BigtableDataClient;
import com.google.cloud.bigtable.data.v2.BigtableDataSettings;
import com.google.cloud.bigtable.data.v2.models.AuthorizedViewId;
Expand All @@ -50,9 +52,11 @@ public class AuthorizedViewExample {
private static final String COLUMN_QUALIFIER_GREETING = "greeting";
private static final String COLUMN_QUALIFIER_NAME = "name";
private static final String ROW_KEY_PREFIX = "rowKey";
private final String projectId;
private final String instanceId;
private final String tableId;
private final String authorizedViewId;
private final BigtableTableAdminClient adminClient;
private final BigtableTableAdminClientV2 adminClient;
private final BigtableDataClient dataClient;

public static void main(String[] args) throws IOException {
Expand All @@ -72,6 +76,8 @@ public static void main(String[] args) throws IOException {
public AuthorizedViewExample(
String projectId, String instanceId, String tableId, String authorizedViewId)
throws IOException {
this.projectId = projectId;
this.instanceId = instanceId;
this.tableId = tableId;
this.authorizedViewId = authorizedViewId;

Expand All @@ -83,14 +89,24 @@ public AuthorizedViewExample(
dataClient = BigtableDataClient.create(settings);

// Creates the settings to configure a bigtable table admin client.
BigtableTableAdminSettings adminSettings =
BigtableTableAdminSettings.newBuilder()
.setProjectId(projectId)
.setInstanceId(instanceId)
.build();
BaseBigtableTableAdminSettings adminSettings =
BaseBigtableTableAdminSettings.newBuilder().build();

// Creates a bigtable table admin client.
adminClient = BigtableTableAdminClient.create(adminSettings);
adminClient = BigtableTableAdminClientV2.create(adminSettings);
}

private boolean exists(String tableId) {
try {
adminClient.getTable(
GetTableRequest.newBuilder()
.setName("projects/" + projectId + "/instances/" + instanceId + "/tables/" + tableId)
.setView(Table.View.NAME_ONLY)
.build());
Comment thread
jinseopkim0 marked this conversation as resolved.
return true;
} catch (com.google.api.gax.rpc.NotFoundException e) {
return false;
}
}
Comment thread
jinseopkim0 marked this conversation as resolved.

public void close() {
Expand All @@ -114,20 +130,28 @@ public void run() {

public void createTable() {
// Checks if table exists, creates table if it does not exist.
if (!adminClient.exists(tableId)) {
if (!exists(tableId)) {
System.out.println("Table does not exist, creating table: " + tableId);
CreateTableRequest createTableRequest =
CreateTableRequest.of(tableId).addFamily(COLUMN_FAMILY);
Table table = adminClient.createTable(createTableRequest);
System.out.printf("Table: %s created successfully%n", table.getId());
CreateTableRequest request =
CreateTableRequest.newBuilder()
.setParent("projects/" + projectId + "/instances/" + instanceId)
.setTableId(tableId)
.setTable(
Table.newBuilder()
.putColumnFamilies(COLUMN_FAMILY, ColumnFamily.getDefaultInstance())
.build())
.build();
Table table = adminClient.createTable(request);
System.out.printf("Table: %s created successfully%n", table.getName());
}
}

public void deleteTable() {
// Deletes the entire table.
System.out.println("\nDelete table: " + tableId);
try {
adminClient.deleteTable(tableId);
adminClient.deleteTable(
"projects/" + projectId + "/instances/" + instanceId + "/tables/" + tableId);
System.out.printf("Table: %s deleted successfully%n", tableId);
} catch (NotFoundException e) {
System.err.println("Failed to delete a non-existent table: " + e.getMessage());
Expand All @@ -140,24 +164,42 @@ public void deleteTable() {
public void createAuthorizedView() {
// Checks if the authorized view exists, creates it if it does not exist.
try {
adminClient.getAuthorizedView(tableId, authorizedViewId);
adminClient.getAuthorizedView(
"projects/"
+ projectId
+ "/instances/"
+ instanceId
+ "/tables/"
+ tableId
+ "/authorizedViews/"
+ authorizedViewId);
} catch (NotFoundException exception) {
System.out.printf("%nCreating authorized view %s in table %s%n", authorizedViewId, tableId);
// [START bigtable_create_authorized_view]
try {
AuthorizedView.SubsetView subsetView =
AuthorizedView.SubsetView.newBuilder()
.addRowPrefixes(com.google.protobuf.ByteString.EMPTY)
.putFamilySubsets(
COLUMN_FAMILY,
AuthorizedView.FamilySubsets.newBuilder()
.addQualifierPrefixes(
com.google.protobuf.ByteString.copyFromUtf8(COLUMN_QUALIFIER_NAME))
.build())
.build();
AuthorizedView authorizedViewObj =
AuthorizedView.newBuilder().setSubsetView(subsetView).build();
CreateAuthorizedViewRequest request =
CreateAuthorizedViewRequest.of(tableId, authorizedViewId)
.setAuthorizedViewType(
SubsetView.create()
.addRowPrefix("")
.setFamilySubsets(
COLUMN_FAMILY,
FamilySubsets.create().addQualifierPrefix(COLUMN_QUALIFIER_NAME)));
AuthorizedView authorizedView = adminClient.createAuthorizedView(request);
System.out.printf("AuthorizedView: %s created successfully%n", authorizedView.getId());
} catch (NotFoundException e) {
System.err.println(
"Failed to create an authorized view from a non-existent table: " + e.getMessage());
CreateAuthorizedViewRequest.newBuilder()
.setParent(
"projects/" + projectId + "/instances/" + instanceId + "/tables/" + tableId)
.setAuthorizedViewId(authorizedViewId)
.setAuthorizedView(authorizedViewObj)
.build();
AuthorizedView authorizedView = adminClient.createAuthorizedViewAsync(request).get();
System.out.printf("AuthorizedView: %s created successfully%n", authorizedView.getName());
} catch (Exception e) {
System.err.println("Failed to create an authorized view: " + e.getMessage());
}
// [END bigtable_create_authorized_view]
}
Expand All @@ -169,17 +211,38 @@ public void updateAuthorizedView() {
// [START bigtable_update_authorized_view]
try {
// Update to an authorized view permitting everything.
AuthorizedView.SubsetView subsetView =
AuthorizedView.SubsetView.newBuilder()
.addRowPrefixes(com.google.protobuf.ByteString.EMPTY)
.putFamilySubsets(
COLUMN_FAMILY,
AuthorizedView.FamilySubsets.newBuilder()
.addQualifierPrefixes(com.google.protobuf.ByteString.EMPTY)
.build())
.build();
AuthorizedView authorizedViewObj =
AuthorizedView.newBuilder()
.setSubsetView(subsetView)
.setName(
"projects/"
+ projectId
+ "/instances/"
+ instanceId
+ "/tables/"
+ tableId
+ "/authorizedViews/"
+ authorizedViewId)
.build();
UpdateAuthorizedViewRequest request =
UpdateAuthorizedViewRequest.of(tableId, authorizedViewId)
.setAuthorizedViewType(
SubsetView.create()
.addRowPrefix("")
.setFamilySubsets(
COLUMN_FAMILY, FamilySubsets.create().addQualifierPrefix("")));
AuthorizedView authorizedView = adminClient.updateAuthorizedView(request);
System.out.printf("AuthorizedView: %s updated successfully%n", authorizedView.getId());
} catch (NotFoundException e) {
System.err.println("Failed to modify a non-existent authorized view: " + e.getMessage());
UpdateAuthorizedViewRequest.newBuilder()
.setAuthorizedView(authorizedViewObj)
.setUpdateMask(
com.google.protobuf.FieldMask.newBuilder().addPaths("subset_view").build())
.build();
AuthorizedView authorizedView = adminClient.updateAuthorizedViewAsync(request).get();
System.out.printf("AuthorizedView: %s updated successfully%n", authorizedView.getName());
} catch (Exception e) {
System.err.println("Failed to modify authorized view: " + e.getMessage());
}
// [END bigtable_update_authorized_view]
}
Expand All @@ -190,19 +253,29 @@ public AuthorizedView getAuthorizedView() {
// [START bigtable_get_authorized_view]
AuthorizedView authorizedView = null;
try {
authorizedView = adminClient.getAuthorizedView(tableId, authorizedViewId);
SubsetView subsetView = (SubsetView) authorizedView.getAuthorizedViewType();
authorizedView =
adminClient.getAuthorizedView(
"projects/"
+ projectId
+ "/instances/"
+ instanceId
+ "/tables/"
+ tableId
+ "/authorizedViews/"
+ authorizedViewId);
AuthorizedView.SubsetView subsetView = authorizedView.getSubsetView();

for (ByteString rowPrefix : subsetView.getRowPrefixes()) {
for (ByteString rowPrefix : subsetView.getRowPrefixesList()) {
System.out.printf("Row Prefix: %s%n", rowPrefix.toStringUtf8());
}
for (Map.Entry<String, FamilySubsets> entry : subsetView.getFamilySubsets().entrySet()) {
for (ByteString qualifierPrefix : entry.getValue().getQualifierPrefixes()) {
for (Map.Entry<String, AuthorizedView.FamilySubsets> entry :
subsetView.getFamilySubsetsMap().entrySet()) {
for (ByteString qualifierPrefix : entry.getValue().getQualifierPrefixesList()) {
System.out.printf(
"Column Family: %s, Qualifier Prefix: %s%n",
entry.getKey(), qualifierPrefix.toStringUtf8());
}
for (ByteString qualifier : entry.getValue().getQualifiers()) {
for (ByteString qualifier : entry.getValue().getQualifiersList()) {
System.out.printf(
"Column Family: %s, Qualifier: %s%n", entry.getKey(), qualifier.toStringUtf8());
}
Expand All @@ -221,9 +294,15 @@ public List<String> listAllAuthorizedViews() {
// [START bigtable_list_authorized_views]
List<String> authorizedViewIds = new ArrayList<>();
try {
authorizedViewIds = adminClient.listAuthorizedViews(tableId);
for (String authorizedViewId : authorizedViewIds) {
System.out.println(authorizedViewId);
ListAuthorizedViewsRequest request =
ListAuthorizedViewsRequest.newBuilder()
.setParent(
"projects/" + projectId + "/instances/" + instanceId + "/tables/" + tableId)
.build();
for (AuthorizedView view : adminClient.listAuthorizedViews(request).iterateAll()) {
String id = AuthorizedViewName.parse(view.getName()).getAuthorizedView();
System.out.println(id);
authorizedViewIds.add(id);
}
} catch (NotFoundException e) {
System.err.println(
Expand All @@ -238,7 +317,15 @@ public void deleteAuthorizedView() {
System.out.printf("%nDeleting authorized view %s in table %s%n", authorizedViewId, tableId);
// [START bigtable_delete_authorized_view]
try {
adminClient.deleteAuthorizedView(tableId, authorizedViewId);
adminClient.deleteAuthorizedView(
"projects/"
+ projectId
+ "/instances/"
+ instanceId
+ "/tables/"
+ tableId
+ "/authorizedViews/"
+ authorizedViewId);
System.out.printf("AuthorizedView: %s deleted successfully%n", authorizedViewId);
} catch (NotFoundException e) {
System.err.println("Failed to delete a non-existent authorized view: " + e.getMessage());
Expand Down
46 changes: 28 additions & 18 deletions java-bigtable/samples/snippets/src/main/java/com/example/bigtable/HelloWorld.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,12 @@

import com.google.api.gax.rpc.NotFoundException;
import com.google.api.gax.rpc.ServerStream;
import com.google.cloud.bigtable.admin.v2.BigtableTableAdminClient;
import com.google.cloud.bigtable.admin.v2.BigtableTableAdminSettings;
import com.google.bigtable.admin.v2.ColumnFamily;
import com.google.bigtable.admin.v2.CreateTableRequest;
import com.google.bigtable.admin.v2.GetTableRequest;
import com.google.bigtable.admin.v2.Table;
import com.google.cloud.bigtable.admin.v2.BaseBigtableTableAdminSettings;
import com.google.cloud.bigtable.admin.v2.BigtableTableAdminClientV2;
import com.google.cloud.bigtable.data.v2.BigtableDataClient;
import com.google.cloud.bigtable.data.v2.BigtableDataSettings;
import com.google.cloud.bigtable.data.v2.models.Filters.Filter;
Expand Down Expand Up @@ -63,7 +67,7 @@ public class HelloWorld {
private final String instanceId;
private final String tableId;
private final BigtableDataClient dataClient;
private final BigtableTableAdminClient adminClient;
private final BigtableTableAdminClientV2 adminClient;

public static void main(String[] args) throws Exception {

Expand Down Expand Up @@ -92,14 +96,11 @@ public HelloWorld(String projectId, String instanceId, String tableId) throws IO
dataClient = BigtableDataClient.create(settings);

// Creates the settings to configure a bigtable table admin client.
BigtableTableAdminSettings adminSettings =
BigtableTableAdminSettings.newBuilder()
.setProjectId(projectId)
.setInstanceId(instanceId)
.build();
BaseBigtableTableAdminSettings adminSettings =
BaseBigtableTableAdminSettings.newBuilder().build();

// Creates a bigtable table admin client.
adminClient = BigtableTableAdminClient.create(adminSettings);
adminClient = BigtableTableAdminClientV2.create(adminSettings);
// [END bigtable_hw_connect]
}

Expand All @@ -123,21 +124,30 @@ public void close() {
public void createTable() {
// [START bigtable_hw_create_table]
// Checks if table exists, creates table if does not exist.
if (!adminClient.exists(tableId)) {
boolean exists = false;
try {
adminClient.getTable(
GetTableRequest.newBuilder()
.setName("projects/" + projectId + "/instances/" + instanceId + "/tables/" + tableId)
.setView(Table.View.NAME_ONLY)
.build());
exists = true;
} catch (NotFoundException e) {
// ignore
}
Comment thread
jinseopkim0 marked this conversation as resolved.
if (!exists) {
System.out.println("Creating table: " + tableId);
String parent = "projects/" + projectId + "/instances/" + instanceId;
com.google.bigtable.admin.v2.CreateTableRequest request =
com.google.bigtable.admin.v2.CreateTableRequest.newBuilder()
CreateTableRequest request =
CreateTableRequest.newBuilder()
.setParent(parent)
.setTableId(tableId)
.setTable(
com.google.bigtable.admin.v2.Table.newBuilder()
.putColumnFamilies(
COLUMN_FAMILY,
com.google.bigtable.admin.v2.ColumnFamily.getDefaultInstance())
Table.newBuilder()
.putColumnFamilies(COLUMN_FAMILY, ColumnFamily.getDefaultInstance())
.build())
.build();
adminClient.getBaseClient().createTable(request);
adminClient.createTable(request);
System.out.printf("Table %s created successfully%n", tableId);
}
// [END bigtable_hw_create_table]
Expand Down Expand Up @@ -270,7 +280,7 @@ public void deleteTable() {
try {
String tableName =
"projects/" + projectId + "/instances/" + instanceId + "/tables/" + tableId;
adminClient.getBaseClient().deleteTable(tableName);
adminClient.deleteTable(tableName);
System.out.printf("Table %s deleted successfully%n", tableId);
} catch (NotFoundException e) {
System.err.println("Failed to delete a non-existent table: " + e.getMessage());
Expand Down
Loading
Loading