Skip to content

[spannerchangestreamstobigquery] Spanner Change Stream to BigQuery UUID support #3698

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Abacn merged 6 commits into from
Jun 2, 2026
Merged

[spannerchangestreamstobigquery] Spanner Change Stream to BigQuery UUID support #3698

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
65d1022
Support and test UUID type columns, and UUID array columns
googledrew Mar 19, 2026
1179604
Add Integration Tests for UUID
googledrew Apr 13, 2026
91c57de
Added: Unit and IT tests for UUID PK
googledrew Apr 16, 2026
9e3e7a8
Encorporate UUID data type columns into existing Integration Tests in…
googledrew May 29, 2026
32e0193
ignore tests with unresolved issues
googledrew Jun 1, 2026
da23c50
resolve edge case with DELETE in test
googledrew Jun 1, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion ...ort/v2/templates/spannerchangestreamstobigquery/FailsafeModJsonToTableRowTransformer.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -272,7 +272,11 @@ private TableRow modJsonStringToTableRow(String modJsonString) {
// Detect schema updates (newly added tables/columns) from mod and propagate changes into
// spannerTableByName which stores schema information by table name.
// Not able to get schema update from DELETE mods as they have empty newValuesJson.
if (mod.getModType() != ModType.DELETE) {
// However, if the table is not in spannerTableByName, we should still try to update
// schema to avoid failure, especially for NEW_VALUES capture type where we can query
// INFORMATION_SCHEMA.
if (mod.getModType() != ModType.DELETE
|| !spannerTableByName.containsKey(mod.getTableName())) {
spannerTableByName =
SchemaUpdateUtils.updateStoredSchemaIfNeeded(
spannerAccessor,
Expand Down
1 change: 1 addition & 0 deletions ...rt/v2/templates/spannerchangestreamstobigquery/schemautils/SpannerChangeStreamsUtils.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -512,6 +512,7 @@ public static void appendToSpannerKey(
case DATE:
case STRING:
case TIMESTAMP:
case UUID:
keyBuilder.append(keysJsonObject.getString(name));
break;
default:
Expand Down
18 changes: 16 additions & 2 deletions ...eport/v2/templates/spannerchangestreamstobigquery/schemautils/SpannerToBigQueryUtils.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -101,11 +101,13 @@ private static TableFieldSchema tableRowColumnsToBigQueryIOField(String name, St
"PG_NUMERIC",
"PG_JSONB",
"STRING",
"TIMESTAMP"
"TIMESTAMP",
"UUID"
};
Set<String> supportedTypes = Set.of(supportedTypesArr);
if (type.startsWith("ARRAY")) {
String arrayItemType = type.substring(6, type.length() - 1);

if (supportedTypes.contains(arrayItemType)) {
if (arrayItemType.equals("PG_NUMERIC")) {
bigQueryField.setType("STRING");
Expand All @@ -114,6 +116,8 @@ private static TableFieldSchema tableRowColumnsToBigQueryIOField(String name, St
} else if (arrayItemType.equals("FLOAT32")) {
// BigQuery does not support the FLOAT32 type.
bigQueryField.setType("FLOAT64");
} else if (arrayItemType.equals("UUID")) {
Comment thread
googledrew marked this conversation as resolved.
bigQueryField.setType("STRING");
} else {
bigQueryField.setType(arrayItemType);
}
Expand All @@ -136,6 +140,8 @@ private static TableFieldSchema tableRowColumnsToBigQueryIOField(String name, St
} else if (type.equals("FLOAT32")) {
// BigQuery does not support the FLOAT32 type.
bigQueryField.setType("FLOAT64");
} else if (type.equals("UUID")) {
bigQueryField.setType("STRING");
Comment thread
googledrew marked this conversation as resolved.
} else {
bigQueryField.setType(type);
}
Expand Down Expand Up @@ -203,13 +209,19 @@ private static Object getColumnValueFromResultSet(
return removeNulls(resultSet.getPgJsonbList(columnName));
} else if (columnType.equals(Type.array(Type.string()))) {
return removeNulls(resultSet.getStringList(columnName));
} else if (columnType.equals(Type.array(Type.uuid()))) {
return removeNulls(resultSet.getUuidList(columnName)).stream()
.map(Object::toString)
.collect(Collectors.toList());
} else if (columnType.equals(Type.array(Type.timestamp()))) {
return removeNulls(resultSet.getTimestampList(columnName)).stream()
.map(e -> e.toString())
.collect(Collectors.toList());
} else {
Type.Code columnTypeCode = columnType.getCode();
switch (columnTypeCode) {
case UUID:
return resultSet.getUuid(columnName).toString();
case BOOL:
return resultSet.getBoolean(columnName);
case BYTES:
Expand Down Expand Up @@ -242,6 +254,7 @@ private static Object getColumnValueFromResultSet(
}

private static <T> List<T> removeNulls(List<T> list) {

return list.stream().filter(Objects::nonNull).collect(Collectors.toList());
}

Expand Down Expand Up @@ -310,7 +323,8 @@ public static void addSpannerNonPkColumnsToTableRow(
|| columnType.equals(Type.array(Type.pgNumeric()))
|| columnType.equals(Type.array(Type.pgJsonb()))
|| columnType.equals(Type.array(Type.string()))
|| columnType.equals(Type.array(Type.timestamp()))) {
|| columnType.equals(Type.array(Type.timestamp()))
|| columnType.equals(Type.array(Type.uuid()))) {
JSONArray jsonArray = newValuesJsonObject.getJSONArray(columnName);
List<Object> objects = new ArrayList<>(jsonArray.length());
for (int i = 0; i < jsonArray.length(); i++) {
Expand Down
4 changes: 4 additions & 0 deletions ...le/cloud/teleport/v2/templates/spannerchangestreamstobigquery/schemautils/TypesUtils.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,8 @@ public static Type informationSchemaGoogleSQLTypeToSpannerType(String type) {
return Type.string();
case "TIMESTAMP":
return Type.timestamp();
case "UUID":
return Type.uuid();
default:
if (type.startsWith("ARRAY")) {
// Get array type, e.g. "ARRAY<STRING>" -> "STRING".
Expand Down Expand Up @@ -93,6 +95,8 @@ public static Type informationSchemaPostgreSQLTypeToSpannerType(String type) {
return Type.timestamp();
case "SPANNER.COMMIT_TIMESTAMP":
return Type.timestamp();
case "UUID":
Comment thread
googledrew marked this conversation as resolved.
return Type.uuid();
default:
throw new IllegalArgumentException(
String.format("Unsupported Spanner PostgreSQL type: %s", type));
Expand Down
216 changes: 216 additions & 0 deletions ...om/google/cloud/teleport/v2/templates/spannerchangestreamstobigquery/SchemaUtilsTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,7 @@
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.UUID;
import org.apache.beam.sdk.io.gcp.spanner.changestreams.model.ModType;
import org.json.JSONObject;
import org.junit.After;
Expand Down Expand Up @@ -1101,4 +1102,219 @@ public void testCleanSpannerType() {
assertThat(SpannerToBigQueryUtils.cleanSpannerType("ARRAY<NUMERIC<PG_NUMERIC>>"))
.isEqualTo("ARRAY<NUMERIC>");
}

@Test
public void testTableRowColumnsToBigQueryIOFields_UUID() {
TableRow tableRow = new TableRow();
// GoogleSQL UUID
tableRow.put("GsqlUuidCol", "");
tableRow.put("_type_GsqlUuidCol", "UUID");
// GoogleSQL ARRAY<UUID>
tableRow.put("GsqlUuidArrCol", "");
tableRow.put("_type_GsqlUuidArrCol", "ARRAY<UUID>");
// PostgreSQL UUID
tableRow.put("PgUuidCol", "");
tableRow.put("_type_PgUuidCol", "UUID");
// PostgreSQL UUID[]
tableRow.put("PgUuidArrCol", "");
tableRow.put("_type_PgUuidArrCol", "ARRAY<UUID>");

List<TableFieldSchema> expectedFields =
ImmutableList.of(
new TableFieldSchema()
.setName("GsqlUuidCol")
.setMode(Field.Mode.NULLABLE.name())
.setType("STRING"),
new TableFieldSchema()
.setName("GsqlUuidArrCol")
.setMode(Field.Mode.REPEATED.name())
.setType("STRING"),
new TableFieldSchema()
.setName("PgUuidCol")
.setMode(Field.Mode.NULLABLE.name())
.setType("STRING"),
new TableFieldSchema()
.setName("PgUuidArrCol")
.setMode(Field.Mode.REPEATED.name())
.setType("STRING"));

List<TableFieldSchema> actualFields =
SpannerToBigQueryUtils.tableRowColumnsToBigQueryIOFields(tableRow, false);
assertThat(actualFields).containsExactlyElementsIn(expectedFields);
}

@Test
public void testSpannerSnapshotRowToBigQueryTableRow_GoogleSQL_UUID() {
String colName = "GsqlUuidCol";
String uuidVal = "a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11";
TrackedSpannerColumn column = TrackedSpannerColumn.create(colName, Type.uuid(), 1, -1);
List<TrackedSpannerColumn> spannerColumns = ImmutableList.of(column);
TableRow tableRow = new TableRow();
List<Type.StructField> structFields =
ImmutableList.of(Type.StructField.of(colName, Type.uuid()));

ResultSet resultSet =
ResultSets.forRows(
Type.struct(structFields),
Collections.singletonList(
Struct.newBuilder().set(colName).to(Value.uuid(UUID.fromString(uuidVal))).build()));
SpannerToBigQueryUtils.spannerSnapshotRowToBigQueryTableRow(
resultSet, spannerColumns, tableRow);

assertThat(tableRow.get(colName)).isEqualTo(uuidVal);
}

@Test
public void testSpannerSnapshotRowToBigQueryTableRow_GoogleSQL_ARRAY_UUID() {
Comment thread
googledrew marked this conversation as resolved.
String colName = "GsqlUuidArrCol";
List<String> uuidList =
ImmutableList.of(
"a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11", "b1eebc99-9c0b-4ef8-bb6d-6bb9bd380a12");
List<UUID> uuids = new ArrayList<>();
for (String u : uuidList) {
uuids.add(UUID.fromString(u));
}
TrackedSpannerColumn column =
TrackedSpannerColumn.create(colName, Type.array(Type.uuid()), 1, -1);
List<TrackedSpannerColumn> spannerColumns = ImmutableList.of(column);
TableRow tableRow = new TableRow();
List<Type.StructField> structFields =
ImmutableList.of(Type.StructField.of(colName, Type.array(Type.uuid())));

ResultSet resultSet =
ResultSets.forRows(
Type.struct(structFields),
Collections.singletonList(
Struct.newBuilder().set(colName).to(Value.uuidArray(uuids)).build()));
SpannerToBigQueryUtils.spannerSnapshotRowToBigQueryTableRow(
resultSet, spannerColumns, tableRow);

assertThat(tableRow.get(colName)).isEqualTo(uuidList);
}

@Test
public void testSpannerSnapshotRowToBigQueryTableRow_PostgreSQL_UUID() {
String colName = "PgUuidCol";
String uuidVal = "c0eebc99-9c0b-4ef8-bb6d-6bb9bd380a13";
TrackedSpannerColumn column = TrackedSpannerColumn.create(colName, Type.uuid(), 1, -1);
List<TrackedSpannerColumn> spannerColumns = ImmutableList.of(column);
TableRow tableRow = new TableRow();
List<Type.StructField> structFields =
ImmutableList.of(Type.StructField.of(colName, Type.uuid()));

ResultSet resultSet =
ResultSets.forRows(
Type.struct(structFields),
Collections.singletonList(
Struct.newBuilder().set(colName).to(Value.uuid(UUID.fromString(uuidVal))).build()));
SpannerToBigQueryUtils.spannerSnapshotRowToBigQueryTableRow(
resultSet, spannerColumns, tableRow);
assertThat(tableRow.get(colName)).isEqualTo(uuidVal);
}

@Test
public void testSpannerSnapshotRowToBigQueryTableRow_PostgreSQL_ARRAY_UUID() {
String colName = "PgUuidArrCol";
List<String> uuidList =
ImmutableList.of(
"a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11", "b1eebc99-9c0b-4ef8-bb6d-6bb9bd380a12");
List<UUID> uuids = new ArrayList<>();
for (String u : uuidList) {
uuids.add(UUID.fromString(u));
}
TrackedSpannerColumn column =
TrackedSpannerColumn.create(colName, Type.array(Type.uuid()), 1, -1);
List<TrackedSpannerColumn> spannerColumns = ImmutableList.of(column);
TableRow tableRow = new TableRow();
List<Type.StructField> structFields =
ImmutableList.of(Type.StructField.of(colName, Type.array(Type.uuid())));

ResultSet resultSet =
ResultSets.forRows(
Type.struct(structFields),
Collections.singletonList(
Struct.newBuilder().set(colName).to(Value.uuidArray(uuids)).build()));
SpannerToBigQueryUtils.spannerSnapshotRowToBigQueryTableRow(
resultSet, spannerColumns, tableRow);
assertThat(tableRow.get(colName)).isEqualTo(uuidList);
}

@Test
public void testSpannerSnapshotRowToBigQueryTableRow_GoogleSQL_UUID_PK() {
String pkColName = "Id";
String nonPkColName = "Value";
String uuidPkVal = "d0eebc99-9c0b-4ef8-bb6d-6bb9bd380a14";
String stringVal = "TestData";

TrackedSpannerColumn pkColumn = TrackedSpannerColumn.create(pkColName, Type.uuid(), 1, 1);
TrackedSpannerColumn nonPkColumn =
TrackedSpannerColumn.create(nonPkColName, Type.string(), 2, -1);
List<TrackedSpannerColumn> spannerColumns = ImmutableList.of(pkColumn, nonPkColumn);
TableRow tableRow = new TableRow();

List<Type.StructField> structFields =
ImmutableList.of(
Type.StructField.of(pkColName, Type.uuid()),
Type.StructField.of(nonPkColName, Type.string()));

ResultSet resultSet =
ResultSets.forRows(
Type.struct(structFields),
Collections.singletonList(
Struct.newBuilder()
.set(pkColName)
.to(Value.uuid(UUID.fromString(uuidPkVal)))
.set(nonPkColName)
.to(Value.string(stringVal))
.build()));

SpannerToBigQueryUtils.spannerSnapshotRowToBigQueryTableRow(
resultSet, spannerColumns, tableRow);

assertThat(tableRow.get(pkColName)).isEqualTo(uuidPkVal);
assertThat(tableRow.get(nonPkColName)).isEqualTo(stringVal);
}

@Test
public void testAddSpannerNonPkColumnsToTableRow_GoogleSQL_ARRAY_UUID() throws Exception {
String colName = "GsqlUuidArrCol";
List<String> uuidList =
ImmutableList.of(
"a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11", "b1eebc99-9c0b-4ef8-bb6d-6bb9bd380a12");
String newValuesJson =
"{\""
+ colName
+ "\":[\"a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11\", \"b1eebc99-9c0b-4ef8-bb6d-6bb9bd380a12\"]}";
TrackedSpannerColumn column =
TrackedSpannerColumn.create(colName, Type.array(Type.uuid()), 1, -1);
List<TrackedSpannerColumn> spannerColumns = ImmutableList.of(column);
TableRow tableRow = new TableRow();

SpannerToBigQueryUtils.addSpannerNonPkColumnsToTableRow(
newValuesJson, spannerColumns, tableRow, ModType.INSERT);

assertThat(tableRow.get(colName)).isInstanceOf(List.class);
assertThat((List<String>) tableRow.get(colName)).containsExactlyElementsIn(uuidList);
assertThat(tableRow.get("_type_" + colName)).isEqualTo("ARRAY<UUID>");
}

@Test
public void testAddSpannerNonPkColumnsToTableRow_GoogleSQL_ARRAY_UUID_WithNulls()
throws Exception {
String colName = "GsqlUuidArrCol";
List<String> expectedUuidList = ImmutableList.of("a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11");
String newValuesJson = "{\"" + colName + "\":[\"a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11\", null]}";
TrackedSpannerColumn column =
TrackedSpannerColumn.create(colName, Type.array(Type.uuid()), 1, -1);
List<TrackedSpannerColumn> spannerColumns = ImmutableList.of(column);
TableRow tableRow = new TableRow();

SpannerToBigQueryUtils.addSpannerNonPkColumnsToTableRow(
newValuesJson, spannerColumns, tableRow, ModType.INSERT);

assertThat(tableRow.get(colName)).isInstanceOf(List.class);
// Nulls should be filtered out
assertThat((List<String>) tableRow.get(colName)).containsExactlyElementsIn(expectedUuidList);
assertThat(tableRow.get("_type_" + colName)).isEqualTo("ARRAY<UUID>");
}
Comment thread
googledrew marked this conversation as resolved.
}
Loading
Loading