Merge branch 'googleapis:main' into cmmr-samples

Author: rajatbhatta

.github/.OwlBot.lock.yaml

@@ -13,4 +13,5 @@
 # limitations under the License.
 docker:
   image: gcr.io/cloud-devrel-public-resources/owlbot-java:latest
-  digest: sha256:6566dc8226f20993af18e5a4e7a2b1ba85a292b02dedb6a1634cf10e1b418fa5
+  digest: sha256:f14e3fefe8e361e85752bd9890c8e56f2fe25f1e89cbb9597e4e3c7a429203a3
+

README.md

@@ -41,7 +41,7 @@ If you are using Maven without BOM, add this to your dependencies:
 <dependency>
   <groupId>com.google.cloud</groupId>
   <artifactId>google-cloud-spanner</artifactId>
-  <version>6.30.1</version>
+  <version>6.30.2</version>
 </dependency>
 
 ```

google-cloud-spanner/clirr-ignored-differences.xml

@@ -192,4 +192,14 @@
     <className>com/google/cloud/spanner/StructReader</className>
     <method>java.util.List getPgJsonbList(java.lang.String)</method>
   </difference>
+  <difference>
+    <differenceType>7012</differenceType>
+    <className>com/google/cloud/spanner/BatchClient</className>
+    <method>java.lang.String getDatabaseRole()</method>
+  </difference>
+  <difference>
+    <differenceType>7012</differenceType>
+    <className>com/google/cloud/spanner/DatabaseClient</className>
+    <method>java.lang.String getDatabaseRole()</method>
+  </difference>
 </differences>

google-cloud-spanner/pom.xml

@@ -359,7 +359,7 @@
     <dependency>
       <groupId>org.json</groupId>
       <artifactId>json</artifactId>
-      <version>20220320</version>
+      <version>20220924</version>
       <scope>test</scope>
     </dependency>
     <dependency>

google-cloud-spanner/src/main/java/com/google/cloud/spanner/BatchClient.java

@@ -59,4 +59,13 @@ public interface BatchClient {
    *     successive read/query.
    */
   BatchReadOnlyTransaction batchReadOnlyTransaction(BatchTransactionId batchTransactionId);
+
+  /**
+   * Returns the {@link DatabaseRole} used by the client connection. The database role that is used
+   * determines the access permissions that a connection has. This can for example be used to create
+   * connections that are only permitted to access certain tables.
+   */
+  default String getDatabaseRole() {
+    throw new UnsupportedOperationException("method should be overwritten");
+  };
 }

google-cloud-spanner/src/main/java/com/google/cloud/spanner/BatchClientImpl.java

@@ -33,6 +33,7 @@
 import io.opencensus.trace.Tracing;
 import java.util.List;
 import java.util.Map;
+import javax.annotation.Nullable;
 
 /** Default implementation for Batch Client interface. */
 public class BatchClientImpl implements BatchClient {
@@ -42,6 +43,12 @@ public class BatchClientImpl implements BatchClient {
     this.sessionClient = checkNotNull(sessionClient);
   }
 
+  @Override
+  @Nullable
+  public String getDatabaseRole() {
+    return this.sessionClient.getSpanner().getOptions().getDatabaseRole();
+  }
+
   @Override
   public BatchReadOnlyTransaction batchReadOnlyTransaction(TimestampBound bound) {
     SessionImpl session = sessionClient.createSession();

google-cloud-spanner/src/main/java/com/google/cloud/spanner/DatabaseClient.java

@@ -36,6 +36,17 @@ default Dialect getDialect() {
     throw new UnsupportedOperationException("method should be overwritten");
   }
 
+  /**
+   * Returns the {@link DatabaseRole} used by the client connection. The database role that is used
+   * determines the access permissions that a connection has. This can for example be used to create
+   * connections that are only permitted to access certain tables.
+   *
+   * @return the {@link DatabaseRole} used by the client connection.
+   */
+  default String getDatabaseRole() {
+    throw new UnsupportedOperationException("method should be overwritten");
+  }
+
   /**
    * Writes the given mutations atomically to the database.
    *

google-cloud-spanner/src/main/java/com/google/cloud/spanner/DatabaseClientImpl.java

@@ -28,6 +28,7 @@
 import io.opencensus.trace.Span;
 import io.opencensus.trace.Tracer;
 import io.opencensus.trace.Tracing;
+import javax.annotation.Nullable;
 
 class DatabaseClientImpl implements DatabaseClient {
   private static final String READ_WRITE_TRANSACTION = "CloudSpanner.ReadWriteTransaction";
@@ -58,6 +59,12 @@ public Dialect getDialect() {
     return pool.getDialect();
   }
 
+  @Override
+  @Nullable
+  public String getDatabaseRole() {
+    return pool.getDatabaseRole();
+  }
+
   @Override
   public Timestamp write(final Iterable<Mutation> mutations) throws SpannerException {
     return writeWithOptions(mutations).getCommitTimestamp();

google-cloud-spanner/src/main/java/com/google/cloud/spanner/SessionPool.java

@@ -1784,6 +1784,7 @@ private enum Position {
 
   private final SessionPoolOptions options;
   private final SettableFuture<Dialect> dialect = SettableFuture.create();
+  private final String databaseRole;
   private final SessionClient sessionClient;
   private final ScheduledExecutorService executor;
   private final ExecutorFactory<ScheduledExecutorService> executorFactory;
@@ -1858,6 +1859,7 @@ static SessionPool createPool(
       SpannerOptions spannerOptions, SessionClient sessionClient, List<LabelValue> labelValues) {
     return createPool(
         spannerOptions.getSessionPoolOptions(),
+        spannerOptions.getDatabaseRole(),
         ((GrpcTransportOptions) spannerOptions.getTransportOptions()).getExecutorFactory(),
         sessionClient,
         new Clock(),
@@ -1879,6 +1881,7 @@ static SessionPool createPool(
       Clock clock) {
     return createPool(
         poolOptions,
+        null,
         executorFactory,
         sessionClient,
         clock,
@@ -1888,6 +1891,7 @@ static SessionPool createPool(
 
   static SessionPool createPool(
       SessionPoolOptions poolOptions,
+      String databaseRole,
       ExecutorFactory<ScheduledExecutorService> executorFactory,
       SessionClient sessionClient,
       Clock clock,
@@ -1896,6 +1900,7 @@ static SessionPool createPool(
     SessionPool pool =
         new SessionPool(
             poolOptions,
+            databaseRole,
             executorFactory,
             executorFactory.get(),
             sessionClient,
@@ -1908,13 +1913,15 @@ static SessionPool createPool(
 
   private SessionPool(
       SessionPoolOptions options,
+      String databaseRole,
       ExecutorFactory<ScheduledExecutorService> executorFactory,
       ScheduledExecutorService executor,
       SessionClient sessionClient,
       Clock clock,
       MetricRegistry metricRegistry,
       List<LabelValue> labelValues) {
     this.options = options;
+    this.databaseRole = databaseRole;
     this.executorFactory = executorFactory;
     this.executor = executor;
     this.sessionClient = sessionClient;
@@ -1956,6 +1963,11 @@ Dialect getDialect() {
     }
   }
 
+  @Nullable
+  public String getDatabaseRole() {
+    return databaseRole;
+  }
+
   @VisibleForTesting
   int getNumberOfSessionsInUse() {
     synchronized (lock) {

google-cloud-spanner/src/test/java/com/google/cloud/spanner/BatchClientImplTest.java

@@ -17,6 +17,7 @@
 package com.google.cloud.spanner;
 
 import static com.google.common.truth.Truth.assertThat;
+import static org.junit.Assert.assertEquals;
 import static org.mockito.ArgumentMatchers.anyString;
 import static org.mockito.Mockito.anyMap;
 import static org.mockito.Mockito.eq;
@@ -115,4 +116,9 @@ public void testBatchReadOnlyTxnWithTxnId() {
     assertThat(batchTxn.getReadTimestamp())
         .isEqualTo(batchTxn.getBatchTransactionId().getTimestamp());
   }
+
+  @Test
+  public void testGetDatabaseRole() {
+    assertEquals(client.getDatabaseRole(), "role");
+  }
 }