Skip to content

refactor(samples): migrate Admin API samples to BigtableAdminClientV2 #2904

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 6 commits into
base: escape-hatch
Choose a base branch
from
Open

refactor(samples): migrate Admin API samples to BigtableAdminClientV2 #2904

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
9e28346
refactor(samples): migrate Admin API samples to BigtableAdminClientV2
jinseopkim0 Apr 24, 2026
dc96c8b
chore: generate libraries at Fri Apr 24 17:38:50 UTC 2026
cloud-java-bot Apr 24, 2026
0cabccd
CI fix
jinseopkim0 Apr 24, 2026
973cca1
fix 1
jinseopkim0 Apr 24, 2026
0d0a54c
PR feedback
jinseopkim0 Apr 24, 2026
5287014
Merge branch 'escape-hatch' into samples-update
jinseopkim0 Apr 24, 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
31 changes: 19 additions & 12 deletions 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,8 @@

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.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 +63,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 +92,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,7 +120,17 @@ 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(
com.google.bigtable.admin.v2.GetTableRequest.newBuilder()
.setName("projects/" + projectId + "/instances/" + instanceId + "/tables/" + tableId)
.build());
exists = true;
} catch (NotFoundException e) {
// ignore
}
if (!exists) {
System.out.println("Creating table: " + tableId);
String parent = "projects/" + projectId + "/instances/" + instanceId;
com.google.bigtable.admin.v2.CreateTableRequest request =
Expand All @@ -137,7 +144,7 @@ public void createTable() {
com.google.bigtable.admin.v2.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 +277,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
38 changes: 24 additions & 14 deletions samples/snippets/src/main/java/com/example/bigtable/InstanceAdminExample.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,8 +29,8 @@
import com.google.bigtable.admin.v2.ListInstancesRequest;
import com.google.bigtable.admin.v2.ListInstancesResponse;
import com.google.bigtable.admin.v2.StorageType;
import com.google.cloud.bigtable.admin.v2.BigtableInstanceAdminClient;
import com.google.cloud.bigtable.admin.v2.BigtableInstanceAdminSettings;
import com.google.cloud.bigtable.admin.v2.BaseBigtableInstanceAdminSettings;
import com.google.cloud.bigtable.admin.v2.BigtableInstanceAdminClientV2;
import java.io.IOException;
import java.util.Map;

Expand All @@ -56,7 +56,7 @@ public class InstanceAdminExample {
private final String projectId;
private final String clusterId;
private final String instanceId;
private final BigtableInstanceAdminClient adminClient;
private final BigtableInstanceAdminClientV2 adminClient;

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

Expand All @@ -78,11 +78,11 @@ public InstanceAdminExample(String projectId, String instanceId, String clusterI
this.clusterId = clusterId;

// Creates the settings to configure a bigtable instance admin client.
BigtableInstanceAdminSettings instanceAdminSettings =
BigtableInstanceAdminSettings.newBuilder().setProjectId(projectId).build();
BaseBigtableInstanceAdminSettings instanceAdminSettings =
BaseBigtableInstanceAdminSettings.newBuilder().build();

// Creates a bigtable instance admin client.
adminClient = BigtableInstanceAdminClient.create(instanceAdminSettings);
adminClient = BigtableInstanceAdminClientV2.create(instanceAdminSettings);
}

public void run() {
Expand All @@ -104,7 +104,17 @@ void close() {
/** Demonstrates how to create a Production instance within a provided project. */
public void createProdInstance() {
// Checks if instance exists, creates instance if does not exists.
if (!adminClient.exists(instanceId)) {
boolean exists = false;
try {
adminClient.getInstance(
com.google.bigtable.admin.v2.GetInstanceRequest.newBuilder()
.setName("projects/" + projectId + "/instances/" + instanceId)
.build());
exists = true;
} catch (com.google.api.gax.rpc.NotFoundException e) {
// ignore
}
if (!exists) {
System.out.println("Instance does not exist, creating a PRODUCTION instance");
// [START bigtable_create_prod_instance]
// Creates a Production Instance with the ID "ssd-instance",
Expand All @@ -131,7 +141,7 @@ public void createProdInstance() {
.build();
// Creates a production instance with the given request.
try {
Instance instance = adminClient.getBaseClient().createInstanceAsync(request).get();
Instance instance = adminClient.createInstanceAsync(request).get();
System.out.printf("PRODUCTION type instance %s created successfully%n", instance.getName());
} catch (Exception e) {
System.err.println("Failed to create instance: " + e.getMessage());
Expand All @@ -148,7 +158,7 @@ public void listInstances() {
try {
String parent = "projects/" + projectId;
ListInstancesRequest request = ListInstancesRequest.newBuilder().setParent(parent).build();
ListInstancesResponse response = adminClient.getBaseClient().listInstances(request);
ListInstancesResponse response = adminClient.listInstances(request);
for (Instance instance : response.getInstancesList()) {
System.out.println(instance.getName());
}
Expand All @@ -166,7 +176,7 @@ public Instance getInstance() {
try {
String name = "projects/" + projectId + "/instances/" + instanceId;
GetInstanceRequest request = GetInstanceRequest.newBuilder().setName(name).build();
instance = adminClient.getBaseClient().getInstance(request);
instance = adminClient.getInstance(request);
System.out.println("Instance ID: " + instance.getName());
System.out.println("Display Name: " + instance.getDisplayName());
System.out.print("Labels: ");
Expand All @@ -190,7 +200,7 @@ public void listClusters() {
try {
String parent = "projects/" + projectId + "/instances/" + instanceId;
ListClustersRequest request = ListClustersRequest.newBuilder().setParent(parent).build();
ListClustersResponse response = adminClient.getBaseClient().listClusters(request);
ListClustersResponse response = adminClient.listClusters(request);
for (Cluster cluster : response.getClustersList()) {
System.out.println(cluster.getName());
}
Expand All @@ -207,7 +217,7 @@ public void deleteInstance() {
try {
String name = "projects/" + projectId + "/instances/" + instanceId;
DeleteInstanceRequest request = DeleteInstanceRequest.newBuilder().setName(name).build();
adminClient.getBaseClient().deleteInstance(request);
adminClient.deleteInstance(request);
System.out.println("Instance deleted: " + instanceId);
} catch (NotFoundException e) {
System.err.println("Failed to delete non-existent instance: " + e.getMessage());
Expand All @@ -233,7 +243,7 @@ public void addCluster() {
.setClusterId(CLUSTER)
.setCluster(clusterObj)
.build();
adminClient.getBaseClient().createClusterAsync(request).get();
adminClient.createClusterAsync(request).get();
System.out.printf("Cluster: %s created successfully%n", CLUSTER);
} catch (Exception e) {
System.err.println("Failed to add cluster: " + e.getMessage());
Expand All @@ -248,7 +258,7 @@ public void deleteCluster() {
try {
String name = "projects/" + projectId + "/instances/" + instanceId + "/clusters/" + CLUSTER;
DeleteClusterRequest request = DeleteClusterRequest.newBuilder().setName(name).build();
adminClient.getBaseClient().deleteCluster(request);
adminClient.deleteCluster(request);
System.out.printf("Cluster: %s deleted successfully%n", CLUSTER);
} catch (NotFoundException e) {
System.err.println("Failed to delete a non-existent cluster: " + e.getMessage());
Expand Down
53 changes: 30 additions & 23 deletions samples/snippets/src/main/java/com/example/bigtable/TableAdminExample.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,8 @@
import com.google.bigtable.admin.v2.ListTablesRequest;
import com.google.bigtable.admin.v2.ModifyColumnFamiliesRequest;
import com.google.bigtable.admin.v2.Table;
import com.google.cloud.bigtable.admin.v2.BigtableTableAdminClient;
import com.google.cloud.bigtable.admin.v2.BigtableTableAdminSettings;
import com.google.cloud.bigtable.admin.v2.BaseBigtableTableAdminSettings;
import com.google.cloud.bigtable.admin.v2.BigtableTableAdminClientV2;
import com.google.cloud.bigtable.admin.v2.models.GcRuleBuilder;
import java.io.IOException;
import java.time.Duration;
Expand Down Expand Up @@ -62,7 +62,7 @@ public class TableAdminExample {
private final String projectId;
private final String instanceId;
private final String tableId;
private final BigtableTableAdminClient adminClient;
private final BigtableTableAdminClientV2 adminClient;

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

Expand All @@ -83,14 +83,11 @@ public TableAdminExample(String projectId, String instanceId, String tableId) th
this.tableId = tableId;

// 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);
}

public void run() {
Expand Down Expand Up @@ -119,7 +116,17 @@ void close() {
public void createTable() {
// [START bigtable_create_table]
// Checks if table exists, creates table if does not exist.
if (!adminClient.exists(tableId)) {
boolean exists = false;
try {
adminClient.getTable(
com.google.bigtable.admin.v2.GetTableRequest.newBuilder()
.setName("projects/" + projectId + "/instances/" + instanceId + "/tables/" + tableId)
.build());
exists = true;
} catch (com.google.api.gax.rpc.NotFoundException e) {
// ignore
}
if (!exists) {
System.out.println("Table does not exist, creating table: " + tableId);
String parent = "projects/" + projectId + "/instances/" + instanceId;
CreateTableRequest createTableRequest =
Expand All @@ -131,7 +138,7 @@ public void createTable() {
.putColumnFamilies("cf", ColumnFamily.getDefaultInstance())
.build())
.build();
Table table = adminClient.getBaseClient().createTable(createTableRequest);
Table table = adminClient.createTable(createTableRequest);
System.out.printf("Table: %s created successfully%n", table.getName());
}
// [END bigtable_create_table]
Expand All @@ -145,7 +152,7 @@ public void listAllTables() {
try {
String parent = "projects/" + projectId + "/instances/" + instanceId;
ListTablesRequest request = ListTablesRequest.newBuilder().setParent(parent).build();
for (Table table : adminClient.getBaseClient().listTables(request).iterateAll()) {
for (Table table : adminClient.listTables(request).iterateAll()) {
System.out.println(table.getName());
}
} catch (NotFoundException e) {
Expand All @@ -162,7 +169,7 @@ public void getTableMeta() {
try {
String tableName =
"projects/" + projectId + "/instances/" + instanceId + "/tables/" + tableId;
Table table = adminClient.getBaseClient().getTable(tableName);
Table table = adminClient.getTable(tableName);
System.out.println("Table: " + table.getName());
for (java.util.Map.Entry<String, ColumnFamily> entry :
table.getColumnFamiliesMap().entrySet()) {
Expand Down Expand Up @@ -198,7 +205,7 @@ public void addFamilyWithMaxAgeRule() {
.setId(COLUMN_FAMILY_1)
.setCreate(ColumnFamily.newBuilder().setGcRule(maxAgeRule)))
.build();
adminClient.getBaseClient().modifyColumnFamilies(request);
adminClient.modifyColumnFamilies(request);
System.out.println("Created column family: " + COLUMN_FAMILY_1);
} catch (AlreadyExistsException e) {
System.err.println(
Expand Down Expand Up @@ -229,7 +236,7 @@ public void addFamilyWithMaxVersionsRule() {
.setId(COLUMN_FAMILY_2)
.setCreate(ColumnFamily.newBuilder().setGcRule(versionRule)))
.build();
adminClient.getBaseClient().modifyColumnFamilies(request);
adminClient.modifyColumnFamilies(request);
System.out.println("Created column family: " + COLUMN_FAMILY_2);
} catch (AlreadyExistsException e) {
System.err.println(
Expand Down Expand Up @@ -264,7 +271,7 @@ public void addFamilyWithUnionRule() {
.setId(COLUMN_FAMILY_3)
.setCreate(ColumnFamily.newBuilder().setGcRule(unionRule)))
.build();
adminClient.getBaseClient().modifyColumnFamilies(request);
adminClient.modifyColumnFamilies(request);
System.out.println("Created column family: " + COLUMN_FAMILY_3);
} catch (AlreadyExistsException e) {
System.err.println(
Expand Down Expand Up @@ -298,7 +305,7 @@ public void addFamilyWithIntersectionRule() {
.setId(COLUMN_FAMILY_4)
.setCreate(ColumnFamily.newBuilder().setGcRule(intersectionRule)))
.build();
adminClient.getBaseClient().modifyColumnFamilies(request);
adminClient.modifyColumnFamilies(request);
System.out.println("Created column family: " + COLUMN_FAMILY_4);
} catch (AlreadyExistsException e) {
System.err.println(
Expand Down Expand Up @@ -335,7 +342,7 @@ public void addFamilyWithNestedRule() {
.setId(COLUMN_FAMILY_5)
.setCreate(ColumnFamily.newBuilder().setGcRule(unionRule)))
.build();
adminClient.getBaseClient().modifyColumnFamilies(request);
adminClient.modifyColumnFamilies(request);
System.out.println("Created column family: " + COLUMN_FAMILY_5);
} catch (AlreadyExistsException e) {
System.err.println(
Expand All @@ -352,7 +359,7 @@ public void listColumnFamilies() {
try {
String tableName =
"projects/" + projectId + "/instances/" + instanceId + "/tables/" + tableId;
Table table = adminClient.getBaseClient().getTable(tableName);
Table table = adminClient.getTable(tableName);
for (java.util.Map.Entry<String, ColumnFamily> entry :
table.getColumnFamiliesMap().entrySet()) {
System.out.printf(
Expand Down Expand Up @@ -383,7 +390,7 @@ public void modifyColumnFamilyRule() {
.setId(COLUMN_FAMILY_1)
.setUpdate(ColumnFamily.newBuilder().setGcRule(versionRule)))
.build();
adminClient.getBaseClient().modifyColumnFamilies(request);
adminClient.modifyColumnFamilies(request);
System.out.printf("Column family %s GC rule updated%n", COLUMN_FAMILY_1);
} catch (NotFoundException e) {
System.err.println("Failed to modify a non-existent column family: " + e.getMessage());
Expand All @@ -398,7 +405,7 @@ public void printModifiedColumnFamily() {
try {
String tableName =
"projects/" + projectId + "/instances/" + instanceId + "/tables/" + tableId;
Table table = adminClient.getBaseClient().getTable(tableName);
Table table = adminClient.getTable(tableName);
if (table.containsColumnFamilies(COLUMN_FAMILY_1)) {
System.out.printf(
"Column family: %s%nGC Rule: %s%n",
Expand Down Expand Up @@ -426,7 +433,7 @@ public void deleteColumnFamily() {
.setId(COLUMN_FAMILY_2)
.setDrop(true))
.build();
adminClient.getBaseClient().modifyColumnFamilies(request);
adminClient.modifyColumnFamilies(request);
System.out.printf("Column family %s deleted successfully%n", COLUMN_FAMILY_2);
} catch (NotFoundException e) {
System.err.println("Failed to delete a non-existent column family: " + e.getMessage());
Expand All @@ -442,7 +449,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