chore: replace client creation methods for all new samples with auto-…

…generated admin clients (#2927) * fix: prevent illegal negative timeout values into thread sleep() method while retrying exceptions in unit tests. * For details on issue see - #2206 * Fixing lint issues. * chore: remove unused imports. * chore: replace with new client creation methods. * Update samples/snippets/src/main/java/com/example/spanner/admin/generated/AddAndDropDatabaseRole.java Co-authored-by: Knut Olav Løite <[email protected]> * chore: address comments. * chore: replace with new client creation methods. --------- Co-authored-by: Knut Olav Løite <[email protected]>
googleapis · Feb 26, 2024 · c6d82d4 · c6d82d4
1 parent cd34c1d
commit c6d82d4
Show file tree

Hide file tree

Showing 38 changed files with 422 additions and 320 deletions.
diff --git a/...es/snippets/src/main/java/com/example/spanner/admin/generated/AddAndDropDatabaseRole.java b/...es/snippets/src/main/java/com/example/spanner/admin/generated/AddAndDropDatabaseRole.java
@@ -18,17 +18,18 @@
 
 // [START spanner_add_and_drop_database_role]
 
+import com.google.cloud.spanner.Spanner;
+import com.google.cloud.spanner.SpannerOptions;
 import com.google.cloud.spanner.admin.database.v1.DatabaseAdminClient;
 import com.google.common.collect.ImmutableList;
 import com.google.spanner.admin.database.v1.DatabaseName;
-import java.io.IOException;
 import java.util.concurrent.ExecutionException;
 import java.util.concurrent.TimeUnit;
 import java.util.concurrent.TimeoutException;
 
 public class AddAndDropDatabaseRole {
 
-  static void addAndDropDatabaseRole() throws IOException {
+  static void addAndDropDatabaseRole() {
     // TODO(developer): Replace these variables before running the sample.
     String projectId = "my-project";
     String instanceId = "my-instance";
@@ -39,10 +40,14 @@ static void addAndDropDatabaseRole() throws IOException {
   }
 
   static void addAndDropDatabaseRole(
-      String projectId, String instanceId, String databaseId, String parentRole, String childRole)
-      throws IOException {
-    final DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create();
-    try {
+      String projectId, String instanceId, String databaseId,
+      String parentRole, String childRole) {
+    try (Spanner spanner =
+        SpannerOptions.newBuilder()
+            .setProjectId(projectId)
+            .build()
+            .getService();
+        DatabaseAdminClient databaseAdminClient = spanner.createDatabaseAdminClient()) {
       System.out.println("Waiting for role create operation to complete...");
       databaseAdminClient.updateDatabaseDdlAsync(
               DatabaseName.of(projectId, instanceId, databaseId),

diff --git a/samples/snippets/src/main/java/com/example/spanner/admin/generated/AddJsonColumnSample.java b/samples/snippets/src/main/java/com/example/spanner/admin/generated/AddJsonColumnSample.java
@@ -17,15 +17,17 @@
 package com.example.spanner.admin.generated;
 
 // [START spanner_add_json_column]
+
+import com.google.cloud.spanner.Spanner;
+import com.google.cloud.spanner.SpannerOptions;
 import com.google.cloud.spanner.admin.database.v1.DatabaseAdminClient;
 import com.google.common.collect.ImmutableList;
 import com.google.spanner.admin.database.v1.DatabaseName;
-import java.io.IOException;
 import java.util.concurrent.ExecutionException;
 
 class AddJsonColumnSample {
 
-  static void addJsonColumn() throws InterruptedException, ExecutionException, IOException {
+  static void addJsonColumn() throws InterruptedException, ExecutionException {
     // TODO(developer): Replace these variables before running the sample.
     String projectId = "my-project";
     String instanceId = "my-instance";
@@ -35,15 +37,20 @@ static void addJsonColumn() throws InterruptedException, ExecutionException, IOE
   }
 
   static void addJsonColumn(String projectId, String instanceId, String databaseId)
-      throws InterruptedException, ExecutionException, IOException {
-    final DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create();
-
-    // Wait for the operation to finish.
-    // This will throw an ExecutionException if the operation fails.
-    databaseAdminClient.updateDatabaseDdlAsync(
-        DatabaseName.of(projectId, instanceId, databaseId),
-        ImmutableList.of("ALTER TABLE Venues ADD COLUMN VenueDetails JSON")).get();
-    System.out.printf("Successfully added column `VenueDetails`%n");
+      throws InterruptedException, ExecutionException {
+    try (Spanner spanner =
+        SpannerOptions.newBuilder()
+            .setProjectId(projectId)
+            .build()
+            .getService();
+        DatabaseAdminClient databaseAdminClient = spanner.createDatabaseAdminClient()) {
+      // Wait for the operation to finish.
+      // This will throw an ExecutionException if the operation fails.
+      databaseAdminClient.updateDatabaseDdlAsync(
+          DatabaseName.of(projectId, instanceId, databaseId),
+          ImmutableList.of("ALTER TABLE Venues ADD COLUMN VenueDetails JSON")).get();
+      System.out.printf("Successfully added column `VenueDetails`%n");
+    }
   }
 }
 // [END spanner_add_json_column]
diff --git a/samples/snippets/src/main/java/com/example/spanner/admin/generated/AddJsonbColumnSample.java b/samples/snippets/src/main/java/com/example/spanner/admin/generated/AddJsonbColumnSample.java
@@ -17,15 +17,17 @@
 package com.example.spanner.admin.generated;
 
 // [START spanner_postgresql_jsonb_add_column]
+
+import com.google.cloud.spanner.Spanner;
+import com.google.cloud.spanner.SpannerOptions;
 import com.google.cloud.spanner.admin.database.v1.DatabaseAdminClient;
 import com.google.common.collect.ImmutableList;
 import com.google.spanner.admin.database.v1.DatabaseName;
-import java.io.IOException;
 import java.util.concurrent.ExecutionException;
 
 class AddJsonbColumnSample {
 
-  static void addJsonbColumn() throws InterruptedException, ExecutionException, IOException {
+  static void addJsonbColumn() throws InterruptedException, ExecutionException {
     // TODO(developer): Replace these variables before running the sample.
     String projectId = "my-project";
     String instanceId = "my-instance";
@@ -35,16 +37,21 @@ static void addJsonbColumn() throws InterruptedException, ExecutionException, IO
   }
 
   static void addJsonbColumn(String projectId, String instanceId, String databaseId)
-      throws InterruptedException, ExecutionException, IOException {
-    final DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create();
-
-    // JSONB datatype is only supported with PostgreSQL-dialect databases.
-    // Wait for the operation to finish.
-    // This will throw an ExecutionException if the operation fails.
-    databaseAdminClient.updateDatabaseDdlAsync(
-        DatabaseName.of(projectId, instanceId, databaseId),
-        ImmutableList.of("ALTER TABLE Venues ADD COLUMN VenueDetails JSONB")).get();
-    System.out.printf("Successfully added column `VenueDetails`%n");
+      throws InterruptedException, ExecutionException {
+    try (Spanner spanner =
+        SpannerOptions.newBuilder()
+            .setProjectId(projectId)
+            .build()
+            .getService();
+        DatabaseAdminClient databaseAdminClient = spanner.createDatabaseAdminClient()) {
+      // JSONB datatype is only supported with PostgreSQL-dialect databases.
+      // Wait for the operation to finish.
+      // This will throw an ExecutionException if the operation fails.
+      databaseAdminClient.updateDatabaseDdlAsync(
+          DatabaseName.of(projectId, instanceId, databaseId),
+          ImmutableList.of("ALTER TABLE Venues ADD COLUMN VenueDetails JSONB")).get();
+      System.out.printf("Successfully added column `VenueDetails`%n");
+    }
   }
 }
 // [END spanner_postgresql_jsonb_add_column]
diff --git a/...es/snippets/src/main/java/com/example/spanner/admin/generated/AddNumericColumnSample.java b/...es/snippets/src/main/java/com/example/spanner/admin/generated/AddNumericColumnSample.java
@@ -18,15 +18,16 @@
 
 // [START spanner_add_numeric_column]
 
+import com.google.cloud.spanner.Spanner;
+import com.google.cloud.spanner.SpannerOptions;
 import com.google.cloud.spanner.admin.database.v1.DatabaseAdminClient;
 import com.google.common.collect.ImmutableList;
 import com.google.spanner.admin.database.v1.DatabaseName;
-import java.io.IOException;
 import java.util.concurrent.ExecutionException;
 
 class AddNumericColumnSample {
 
-  static void addNumericColumn() throws InterruptedException, ExecutionException, IOException {
+  static void addNumericColumn() throws InterruptedException, ExecutionException {
     // TODO(developer): Replace these variables before running the sample.
     String projectId = "my-project";
     String instanceId = "my-instance";
@@ -36,15 +37,20 @@ static void addNumericColumn() throws InterruptedException, ExecutionException,
   }
 
   static void addNumericColumn(String projectId, String instanceId, String databaseId)
-      throws InterruptedException, ExecutionException, IOException {
-    final DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create();
-
-    // Wait for the operation to finish.
-    // This will throw an ExecutionException if the operation fails.
-    databaseAdminClient.updateDatabaseDdlAsync(
-        DatabaseName.of(projectId, instanceId, databaseId),
-        ImmutableList.of("ALTER TABLE Venues ADD COLUMN Revenue NUMERIC")).get();
-    System.out.printf("Successfully added column `Revenue`%n");
+      throws InterruptedException, ExecutionException {
+    try (Spanner spanner =
+        SpannerOptions.newBuilder()
+            .setProjectId(projectId)
+            .build()
+            .getService();
+        DatabaseAdminClient databaseAdminClient = spanner.createDatabaseAdminClient()) {
+      // Wait for the operation to finish.
+      // This will throw an ExecutionException if the operation fails.
+      databaseAdminClient.updateDatabaseDdlAsync(
+          DatabaseName.of(projectId, instanceId, databaseId),
+          ImmutableList.of("ALTER TABLE Venues ADD COLUMN Revenue NUMERIC")).get();
+      System.out.printf("Successfully added column `Revenue`%n");
+    }
   }
 }
 // [END spanner_add_numeric_column]
diff --git a/samples/snippets/src/main/java/com/example/spanner/admin/generated/AlterSequenceSample.java b/samples/snippets/src/main/java/com/example/spanner/admin/generated/AlterSequenceSample.java
@@ -28,27 +28,25 @@
 import com.google.cloud.spanner.admin.database.v1.DatabaseAdminClient;
 import com.google.common.collect.ImmutableList;
 import com.google.spanner.admin.database.v1.DatabaseName;
-import java.io.IOException;
 import java.util.Objects;
 import java.util.concurrent.ExecutionException;
 import java.util.concurrent.TimeUnit;
 import java.util.concurrent.TimeoutException;
 
 public class AlterSequenceSample {
 
-  static void alterSequence() throws IOException {
+  static void alterSequence() {
     // TODO(developer): Replace these variables before running the sample.
     final String projectId = "my-project";
     final String instanceId = "my-instance";
     final String databaseId = "my-database";
     alterSequence(projectId, instanceId, databaseId);
   }
 
-  static void alterSequence(String projectId, String instanceId, String databaseId)
-      throws IOException {
-    DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create();
+  static void alterSequence(String projectId, String instanceId, String databaseId) {
     try (Spanner spanner =
-        SpannerOptions.newBuilder().setProjectId(projectId).build().getService()) {
+        SpannerOptions.newBuilder().setProjectId(projectId).build().getService();
+        DatabaseAdminClient databaseAdminClient = spanner.createDatabaseAdminClient()) {
 
       databaseAdminClient
           .updateDatabaseDdlAsync(DatabaseName.of(projectId, instanceId, databaseId),

diff --git a/...java/com/example/spanner/admin/generated/AlterTableWithForeignKeyDeleteCascadeSample.java b/...java/com/example/spanner/admin/generated/AlterTableWithForeignKeyDeleteCascadeSample.java
@@ -18,14 +18,15 @@
 
 // [START spanner_alter_table_with_foreign_key_delete_cascade]
 
+import com.google.cloud.spanner.Spanner;
+import com.google.cloud.spanner.SpannerOptions;
 import com.google.cloud.spanner.admin.database.v1.DatabaseAdminClient;
 import com.google.common.collect.ImmutableList;
 import com.google.spanner.admin.database.v1.DatabaseName;
-import java.io.IOException;
 
 class AlterTableWithForeignKeyDeleteCascadeSample {
 
-  static void alterForeignKeyDeleteCascadeConstraint() throws IOException {
+  static void alterForeignKeyDeleteCascadeConstraint() {
     // TODO(developer): Replace these variables before running the sample.
     String projectId = "my-project";
     String instanceId = "my-instance";
@@ -35,22 +36,24 @@ static void alterForeignKeyDeleteCascadeConstraint() throws IOException {
   }
 
   static void alterForeignKeyDeleteCascadeConstraint(
-      String projectId, String instanceId, String databaseId) throws IOException {
-    DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create();
-
-    databaseAdminClient.updateDatabaseDdlAsync(DatabaseName.of(projectId, instanceId,
-            databaseId),
-        ImmutableList.of(
-            "ALTER TABLE ShoppingCarts\n"
-                + "              ADD CONSTRAINT FKShoppingCartsCustomerName\n"
-                + "              FOREIGN KEY (CustomerName)\n"
-                + "              REFERENCES Customers(CustomerName)\n"
-                + "              ON DELETE CASCADE\n"));
-    System.out.printf(
-        String.format(
-            "Altered ShoppingCarts table with FKShoppingCartsCustomerName\n"
-                + "foreign key constraint on database %s on instance %s",
-            databaseId, instanceId));
+      String projectId, String instanceId, String databaseId) {
+    try (Spanner spanner =
+        SpannerOptions.newBuilder().setProjectId(projectId).build().getService();
+        DatabaseAdminClient databaseAdminClient = spanner.createDatabaseAdminClient()) {
+      databaseAdminClient.updateDatabaseDdlAsync(DatabaseName.of(projectId, instanceId,
+              databaseId),
+          ImmutableList.of(
+              "ALTER TABLE ShoppingCarts\n"
+                  + "              ADD CONSTRAINT FKShoppingCartsCustomerName\n"
+                  + "              FOREIGN KEY (CustomerName)\n"
+                  + "              REFERENCES Customers(CustomerName)\n"
+                  + "              ON DELETE CASCADE\n"));
+      System.out.printf(
+          String.format(
+              "Altered ShoppingCarts table with FKShoppingCartsCustomerName\n"
+                  + "foreign key constraint on database %s on instance %s",
+              databaseId, instanceId));
+    }
   }
 }
 // [END spanner_alter_table_with_foreign_key_delete_cascade]
diff --git a/samples/snippets/src/main/java/com/example/spanner/admin/generated/CopyBackupSample.java b/samples/snippets/src/main/java/com/example/spanner/admin/generated/CopyBackupSample.java
@@ -19,13 +19,14 @@
 // [START spanner_copy_backup]
 
 import com.google.cloud.Timestamp;
+import com.google.cloud.spanner.Spanner;
 import com.google.cloud.spanner.SpannerException;
 import com.google.cloud.spanner.SpannerExceptionFactory;
+import com.google.cloud.spanner.SpannerOptions;
 import com.google.cloud.spanner.admin.database.v1.DatabaseAdminClient;
 import com.google.spanner.admin.database.v1.Backup;
 import com.google.spanner.admin.database.v1.BackupName;
 import com.google.spanner.admin.database.v1.InstanceName;
-import java.io.IOException;
 import java.time.Instant;
 import java.time.OffsetDateTime;
 import java.time.ZoneId;
@@ -34,14 +35,16 @@
 
 public class CopyBackupSample {
 
-  static void copyBackup() throws IOException {
+  static void copyBackup() {
     // TODO(developer): Replace these variables before running the sample.
     String projectId = "my-project";
     String instanceId = "my-instance";
     String sourceBackupId = "my-backup";
     String destinationBackupId = "my-destination-backup";
 
-    try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) {
+    try (Spanner spanner =
+        SpannerOptions.newBuilder().setProjectId(projectId).build().getService();
+        DatabaseAdminClient databaseAdminClient = spanner.createDatabaseAdminClient()) {
       copyBackup(databaseAdminClient, projectId, instanceId, sourceBackupId, destinationBackupId);
     }
   }

diff --git a/...pets/src/main/java/com/example/spanner/admin/generated/CreateBackupWithEncryptionKey.java b/...pets/src/main/java/com/example/spanner/admin/generated/CreateBackupWithEncryptionKey.java
@@ -18,19 +18,18 @@
 
 // [START spanner_create_backup_with_encryption_key]
 
+import com.google.cloud.spanner.Spanner;
 import com.google.cloud.spanner.SpannerExceptionFactory;
+import com.google.cloud.spanner.SpannerOptions;
 import com.google.cloud.spanner.admin.database.v1.DatabaseAdminClient;
-import com.google.cloud.spanner.encryption.EncryptionConfigs;
 import com.google.protobuf.Timestamp;
 import com.google.spanner.admin.database.v1.Backup;
 import com.google.spanner.admin.database.v1.BackupName;
 import com.google.spanner.admin.database.v1.CreateBackupEncryptionConfig;
 import com.google.spanner.admin.database.v1.CreateBackupEncryptionConfig.EncryptionType;
-import com.google.spanner.admin.database.v1.CreateBackupMetadata;
 import com.google.spanner.admin.database.v1.CreateBackupRequest;
 import com.google.spanner.admin.database.v1.DatabaseName;
 import com.google.spanner.admin.database.v1.InstanceName;
-import java.io.IOException;
 import java.util.concurrent.ExecutionException;
 import java.util.concurrent.TimeUnit;
 import java.util.concurrent.TimeoutException;
@@ -39,7 +38,7 @@
 
 public class CreateBackupWithEncryptionKey {
 
-  static void createBackupWithEncryptionKey() throws IOException {
+  static void createBackupWithEncryptionKey() {
     // TODO(developer): Replace these variables before running the sample.
     String projectId = "my-project";
     String instanceId = "my-instance";
@@ -48,7 +47,9 @@ static void createBackupWithEncryptionKey() throws IOException {
     String kmsKeyName =
         "projects/" + projectId + "/locations/<location>/keyRings/<keyRing>/cryptoKeys/<keyId>";
 
-    try (DatabaseAdminClient adminClient = DatabaseAdminClient.create()) {
+    try (Spanner spanner =
+        SpannerOptions.newBuilder().setProjectId(projectId).build().getService();
+        DatabaseAdminClient adminClient = spanner.createDatabaseAdminClient()) {
       createBackupWithEncryptionKey(
           adminClient,
           projectId,

diff --git a/...ts/src/main/java/com/example/spanner/admin/generated/CreateDatabaseWithEncryptionKey.java b/...ts/src/main/java/com/example/spanner/admin/generated/CreateDatabaseWithEncryptionKey.java
@@ -18,29 +18,32 @@
 
 // [START spanner_create_database_with_encryption_key]
 
+import com.google.cloud.spanner.Spanner;
 import com.google.cloud.spanner.SpannerExceptionFactory;
+import com.google.cloud.spanner.SpannerOptions;
 import com.google.cloud.spanner.admin.database.v1.DatabaseAdminClient;
 import com.google.common.collect.ImmutableList;
 import com.google.spanner.admin.database.v1.CreateDatabaseRequest;
 import com.google.spanner.admin.database.v1.Database;
 import com.google.spanner.admin.database.v1.EncryptionConfig;
 import com.google.spanner.admin.database.v1.InstanceName;
-import java.io.IOException;
 import java.util.concurrent.ExecutionException;
 import java.util.concurrent.TimeUnit;
 import java.util.concurrent.TimeoutException;
 
 public class CreateDatabaseWithEncryptionKey {
 
-  static void createDatabaseWithEncryptionKey() throws IOException {
+  static void createDatabaseWithEncryptionKey() {
     // TODO(developer): Replace these variables before running the sample.
     String projectId = "my-project";
     String instanceId = "my-instance";
     String databaseId = "my-database";
     String kmsKeyName =
         "projects/" + projectId + "/locations/<location>/keyRings/<keyRing>/cryptoKeys/<keyId>";
 
-    try (DatabaseAdminClient adminClient = DatabaseAdminClient.create()) {
+    try (Spanner spanner =
+        SpannerOptions.newBuilder().setProjectId(projectId).build().getService();
+        DatabaseAdminClient adminClient = spanner.createDatabaseAdminClient()) {
       createDatabaseWithEncryptionKey(
           adminClient,
           projectId,