chore: make getSpanner a public method (#3022)

olavloite · gcf-owl-bot[bot] · web-flow · commit 0f8b5dc60d95 · 2024-04-18T12:11:36.000+05:30
* chore: make getSpanner a public method The underlying Spanner instance is often needed by the libraries that use the Connection API, and should therefore be made public. * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md * chore: add clirr diff --------- Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>
diff --git a/java-spanner/google-cloud-spanner/clirr-ignored-differences.xml b/java-spanner/google-cloud-spanner/clirr-ignored-differences.xml
@@ -649,4 +649,12 @@
     <className>com/google/cloud/spanner/connection/Connection</className>
     <method>void setMaxCommitDelay(java.time.Duration)</method>
   </difference>
+
+  <!-- Make getSpanner() public -->
+  <difference>
+    <differenceType>7012</differenceType>
+    <className>com/google/cloud/spanner/connection/Connection</className>
+    <method>com.google.cloud.spanner.Spanner getSpanner()</method>
+  </difference>
+
 </differences>
diff --git a/java-spanner/google-cloud-spanner/src/main/java/com/google/cloud/spanner/connection/Connection.java b/java-spanner/google-cloud-spanner/src/main/java/com/google/cloud/spanner/connection/Connection.java
@@ -33,6 +33,7 @@
 import com.google.cloud.spanner.PartitionOptions;
 import com.google.cloud.spanner.ReadContext.QueryAnalyzeMode;
 import com.google.cloud.spanner.ResultSet;
+import com.google.cloud.spanner.Spanner;
 import com.google.cloud.spanner.SpannerBatchUpdateException;
 import com.google.cloud.spanner.SpannerException;
 import com.google.cloud.spanner.Statement;
@@ -1370,6 +1371,12 @@ default DatabaseClient getDatabaseClient() {
     throw new UnsupportedOperationException("Not implemented");
   }
 
+  /** The {@link Spanner} instance that is used by this {@link Connection}. */
+  @InternalApi
+  default Spanner getSpanner() {
+    throw new UnsupportedOperationException("Not implemented");
+  }
+
   /**
    * This query option is used internally to indicate that a query is executed by the library itself
    * to fetch metadata. These queries are specifically allowed to be executed even when a DDL batch
diff --git a/java-spanner/google-cloud-spanner/src/main/java/com/google/cloud/spanner/connection/ConnectionImpl.java b/java-spanner/google-cloud-spanner/src/main/java/com/google/cloud/spanner/connection/ConnectionImpl.java
@@ -305,8 +305,8 @@ static UnitOfWorkType of(TransactionMode transactionMode) {
     setDefaultTransactionOptions();
   }
 
-  @VisibleForTesting
-  Spanner getSpanner() {
+  @Override
+  public Spanner getSpanner() {
     return this.spanner;
   }
 

Original file line number	Diff line number	Diff line change
`@@ -305,8 +305,8 @@ static UnitOfWorkType of(TransactionMode transactionMode) {`
`305`	`305`	`setDefaultTransactionOptions();`
`306`	`306`	`}`
`307`	`307`
`308`		`- @VisibleForTesting`
`309`		`- Spanner getSpanner() {`
	`308`	`+ @Override`
	`309`	`+ public Spanner getSpanner() {`
`310`	`310`	`return this.spanner;`
`311`	`311`	`}`
`312`	`312`