feat: include PostgreSQL error code in exceptions

olavloite · olavloite · commit 6bedf84abb10 · 2025-11-19T18:48:59.000+01:00
PostgreSQL error codes are now included in SpannerException when available. The PostgreSQL error code is only filled with a non-null value if the database is a Spanner PostgreSQL-dialect database, and the error is one that has a corresponding error code in PostgreSQL. See https://www.postgresql.org/docs/current/errcodes-appendix.html for a full list of all PostgreSQL error codes.
diff --git a/google-cloud-spanner/src/main/java/com/google/cloud/spanner/AsyncRunnerImpl.java b/google-cloud-spanner/src/main/java/com/google/cloud/spanner/AsyncRunnerImpl.java
@@ -59,7 +59,7 @@ private <R> R runTransaction(final AsyncWork<R> work) {
           try {
             return work.doWorkAsync(transaction).get();
           } catch (ExecutionException e) {
-            throw SpannerExceptionFactory.newSpannerException(e.getCause());
+            throw SpannerExceptionFactory.asSpannerException(e.getCause());
           } catch (InterruptedException e) {
             throw SpannerExceptionFactory.propagateInterrupt(e);
           }
diff --git a/google-cloud-spanner/src/main/java/com/google/cloud/spanner/AsyncTransactionManagerImpl.java b/google-cloud-spanner/src/main/java/com/google/cloud/spanner/AsyncTransactionManagerImpl.java
@@ -123,7 +123,7 @@ private ApiFuture<TransactionContext> internalBeginAsync(
           @Override
           public void onFailure(Throwable t) {
             onError(t);
-            res.setException(SpannerExceptionFactory.newSpannerException(t));
+            res.setException(SpannerExceptionFactory.asSpannerException(t));
           }
 
           @Override
diff --git a/google-cloud-spanner/src/main/java/com/google/cloud/spanner/GrpcResultSet.java b/google-cloud-spanner/src/main/java/com/google/cloud/spanner/GrpcResultSet.java
@@ -16,6 +16,7 @@
 
 package com.google.cloud.spanner;
 
+import static com.google.cloud.spanner.SpannerExceptionFactory.asSpannerException;
 import static com.google.cloud.spanner.SpannerExceptionFactory.newSpannerException;
 import static com.google.common.base.Preconditions.checkState;
 
@@ -76,7 +77,7 @@ protected GrpcStruct currRow() {
   @Override
   public boolean next() throws SpannerException {
     if (error != null) {
-      throw newSpannerException(error);
+      throw asSpannerException(error);
     }
     try {
       if (currRow == null) {
@@ -108,7 +109,7 @@ public boolean next() throws SpannerException {
       return hasNext;
     } catch (Throwable t) {
       throw yieldError(
-          SpannerExceptionFactory.asSpannerException(t),
+          asSpannerException(t),
           iterator.isWithBeginTransaction() && currRow == null,
           iterator.isLastStatement());
     }
diff --git a/google-cloud-spanner/src/main/java/com/google/cloud/spanner/GrpcStreamIterator.java b/google-cloud-spanner/src/main/java/com/google/cloud/spanner/GrpcStreamIterator.java
@@ -155,7 +155,7 @@ protected final PartialResultSet computeNext() {
     call = null;
 
     if (error != null) {
-      throw SpannerExceptionFactory.newSpannerException(error);
+      throw SpannerExceptionFactory.asSpannerException(error);
     }
 
     endOfData();
@@ -192,25 +192,17 @@ public void onCompleted() {
     }
 
     @Override
-    public void onError(SpannerException e) {
+    public void onError(SpannerException exception) {
       if (statement != null) {
         if (logger.isLoggable(Level.FINEST)) {
           // Include parameter values if logging level is set to FINEST or higher.
-          e =
-              SpannerExceptionFactory.newSpannerExceptionPreformatted(
-                  e.getErrorCode(),
-                  String.format("%s - Statement: '%s'", e.getMessage(), statement.toString()),
-                  e);
-          logger.log(Level.FINEST, "Error executing statement", e);
+          exception.setStatement(statement.toString());
+          logger.log(Level.FINEST, "Error executing statement", exception);
         } else {
-          e =
-              SpannerExceptionFactory.newSpannerExceptionPreformatted(
-                  e.getErrorCode(),
-                  String.format("%s - Statement: '%s'", e.getMessage(), statement.getSql()),
-                  e);
+          exception.setStatement(statement.getSql());
         }
       }
-      error = e;
+      error = exception;
       addToStream(END_OF_STREAM);
     }
 
diff --git a/google-cloud-spanner/src/main/java/com/google/cloud/spanner/MultiplexedSessionDatabaseClient.java b/google-cloud-spanner/src/main/java/com/google/cloud/spanner/MultiplexedSessionDatabaseClient.java
@@ -498,7 +498,7 @@ private void verifyBeginTransactionWithRWOnMultiplexedSessionAsync(String sessio
             }
             readWriteBeginTransactionReferenceFuture.set(txn);
           } catch (Exception e) {
-            SpannerException spannerException = SpannerExceptionFactory.newSpannerException(e);
+            SpannerException spannerException = SpannerExceptionFactory.asSpannerException(e);
             // Mark multiplexed sessions for RW as unimplemented and fall back to regular sessions
             // if UNIMPLEMENTED is returned.
             maybeMarkUnimplementedForRW(spannerException);
diff --git a/google-cloud-spanner/src/main/java/com/google/cloud/spanner/SpannerApiFutures.java b/google-cloud-spanner/src/main/java/com/google/cloud/spanner/SpannerApiFutures.java
@@ -33,7 +33,7 @@ public static <T> T getOrNull(ApiFuture<T> future) throws SpannerException {
       if (e.getCause() instanceof SpannerException) {
         throw (SpannerException) e.getCause();
       }
-      throw SpannerExceptionFactory.newSpannerException(e.getCause());
+      throw SpannerExceptionFactory.asSpannerException(e.getCause());
     } catch (InterruptedException e) {
       throw SpannerExceptionFactory.propagateInterrupt(e, null /*TODO: requestId*/);
     } catch (CancellationException e) {
diff --git a/google-cloud-spanner/src/main/java/com/google/cloud/spanner/SpannerException.java b/google-cloud-spanner/src/main/java/com/google/cloud/spanner/SpannerException.java
@@ -55,10 +55,12 @@ public String getResourceName() {
   private static final long serialVersionUID = 20150916L;
   private static final Metadata.Key<RetryInfo> KEY_RETRY_INFO =
       ProtoUtils.keyForProto(RetryInfo.getDefaultInstance());
+  private static final String PG_ERR_CODE_KEY = "pg_sqlerrcode";
 
   private final ErrorCode code;
   private final ApiException apiException;
   private XGoogSpannerRequestId requestId;
+  private String statement;
 
   /** Private constructor. Use {@link SpannerExceptionFactory} to create instances. */
   SpannerException(
@@ -99,11 +101,28 @@ public String getResourceName() {
     this.requestId = requestId;
   }
 
+  @Override
+  public String getMessage() {
+    if (this.statement == null) {
+      return super.getMessage();
+    }
+    return String.format("%s - Statement: '%s'", super.getMessage(), this.statement);
+  }
+
   /** Returns the error code associated with this exception. */
   public ErrorCode getErrorCode() {
     return code;
   }
 
+  /** Returns the PostgreSQL SQLState error code that is encoded in this exception, or null if this {@link SpannerException} does not include a PostgreSQL error code. */
+  public String getPostgreSQLErrorCode() {
+    ErrorDetails details = getErrorDetails();
+    if (details == null || details.getErrorInfo() == null) {
+      return null;
+    }
+    return details.getErrorInfo().getMetadataOrDefault(PG_ERR_CODE_KEY, null);
+  }
+
   public String getRequestId() {
     if (requestId == null) {
       return "";
@@ -199,6 +218,10 @@ public ErrorDetails getErrorDetails() {
     return null;
   }
 
+  void setStatement(String statement) {
+    this.statement = statement;
+  }
+
   /** Sets the requestId. */
   @InternalApi
   public void setRequestId(XGoogSpannerRequestId reqId) {
diff --git a/google-cloud-spanner/src/main/java/com/google/cloud/spanner/TransactionRunnerImpl.java b/google-cloud-spanner/src/main/java/com/google/cloud/spanner/TransactionRunnerImpl.java
@@ -281,7 +281,7 @@ void ensureTxn() {
       try {
         ensureTxnAsync().get();
       } catch (ExecutionException e) {
-        throw SpannerExceptionFactory.newSpannerException(e.getCause() == null ? e : e.getCause());
+        throw SpannerExceptionFactory.asSpannerException(e.getCause() == null ? e : e.getCause());
       } catch (InterruptedException e) {
         throw SpannerExceptionFactory.propagateInterrupt(e);
       }
@@ -370,7 +370,7 @@ void commit() {
           throw SpannerExceptionFactory.propagateTimeout((TimeoutException) e);
         }
       } catch (ExecutionException e) {
-        throw SpannerExceptionFactory.newSpannerException(e.getCause() == null ? e : e.getCause());
+        throw SpannerExceptionFactory.asSpannerException(e.getCause() == null ? e : e.getCause());
       }
     }
 
@@ -679,7 +679,7 @@ options, getPreviousTransactionId())))
               aborted = true;
             }
           }
-          throw SpannerExceptionFactory.newSpannerException(e.getCause());
+          throw SpannerExceptionFactory.asSpannerException(e.getCause());
         } catch (TimeoutException e) {
           // Throw an ABORTED exception to force a retry of the transaction if no transaction
           // has been returned by the first statement.
diff --git a/google-cloud-spanner/src/main/java/com/google/cloud/spanner/connection/PartitionId.java b/google-cloud-spanner/src/main/java/com/google/cloud/spanner/connection/PartitionId.java
@@ -74,7 +74,7 @@ protected Class<?> resolveClass(ObjectStreamClass desc)
       throw SpannerExceptionFactory.newSpannerException(
           ErrorCode.INVALID_ARGUMENT, invalidClassException.getMessage(), invalidClassException);
     } catch (Exception exception) {
-      throw SpannerExceptionFactory.newSpannerException(exception);
+      throw SpannerExceptionFactory.asSpannerException(exception);
     }
   }
 
@@ -90,7 +90,7 @@ public static String encodeToString(BatchTransactionId transactionId, Partition
         new ObjectOutputStream(new GZIPOutputStream(byteArrayOutputStream))) {
       objectOutputStream.writeObject(id);
     } catch (Exception exception) {
-      throw SpannerExceptionFactory.newSpannerException(exception);
+      throw SpannerExceptionFactory.asSpannerException(exception);
     }
     return Base64.getUrlEncoder().encodeToString(byteArrayOutputStream.toByteArray());
   }
diff --git a/google-cloud-spanner/src/main/java/com/google/cloud/spanner/spi/v1/GapicSpannerRpc.java b/google-cloud-spanner/src/main/java/com/google/cloud/spanner/spi/v1/GapicSpannerRpc.java
@@ -16,6 +16,7 @@
 
 package com.google.cloud.spanner.spi.v1;
 
+import static com.google.cloud.spanner.SpannerExceptionFactory.asSpannerException;
 import static com.google.cloud.spanner.SpannerExceptionFactory.newSpannerException;
 import static com.google.cloud.spanner.ThreadFactoryUtil.tryCreateVirtualThreadPerTaskExecutor;
 
@@ -538,7 +539,7 @@ public <RequestT, ResponseT> UnaryCallable<RequestT, ResponseT> createUnaryCalla
         // is actually running.
         checkEmulatorConnection(options, channelProvider, credentialsProvider, emulatorHost);
       } catch (Exception e) {
-        throw newSpannerException(e);
+        throw asSpannerException(e);
       }
     } else {
       this.databaseAdminStub = null;
@@ -726,7 +727,7 @@ private <T> T runWithRetryOnAdministrativeRequestsExceeded(Callable<T> callable)
           new AdminRequestsLimitExceededRetryAlgorithm<>(),
           NanoClock.getDefaultClock());
     } catch (RetryHelperException e) {
-      throw SpannerExceptionFactory.asSpannerException(e.getCause());
+      throw asSpannerException(e.getCause());
     }
   }
 
@@ -1317,7 +1318,7 @@ public OperationFuture<Empty, UpdateDatabaseDdlMetadata> updateDatabaseDdl(
             throw newSpannerException(e);
           } catch (ExecutionException e) {
             Throwable t = e.getCause();
-            SpannerException se = SpannerExceptionFactory.asSpannerException(t);
+            SpannerException se = asSpannerException(t);
             if (se instanceof AdminRequestsPerMinuteExceededException) {
               // Propagate this to trigger a retry.
               throw se;
@@ -1983,8 +1984,12 @@ private static <T> T get(final Future<T> future) throws SpannerException {
       // We are the sole consumer of the future, so cancel it.
       future.cancel(true);
       throw SpannerExceptionFactory.propagateInterrupt(e);
-    } catch (Exception e) {
+    } catch (ExecutionException e) {
+      throw asSpannerException(e.getCause());
+    } catch (CancellationException e) {
       throw newSpannerException(context, e, null);
+    } catch (Exception exception) {
+      throw asSpannerException(exception);
     }
   }
 
@@ -2222,7 +2227,7 @@ public void onError(Throwable t) {
       if (this.consumer.cancelQueryWhenClientIsClosed()) {
         unregisterResponseObserver(this);
       }
-      consumer.onError(newSpannerException(t));
+      consumer.onError(asSpannerException(t));
     }
 
     @Override
diff --git a/google-cloud-spanner/src/test/java/com/google/cloud/spanner/it/ITQueryTest.java b/google-cloud-spanner/src/test/java/com/google/cloud/spanner/it/ITQueryTest.java
@@ -22,6 +22,7 @@
 import static java.util.Arrays.asList;
 import static org.junit.Assert.assertEquals;
 import static org.junit.Assert.assertFalse;
+import static org.junit.Assert.assertThrows;
 import static org.junit.Assert.assertTrue;
 import static org.junit.Assert.fail;
 import static org.junit.Assume.assumeFalse;
@@ -131,16 +132,15 @@ public void simple() {
 
   @Test
   public void badQuery() {
-    try {
-      execute(Statement.of("SELECT Apples AND Oranges"), Type.int64());
-      fail("Expected exception");
-    } catch (SpannerException ex) {
-      assertThat(ex.getErrorCode()).isEqualTo(ErrorCode.INVALID_ARGUMENT);
-      if (dialect.dialect == Dialect.POSTGRESQL) {
-        assertThat(ex.getMessage()).contains("column \"apples\" does not exist");
-      } else {
-        assertThat(ex.getMessage()).contains("Unrecognized name: Apples");
-      }
+    SpannerException exception = assertThrows(SpannerException.class, () -> execute(Statement.of("SELECT Apples AND Oranges"), Type.int64()));
+    assertEquals(ErrorCode.INVALID_ARGUMENT, exception.getErrorCode());
+    if (dialect.dialect == Dialect.POSTGRESQL) {
+      assertTrue(exception.getMessage(), exception.getMessage().contains("column \"apples\" does not exist"));
+      // See https://www.postgresql.org/docs/current/errcodes-appendix.html
+      // '42703' == undefined_column
+      assertEquals("42703", exception.getPostgreSQLErrorCode());
+    } else {
+      assertTrue(exception.getMessage(), exception.getMessage().contains("Unrecognized name: Apples"));
     }
   }
 

Original file line number	Diff line number	Diff line change
`@@ -59,7 +59,7 @@ private <R> R runTransaction(final AsyncWork<R> work) {`
`59`	`59`	`try {`
`60`	`60`	`return work.doWorkAsync(transaction).get();`
`61`	`61`	`} catch (ExecutionException e) {`
`62`		`- throw SpannerExceptionFactory.newSpannerException(e.getCause());`
	`62`	`+ throw SpannerExceptionFactory.asSpannerException(e.getCause());`
`63`	`63`	`} catch (InterruptedException e) {`
`64`	`64`	`throw SpannerExceptionFactory.propagateInterrupt(e);`
`65`	`65`	`}`
Original file line number	Diff line number	Diff line change
`@@ -123,7 +123,7 @@ private ApiFuture<TransactionContext> internalBeginAsync(`
`123`	`123`	`@Override`
`124`	`124`	`public void onFailure(Throwable t) {`
`125`	`125`	`onError(t);`
`126`		`- res.setException(SpannerExceptionFactory.newSpannerException(t));`
	`126`	`+ res.setException(SpannerExceptionFactory.asSpannerException(t));`
`127`	`127`	`}`
`128`	`128`
`129`	`129`	`@Override`
Original file line number	Diff line number	Diff line change
`@@ -498,7 +498,7 @@ private void verifyBeginTransactionWithRWOnMultiplexedSessionAsync(String sessio`
`498`	`498`	`}`
`499`	`499`	`readWriteBeginTransactionReferenceFuture.set(txn);`
`500`	`500`	`} catch (Exception e) {`
`501`		`- SpannerException spannerException = SpannerExceptionFactory.newSpannerException(e);`
	`501`	`+ SpannerException spannerException = SpannerExceptionFactory.asSpannerException(e);`
`502`	`502`	`// Mark multiplexed sessions for RW as unimplemented and fall back to regular sessions`
`503`	`503`	`// if UNIMPLEMENTED is returned.`
`504`	`504`	`maybeMarkUnimplementedForRW(spannerException);`
Original file line number	Diff line number	Diff line change
`@@ -33,7 +33,7 @@ public static <T> T getOrNull(ApiFuture<T> future) throws SpannerException {`
`33`	`33`	`if (e.getCause() instanceof SpannerException) {`
`34`	`34`	`throw (SpannerException) e.getCause();`
`35`	`35`	`}`
`36`		`- throw SpannerExceptionFactory.newSpannerException(e.getCause());`
	`36`	`+ throw SpannerExceptionFactory.asSpannerException(e.getCause());`
`37`	`37`	`} catch (InterruptedException e) {`
`38`	`38`	`throw SpannerExceptionFactory.propagateInterrupt(e, null /TODO: requestId/);`
`39`	`39`	`} catch (CancellationException e) {`
Original file line number	Diff line number	Diff line change
`@@ -281,7 +281,7 @@ void ensureTxn() {`
`281`	`281`	`try {`
`282`	`282`	`ensureTxnAsync().get();`
`283`	`283`	`} catch (ExecutionException e) {`
`284`		`- throw SpannerExceptionFactory.newSpannerException(e.getCause() == null ? e : e.getCause());`
	`284`	`+ throw SpannerExceptionFactory.asSpannerException(e.getCause() == null ? e : e.getCause());`
`285`	`285`	`} catch (InterruptedException e) {`
`286`	`286`	`throw SpannerExceptionFactory.propagateInterrupt(e);`
`287`	`287`	`}`
`@@ -370,7 +370,7 @@ void commit() {`
`370`	`370`	`throw SpannerExceptionFactory.propagateTimeout((TimeoutException) e);`
`371`	`371`	`}`
`372`	`372`	`} catch (ExecutionException e) {`
`373`		`- throw SpannerExceptionFactory.newSpannerException(e.getCause() == null ? e : e.getCause());`
	`373`	`+ throw SpannerExceptionFactory.asSpannerException(e.getCause() == null ? e : e.getCause());`
`374`	`374`	`}`
`375`	`375`	`}`
`376`	`376`
`@@ -679,7 +679,7 @@ options, getPreviousTransactionId())))`
`679`	`679`	`aborted = true;`
`680`	`680`	`}`
`681`	`681`	`}`
`682`		`- throw SpannerExceptionFactory.newSpannerException(e.getCause());`
	`682`	`+ throw SpannerExceptionFactory.asSpannerException(e.getCause());`
`683`	`683`	`} catch (TimeoutException e) {`
`684`	`684`	`// Throw an ABORTED exception to force a retry of the transaction if no transaction`
`685`	`685`	`// has been returned by the first statement.`
Original file line number	Diff line number	Diff line change
`@@ -74,7 +74,7 @@ protected Class<?> resolveClass(ObjectStreamClass desc)`
`74`	`74`	`throw SpannerExceptionFactory.newSpannerException(`
`75`	`75`	`ErrorCode.INVALID_ARGUMENT, invalidClassException.getMessage(), invalidClassException);`
`76`	`76`	`} catch (Exception exception) {`
`77`		`- throw SpannerExceptionFactory.newSpannerException(exception);`
	`77`	`+ throw SpannerExceptionFactory.asSpannerException(exception);`
`78`	`78`	`}`
`79`	`79`	`}`
`80`	`80`
`@@ -90,7 +90,7 @@ public static String encodeToString(BatchTransactionId transactionId, Partition`
`90`	`90`	`new ObjectOutputStream(new GZIPOutputStream(byteArrayOutputStream))) {`
`91`	`91`	`objectOutputStream.writeObject(id);`
`92`	`92`	`} catch (Exception exception) {`
`93`		`- throw SpannerExceptionFactory.newSpannerException(exception);`
	`93`	`+ throw SpannerExceptionFactory.asSpannerException(exception);`
`94`	`94`	`}`
`95`	`95`	`return Base64.getUrlEncoder().encodeToString(byteArrayOutputStream.toByteArray());`
`96`	`96`	`}`