feat: add PG OID support

.gitignore

@@ -31,3 +31,5 @@ docs/
 *.pyc
 
 .flattened-pom.xml
+.java-version
+.vscode/

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

@@ -192,6 +192,48 @@
     <className>com/google/cloud/spanner/StructReader</className>
     <method>java.util.List getPgJsonbList(java.lang.String)</method>
   </difference>
+  <!-- PG OID -->
+  <difference>
+    <differenceType>7012</differenceType>
+    <className>com/google/cloud/spanner/StructReader</className>
+    <method>long getPgOid(int)</method>
+  </difference>
+  <difference>
+    <differenceType>7012</differenceType>
+    <className>com/google/cloud/spanner/StructReader</className>
+    <method>long getPgOid(java.lang.String)</method>
+  </difference>
+  <difference>
+    <differenceType>7012</differenceType>
+    <className>com/google/cloud/spanner/StructReader</className>
+    <method>long[] getPgOidArray(int)</method>
+  </difference>
+  <difference>
+    <differenceType>7012</differenceType>
+    <className>com/google/cloud/spanner/StructReader</className>
+    <method>long[] getPgOidArray(java.lang.String)</method>
+  </difference>
+  <difference>
+    <differenceType>7012</differenceType>
+    <className>com/google/cloud/spanner/StructReader</className>
+    <method>java.util.List getPgOidList(int)</method>
+  </difference>
+  <difference>
+    <differenceType>7012</differenceType>
+    <className>com/google/cloud/spanner/StructReader</className>
+    <method>java.util.List getPgOidList(java.lang.String)</method>
+  </difference>
+  <difference>
+    <differenceType>7013</differenceType>
+    <className>com/google/cloud/spanner/Value</className>
+    <method>long getPgOid()</method>
+  </difference>
+  <difference>
+    <differenceType>7013</differenceType>
+    <className>com/google/cloud/spanner/Value</className>
+    <method>java.util.List getPgOidArray()</method>
+  </difference>
+
   <difference>
     <differenceType>7012</differenceType>
     <className>com/google/cloud/spanner/StructReader</className>

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

@@ -400,6 +400,11 @@ protected String getPgJsonbInternal(int columnIndex) {
     return currRow().getPgJsonbInternal(columnIndex);
   }
 
+  @Override
+  protected long getPgOidInternal(int columnIndex) {
+    return currRow().getPgOidInternal(columnIndex);
+  }
+
   @Override
   protected ByteArray getBytesInternal(int columnIndex) {
     return currRow().getBytesInternal(columnIndex);
@@ -480,6 +485,16 @@ protected List<String> getPgJsonbListInternal(int columnIndex) {
     return currRow().getJsonListInternal(columnIndex);
   }
 
+  @Override
+  protected long[] getPgOidArrayInternal(int columnIndex) {
+    return currRow().getPgOidArrayInternal(columnIndex);
+  }
+
+  @Override
+  protected List<Long> getPgOidListInternal(int columnIndex) {
+    return currRow().getPgOidListInternal(columnIndex);
+  }
+
   @Override
   protected List<ByteArray> getBytesListInternal(int columnIndex) {
     return currRow().getBytesListInternal(columnIndex);

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

@@ -61,6 +61,10 @@ protected String getPgJsonbInternal(int columnIndex) {
     throw new UnsupportedOperationException("Not implemented");
   }
 
+  protected long getPgOidInternal(int columnIndex) {
+    throw new UnsupportedOperationException("Not implemented");
+  }
+
   protected abstract ByteArray getBytesInternal(int columnIndex);
 
   protected abstract Timestamp getTimestampInternal(int columnIndex);
@@ -122,6 +126,14 @@ protected List<String> getPgJsonbListInternal(int columnIndex) {
     throw new UnsupportedOperationException("Not implemented");
   }
 
+  protected long[] getPgOidArrayInternal(int columnIndex) {
+    throw new UnsupportedOperationException("Not implemented");
+  }
+
+  protected List<Long> getPgOidListInternal(int columnIndex) {
+    throw new UnsupportedOperationException("Not implemented");
+  }
+
   protected abstract List<ByteArray> getBytesListInternal(int columnIndex);
 
   protected abstract List<Timestamp> getTimestampListInternal(int columnIndex);
@@ -165,15 +177,20 @@ public boolean getBoolean(String columnName) {
 
   @Override
   public long getLong(int columnIndex) {
-    checkNonNullOfCodes(columnIndex, Arrays.asList(Code.ENUM, Code.INT64), columnIndex);
-    return getLongInternal(columnIndex);
+    checkNonNullOfCodes(
+        columnIndex, Arrays.asList(Code.ENUM, Code.PG_OID, Code.INT64), columnIndex);
+    return getColumnType(columnIndex).getCode() == Code.PG_OID
+        ? getPgOidInternal(columnIndex)
+        : getLongInternal(columnIndex);
   }
 
   @Override
   public long getLong(String columnName) {
     int columnIndex = getColumnIndex(columnName);
-    checkNonNullOfCodes(columnIndex, Arrays.asList(Code.ENUM, Code.INT64), columnName);
-    return getLongInternal(columnIndex);
+    checkNonNullOfCodes(columnIndex, Arrays.asList(Code.ENUM, Code.PG_OID, Code.INT64), columnName);
+    return getColumnType(columnIndex).getCode() == Code.PG_OID
+        ? getPgOidInternal(columnIndex)
+        : getLongInternal(columnIndex);
   }
 
   @Override
@@ -366,31 +383,43 @@ public List<Boolean> getBooleanList(String columnName) {
   @Override
   public long[] getLongArray(int columnIndex) {
     checkNonNullOfCodes(columnIndex, Collections.singletonList(Code.ARRAY), columnIndex);
-    checkArrayElementType(columnIndex, Arrays.asList(Code.ENUM, Code.INT64), columnIndex);
-    return getLongArrayInternal(columnIndex);
+    checkArrayElementType(
+        columnIndex, Arrays.asList(Code.ENUM, Code.PG_OID, Code.INT64), columnIndex);
+    return getColumnType(columnIndex).getArrayElementType().getCode() == Code.PG_OID
+        ? getPgOidArrayInternal(columnIndex)
+        : getLongArrayInternal(columnIndex);
   }
 
   @Override
   public long[] getLongArray(String columnName) {
     int columnIndex = getColumnIndex(columnName);
     checkNonNullOfCodes(columnIndex, Collections.singletonList(Code.ARRAY), columnName);
-    checkArrayElementType(columnIndex, Arrays.asList(Code.ENUM, Code.INT64), columnName);
-    return getLongArrayInternal(columnIndex);
+    checkArrayElementType(
+        columnIndex, Arrays.asList(Code.ENUM, Code.PG_OID, Code.INT64), columnName);
+    return getColumnType(columnIndex).getArrayElementType().getCode() == Code.PG_OID
+        ? getPgOidArrayInternal(columnIndex)
+        : getLongArrayInternal(columnIndex);
   }
 
   @Override
   public List<Long> getLongList(int columnIndex) {
     checkNonNullOfCodes(columnIndex, Collections.singletonList(Code.ARRAY), columnIndex);
-    checkArrayElementType(columnIndex, Arrays.asList(Code.ENUM, Code.INT64), columnIndex);
-    return getLongListInternal(columnIndex);
+    checkArrayElementType(
+        columnIndex, Arrays.asList(Code.ENUM, Code.PG_OID, Code.INT64), columnIndex);
+    return getColumnType(columnIndex).getArrayElementType().getCode() == Code.PG_OID
+        ? getPgOidListInternal(columnIndex)
+        : getLongListInternal(columnIndex);
   }
 
   @Override
   public List<Long> getLongList(String columnName) {
     int columnIndex = getColumnIndex(columnName);
     checkNonNullOfCodes(columnIndex, Collections.singletonList(Code.ARRAY), columnName);
-    checkArrayElementType(columnIndex, Arrays.asList(Code.ENUM, Code.INT64), columnName);
-    return getLongListInternal(columnIndex);
+    checkArrayElementType(
+        columnIndex, Arrays.asList(Code.ENUM, Code.PG_OID, Code.INT64), columnName);
+    return getColumnType(columnIndex).getArrayElementType().getCode() == Code.PG_OID
+        ? getPgOidListInternal(columnIndex)
+        : getLongListInternal(columnIndex);
   }
 
   @Override

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

@@ -114,6 +114,9 @@ private Object writeReplace() {
         case PG_JSONB:
           builder.set(fieldName).to(Value.pgJsonb((String) value));
           break;
+        case PG_OID:
+          builder.set(fieldName).to(Value.pgOid((Long) value));
+          break;
         case BYTES:
           builder
               .set(fieldName)
@@ -158,6 +161,9 @@ private Object writeReplace() {
             case PG_JSONB:
               builder.set(fieldName).toPgJsonbArray((Iterable<String>) value);
               break;
+            case PG_OID:
+              builder.set(fieldName).toPgOidArray((Iterable<Long>) value);
+              break;
             case BYTES:
             case PROTO:
               builder
@@ -262,6 +268,7 @@ private static Object decodeValue(Type fieldType, com.google.protobuf.Value prot
         checkType(fieldType, proto, KindCase.BOOL_VALUE);
         return proto.getBoolValue();
       case INT64:
+      case PG_OID:
       case ENUM:
         checkType(fieldType, proto, KindCase.STRING_VALUE);
         return Long.parseLong(proto.getStringValue());
@@ -319,6 +326,7 @@ private static Struct decodeStructValue(Type structType, ListValue structValue)
   static Object decodeArrayValue(Type elementType, ListValue listValue) {
     switch (elementType.getCode()) {
       case INT64:
+      case PG_OID:
       case ENUM:
         // For int64/float64/float32/enum types, use custom containers.
         // These avoid wrapper object creation for non-null arrays.
@@ -460,6 +468,12 @@ protected String getPgJsonbInternal(int columnIndex) {
     return (String) rowData.get(columnIndex);
   }
 
+  @Override
+  protected long getPgOidInternal(int columnIndex) {
+    ensureDecoded(columnIndex);
+    return (Long) rowData.get(columnIndex);
+  }
+
   @Override
   protected ByteArray getBytesInternal(int columnIndex) {
     ensureDecoded(columnIndex);
@@ -563,6 +577,8 @@ protected Value getValueInternal(int columnIndex) {
         return Value.json(isNull ? null : getJsonInternal(columnIndex));
       case PG_JSONB:
         return Value.pgJsonb(isNull ? null : getPgJsonbInternal(columnIndex));
+      case PG_OID:
+        return Value.pgOid(isNull ? null : getLongInternal(columnIndex));
       case BYTES:
         return Value.internalBytes(isNull ? null : getLazyBytesInternal(columnIndex));
       case PROTO:
@@ -598,6 +614,8 @@ protected Value getValueInternal(int columnIndex) {
             return Value.jsonArray(isNull ? null : getJsonListInternal(columnIndex));
           case PG_JSONB:
             return Value.pgJsonbArray(isNull ? null : getPgJsonbListInternal(columnIndex));
+          case PG_OID:
+            return Value.pgOidArray(isNull ? null : getLongListInternal(columnIndex));
           case BYTES:
             return Value.bytesArray(isNull ? null : getBytesListInternal(columnIndex));
           case PROTO:
@@ -771,6 +789,18 @@ protected List<String> getPgJsonbListInternal(int columnIndex) {
     return Collections.unmodifiableList((List<String>) rowData.get(columnIndex));
   }
 
+  @Override
+  protected Int64Array getPgOidListInternal(int columnIndex) {
+    ensureDecoded(columnIndex);
+    return (Int64Array) rowData.get(columnIndex);
+  }
+
+  @Override
+  protected long[] getPgOidArrayInternal(int columnIndex) {
+    ensureDecoded(columnIndex);
+    return getPgOidListInternal(columnIndex).toPrimitiveArray(columnIndex);
+  }
+
   @Override
   @SuppressWarnings("unchecked") // We know ARRAY<BYTES> produces a List<LazyByteArray>.
   protected List<ByteArray> getBytesListInternal(int columnIndex) {

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

@@ -211,6 +211,11 @@ protected String getPgJsonbInternal(int columnIndex) {
       return values.get(columnIndex).getPgJsonb();
     }
 
+    @Override
+    protected long getPgOidInternal(int columnIndex) {
+      return values.get(columnIndex).getPgOid();
+    }
+
     @Override
     protected ByteArray getBytesInternal(int columnIndex) {
       return values.get(columnIndex).getBytes();
@@ -307,6 +312,16 @@ protected List<String> getPgJsonbListInternal(int columnIndex) {
       return values.get(columnIndex).getPgJsonbArray();
     }
 
+    @Override
+    protected long[] getPgOidArrayInternal(int columnIndex) {
+      return Longs.toArray(getPgOidListInternal(columnIndex));
+    }
+
+    @Override
+    protected List<Long> getPgOidListInternal(int columnIndex) {
+      return values.get(columnIndex).getPgOidArray();
+    }
+
     @Override
     protected List<ByteArray> getBytesListInternal(int columnIndex) {
       return values.get(columnIndex).getBytesArray();
@@ -396,6 +411,7 @@ private Object getAsObject(int columnIndex) {
       case BOOL:
         return getBooleanInternal(columnIndex);
       case INT64:
+      case PG_OID:
       case ENUM:
         return getLongInternal(columnIndex);
       case FLOAT32:
@@ -426,6 +442,7 @@ private Object getAsObject(int columnIndex) {
           case BOOL:
             return getBooleanListInternal(columnIndex);
           case INT64:
+          case PG_OID:
           case ENUM:
             return getLongListInternal(columnIndex);
           case FLOAT32:

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

@@ -55,6 +55,7 @@ public final class Type implements Serializable {
   private static final Type TYPE_STRING = new Type(Code.STRING, null, null);
   private static final Type TYPE_JSON = new Type(Code.JSON, null, null);
   private static final Type TYPE_PG_JSONB = new Type(Code.PG_JSONB, null, null);
+  private static final Type TYPE_PG_OID = new Type(Code.PG_OID, null, null);
   private static final Type TYPE_BYTES = new Type(Code.BYTES, null, null);
   private static final Type TYPE_TIMESTAMP = new Type(Code.TIMESTAMP, null, null);
   private static final Type TYPE_DATE = new Type(Code.DATE, null, null);
@@ -67,6 +68,7 @@ public final class Type implements Serializable {
   private static final Type TYPE_ARRAY_STRING = new Type(Code.ARRAY, TYPE_STRING, null);
   private static final Type TYPE_ARRAY_JSON = new Type(Code.ARRAY, TYPE_JSON, null);
   private static final Type TYPE_ARRAY_PG_JSONB = new Type(Code.ARRAY, TYPE_PG_JSONB, null);
+  private static final Type TYPE_ARRAY_PG_OID = new Type(Code.ARRAY, TYPE_PG_OID, null);
   private static final Type TYPE_ARRAY_BYTES = new Type(Code.ARRAY, TYPE_BYTES, null);
   private static final Type TYPE_ARRAY_TIMESTAMP = new Type(Code.ARRAY, TYPE_TIMESTAMP, null);
   private static final Type TYPE_ARRAY_DATE = new Type(Code.ARRAY, TYPE_DATE, null);
@@ -137,6 +139,11 @@ public static Type pgJsonb() {
     return TYPE_PG_JSONB;
   }
 
+  /** Returns the descriptor for the {@code PG_OID} type. */
+  public static Type pgOid() {
+    return TYPE_PG_OID;
+  }
+
   /**
    * To get the descriptor for the {@code PROTO} type.
    *
@@ -198,6 +205,8 @@ public static Type array(Type elementType) {
         return TYPE_ARRAY_JSON;
       case PG_JSONB:
         return TYPE_ARRAY_PG_JSONB;
+      case PG_OID:
+        return TYPE_ARRAY_PG_OID;
       case BYTES:
         return TYPE_ARRAY_BYTES;
       case TIMESTAMP:
@@ -280,6 +289,7 @@ public enum Code {
     STRING(TypeCode.STRING, "character varying"),
     JSON(TypeCode.JSON, "unknown"),
     PG_JSONB(TypeCode.JSON, "jsonb", TypeAnnotationCode.PG_JSONB),
+    PG_OID(TypeCode.INT64, "oid", TypeAnnotationCode.PG_OID),
     PROTO(TypeCode.PROTO, "proto"),
     ENUM(TypeCode.ENUM, "enum"),
     BYTES(TypeCode.BYTES, "bytea"),
@@ -592,6 +602,8 @@ static Type fromProto(com.google.spanner.v1.Type proto) {
         return json();
       case PG_JSONB:
         return pgJsonb();
+      case PG_OID:
+        return pgOid();
       case BYTES:
         return bytes();
       case TIMESTAMP: