Skip to content

Commit

Permalink
feat: add multiple type mapping for PG adapter
Browse files Browse the repository at this point in the history
Adds 60+ different type mappings for the PostgreSQL adapter.
  • Loading branch information
thiagotnunes committed Sep 29, 2024
1 parent ab97ff6 commit c56eeaf
Show file tree
Hide file tree
Showing 13 changed files with 1,174 additions and 12 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -308,7 +308,11 @@ protected static ImmutableList<String> getTablesToMigrate(
.filter(t -> discoveredTables.contains(t))
.collect(Collectors.toList());
}
LOG.info("final list of tables to migrate: {}", tables);
LOG.info(
"final list of tables to migrate: {}, configured tables: {}, discovered tables: {}",
tables,
configTables,
discoveredTables);
return ImmutableList.copyOf(tables);
}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,34 +19,216 @@
import com.google.cloud.teleport.v2.source.reader.io.jdbc.rowmapper.JdbcValueMappingsProvider;
import com.google.cloud.teleport.v2.source.reader.io.jdbc.rowmapper.ResultSetValueExtractor;
import com.google.cloud.teleport.v2.source.reader.io.jdbc.rowmapper.ResultSetValueMapper;
import com.google.cloud.teleport.v2.source.reader.io.schema.typemapping.provider.unified.CustomSchema.TimeStampTz;
import com.google.cloud.teleport.v2.source.reader.io.schema.typemapping.provider.unified.CustomSchema.TimeTz;
import com.google.common.collect.ImmutableMap;
import java.nio.ByteBuffer;
import java.sql.ResultSet;
import java.time.Instant;
import java.time.OffsetDateTime;
import java.time.OffsetTime;
import java.time.ZoneOffset;
import java.time.format.DateTimeFormatter;
import java.time.format.DateTimeFormatterBuilder;
import java.time.temporal.ChronoField;
import java.util.Calendar;
import java.util.Map;
import java.util.TimeZone;
import java.util.concurrent.TimeUnit;
import org.apache.avro.generic.GenericRecordBuilder;
import org.apache.commons.lang3.tuple.Pair;

/** PostgreSQL data type mapping to AVRO types. */
public class PostgreSQLJdbcValueMappings implements JdbcValueMappingsProvider {

private static final Calendar UTC_CALENDAR =
Calendar.getInstance(TimeZone.getTimeZone(ZoneOffset.UTC));

private static final DateTimeFormatter TIME_FORMAT =
new DateTimeFormatterBuilder()
.appendPattern("HH:mm:ss")
.optionalStart()
.appendFraction(ChronoField.NANO_OF_SECOND, 1, 6, true)
.optionalEnd()
.appendOffsetId()
.toFormatter();

private static final DateTimeFormatter TIMETZ_FORMAT =
new DateTimeFormatterBuilder()
.appendPattern("HH:mm:ss")
.optionalStart()
.appendFraction(ChronoField.NANO_OF_SECOND, 1, 6, true)
.optionalEnd()
.appendOffset("+HH:mm", "+00")
.toFormatter();

private static final DateTimeFormatter TIMESTAMPTZ_FORMAT =
new DateTimeFormatterBuilder()
.appendPattern("yyyy-MM-dd HH:mm:ss")
.optionalStart()
.appendFraction(ChronoField.NANO_OF_SECOND, 1, 6, true)
.optionalEnd()
.appendOffset("+HH:mm", "+00")
.toFormatter();

private static long toMicros(Instant instant) {
return TimeUnit.SECONDS.toMicros(instant.getEpochSecond())
+ TimeUnit.NANOSECONDS.toMicros(instant.getNano());
}

private static long toMicros(OffsetTime offsetTime) {
return TimeUnit.HOURS.toMicros(offsetTime.getHour())
+ TimeUnit.MINUTES.toMicros(offsetTime.getMinute())
+ TimeUnit.SECONDS.toMicros(offsetTime.getSecond())
+ TimeUnit.NANOSECONDS.toMicros(offsetTime.getNano());
}

private static final ResultSetValueMapper<?> valuePassThrough = (value, schema) -> value;

private static final Calendar utcCalendar = Calendar.getInstance(TimeZone.getTimeZone("UTC"));
private static final ResultSetValueExtractor<ByteBuffer> bytesExtractor =
(rs, fieldName) -> {
byte[] bytes = rs.getBytes(fieldName);
if (bytes == null) {
return null;
}
return ByteBuffer.wrap(bytes);
};

private static final ResultSetValueExtractor<java.sql.Date> utcDateExtractor =
(rs, fieldName) -> rs.getDate(fieldName, utcCalendar);
private static final ResultSetValueExtractor<java.sql.Date> dateExtractor =
(rs, fieldName) -> rs.getDate(fieldName, UTC_CALENDAR);

private static final ResultSetValueMapper<java.sql.Date> sqlDateToAvro =
// We cannot use `java.sql.Time` here, as the PostgreSQL time might be '24:00:00'. This makes the
// java.sql.Time jump a day (from the underlying `java.sql.Date`) and microseconds extraction gets
// a wrong value. We parse the time from a String into an `OffsetTime` instead.
private static final ResultSetValueExtractor<OffsetTime> timeExtractor =
(rs, fieldName) -> {
String time = rs.getString(fieldName);
if (time == null) {
return null;
}
return OffsetTime.parse(time + ZoneOffset.UTC, TIME_FORMAT);
};

private static final ResultSetValueExtractor<OffsetTime> timetzExtractor =
(rs, fieldName) -> {
String timeTz = rs.getString(fieldName);
if (timeTz == null) {
return null;
}
return OffsetTime.parse(timeTz, TIMETZ_FORMAT);
};

private static final ResultSetValueExtractor<java.sql.Timestamp> timestampExtractor =
(rs, fieldName) -> rs.getTimestamp(fieldName, UTC_CALENDAR);

private static final ResultSetValueExtractor<OffsetDateTime> timestamptzExtractor =
(rs, fieldName) -> {
String timestampTz = rs.getString(fieldName);
if (timestampTz == null) {
return null;
}
return OffsetDateTime.parse(timestampTz, TIMESTAMPTZ_FORMAT);
};

// Value might be a Double.NaN or a valid BigDecimal
private static final ResultSetValueMapper<Number> numericToAvro =
(value, schema) -> value.toString();

private static final ResultSetValueMapper<java.sql.Date> dateToAvro =
(value, schema) -> (int) value.toLocalDate().toEpochDay();

// TODO(thiagotnunes): Add missing type mappings
private static final ResultSetValueMapper<java.sql.Timestamp> timestampToAvro =
(value, schema) -> toMicros(value.toInstant());

private static final ResultSetValueMapper<OffsetTime> timeToAvro =
(value, schema) -> toMicros(value);

private static final ResultSetValueMapper<OffsetTime> timetzToAvro =
(value, schema) ->
new GenericRecordBuilder(TimeTz.SCHEMA)
.set(
TimeTz.TIME_FIELD_NAME,
TimeUnit.NANOSECONDS.toMicros(value.toLocalTime().toNanoOfDay()))
.set(
TimeTz.OFFSET_FIELD_NAME,
TimeUnit.SECONDS.toMillis(value.getOffset().getTotalSeconds()))
.build();

private static final ResultSetValueMapper<OffsetDateTime> timestamptzToAvro =
(value, schema) ->
new GenericRecordBuilder(TimeStampTz.SCHEMA)
.set(TimeStampTz.TIMESTAMP_FIELD_NAME, toMicros(value.toInstant()))
.set(
TimeStampTz.OFFSET_FIELD_NAME,
TimeUnit.SECONDS.toMillis(value.getOffset().getTotalSeconds()))
.build();

private static final ImmutableMap<String, JdbcValueMapper<?>> SCHEMA_MAPPINGS =
ImmutableMap.<String, Pair<ResultSetValueExtractor<?>, ResultSetValueMapper<?>>>builder()
.put("BIGINT", Pair.of(ResultSet::getLong, valuePassThrough))
.put("BIGSERIAL", Pair.of(ResultSet::getLong, valuePassThrough))
.put("BIT", Pair.of(bytesExtractor, valuePassThrough))
.put("BIT VARYING", Pair.of(bytesExtractor, valuePassThrough))
.put("BOOL", Pair.of(ResultSet::getBoolean, valuePassThrough))
.put("BOOLEAN", Pair.of(ResultSet::getBoolean, valuePassThrough))
.put("BOX", Pair.of(ResultSet::getString, valuePassThrough))
.put("BYTEA", Pair.of(bytesExtractor, valuePassThrough))
.put("CHAR", Pair.of(ResultSet::getString, valuePassThrough))
.put("CHARACTER", Pair.of(ResultSet::getString, valuePassThrough))
.put("CHARACTER VARYING", Pair.of(ResultSet::getString, valuePassThrough))
.put("DATE", Pair.of(utcDateExtractor, sqlDateToAvro))
.put("CIDR", Pair.of(ResultSet::getString, valuePassThrough))
.put("CIRCLE", Pair.of(ResultSet::getString, valuePassThrough))
.put("CITEXT", Pair.of(ResultSet::getString, valuePassThrough))
.put("DATE", Pair.of(dateExtractor, dateToAvro))
.put("DECIMAL", Pair.of(ResultSet::getObject, numericToAvro))
.put("DOUBLE PRECISION", Pair.of(ResultSet::getDouble, valuePassThrough))
.put("ENUM", Pair.of(ResultSet::getString, valuePassThrough))
.put("FLOAT4", Pair.of(ResultSet::getFloat, valuePassThrough))
.put("FLOAT8", Pair.of(ResultSet::getDouble, valuePassThrough))
.put("INET", Pair.of(ResultSet::getString, valuePassThrough))
.put("INT", Pair.of(ResultSet::getInt, valuePassThrough))
.put("INTEGER", Pair.of(ResultSet::getInt, valuePassThrough))
// TODO(thiagotnunes): INTERVAL
.put("INT2", Pair.of(ResultSet::getInt, valuePassThrough))
.put("INT4", Pair.of(ResultSet::getInt, valuePassThrough))
.put("INT8", Pair.of(ResultSet::getLong, valuePassThrough))
.put("JSON", Pair.of(ResultSet::getString, valuePassThrough))
.put("JSONB", Pair.of(ResultSet::getString, valuePassThrough))
.put("LINE", Pair.of(ResultSet::getString, valuePassThrough))
.put("LSEG", Pair.of(ResultSet::getString, valuePassThrough))
.put("MACADDR", Pair.of(ResultSet::getString, valuePassThrough))
.put("MACADDR8", Pair.of(ResultSet::getString, valuePassThrough))
.put("MONEY", Pair.of(ResultSet::getDouble, valuePassThrough))
.put("NUMERIC", Pair.of(ResultSet::getObject, numericToAvro))
.put("OID", Pair.of(ResultSet::getLong, valuePassThrough))
.put("PATH", Pair.of(ResultSet::getString, valuePassThrough))
.put("PG_LSN", Pair.of(ResultSet::getString, valuePassThrough))
.put("PG_SNAPSHOT", Pair.of(ResultSet::getString, valuePassThrough))
.put("POINT", Pair.of(ResultSet::getString, valuePassThrough))
.put("POLYGON", Pair.of(ResultSet::getString, valuePassThrough))
.put("REAL", Pair.of(ResultSet::getFloat, valuePassThrough))
.put("SERIAL", Pair.of(ResultSet::getInt, valuePassThrough))
.put("SERIAL2", Pair.of(ResultSet::getInt, valuePassThrough))
.put("SERIAL4", Pair.of(ResultSet::getInt, valuePassThrough))
.put("SERIAL8", Pair.of(ResultSet::getLong, valuePassThrough))
.put("SMALLINT", Pair.of(ResultSet::getInt, valuePassThrough))
.put("SMALLSERIAL", Pair.of(ResultSet::getInt, valuePassThrough))
.put("TEXT", Pair.of(ResultSet::getString, valuePassThrough))
.put("TIME", Pair.of(timeExtractor, timeToAvro))
.put("TIMETZ", Pair.of(timetzExtractor, timetzToAvro))
.put("TIMESTAMP", Pair.of(timestampExtractor, timestampToAvro))
.put("TIMESTAMPTZ", Pair.of(timestamptzExtractor, timestamptzToAvro))
.put("TIME WITH TIME ZONE", Pair.of(timetzExtractor, timetzToAvro))
.put("TIME WITHOUT TIME ZONE", Pair.of(timeExtractor, timeToAvro))
.put("TIMESTAMP WITH TIME ZONE", Pair.of(timestamptzExtractor, timestamptzToAvro))
.put("TIMESTAMP WITHOUT TIME ZONE", Pair.of(timestampExtractor, timestampToAvro))
.put("TSQUERY", Pair.of(ResultSet::getString, valuePassThrough))
.put("TSVECTOR", Pair.of(ResultSet::getString, valuePassThrough))
.put("TXID_SNAPSHOT", Pair.of(ResultSet::getString, valuePassThrough))
.put("UUID", Pair.of(ResultSet::getString, valuePassThrough))
.put("VARBIT", Pair.of(bytesExtractor, valuePassThrough))
.put("VARCHAR", Pair.of(ResultSet::getString, valuePassThrough))
.put("XML", Pair.of(ResultSet::getString, valuePassThrough))
.build()
.entrySet()
.stream()
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,20 +33,84 @@ public final class PostgreSQLMappingProvider {
private static final ImmutableMap<String, UnifiedTypeMapping> MAPPING =
ImmutableMap.<String, UnifiedMappingProvider.Type>builder()
.put("BIGINT", UnifiedMappingProvider.Type.LONG)
.put("BIGSERIAL", UnifiedMappingProvider.Type.LONG)
.put("BIT", UnifiedMappingProvider.Type.BYTES)
.put("BIT VARYING", UnifiedMappingProvider.Type.BYTES)
.put("BOOL", UnifiedMappingProvider.Type.BOOLEAN)
.put("BOOLEAN", UnifiedMappingProvider.Type.BOOLEAN)
.put("BOX", UnifiedMappingProvider.Type.UNSUPPORTED)
.put("BYTEA", UnifiedMappingProvider.Type.BYTES)
// TODO(thiagotnunes): Refine mapping type according to
// https://cloud.google.com/datastream/docs/unified-types#map-psql (if there is a limit
// for length we should use varchar instead)
.put("CHAR", UnifiedMappingProvider.Type.STRING)
// TODO(thiagotnunes): Refine mapping type according to
// https://cloud.google.com/datastream/docs/unified-types#map-psql (if there is a limit
// for length we should use varchar instead)
.put("CHARACTER", UnifiedMappingProvider.Type.STRING)
// TODO(thiagotnunes): Refine mapping type according to
// https://cloud.google.com/datastream/docs/unified-types#map-psql (if there is a limit
// for length we should use varchar instead)
.put("CHARACTER VARYING", UnifiedMappingProvider.Type.STRING)
.put("CIDR", UnifiedMappingProvider.Type.STRING)
.put("CIRCLE", UnifiedMappingProvider.Type.UNSUPPORTED)
.put("CITEXT", UnifiedMappingProvider.Type.STRING)
.put("DATE", UnifiedMappingProvider.Type.DATE)
.put("DECIMAL", UnifiedMappingProvider.Type.NUMBER)
.put("DOUBLE PRECISION", UnifiedMappingProvider.Type.DOUBLE)
.put("ENUM", UnifiedMappingProvider.Type.STRING)
.put("FLOAT4", UnifiedMappingProvider.Type.FLOAT)
.put("FLOAT8", UnifiedMappingProvider.Type.DOUBLE)
.put("INET", UnifiedMappingProvider.Type.STRING)
.put("INT", UnifiedMappingProvider.Type.INTEGER)
.put("INTEGER", UnifiedMappingProvider.Type.INTEGER)
// TODO(thiagotnunes): INTERVAL
.put("INT2", UnifiedMappingProvider.Type.INTEGER)
.put("INT4", UnifiedMappingProvider.Type.INTEGER)
.put("INT8", UnifiedMappingProvider.Type.LONG)
.put("JSON", UnifiedMappingProvider.Type.JSON)
.put("JSONB", UnifiedMappingProvider.Type.JSON)
.put("LINE", UnifiedMappingProvider.Type.UNSUPPORTED)
.put("LSEG", UnifiedMappingProvider.Type.UNSUPPORTED)
.put("MACADDR", UnifiedMappingProvider.Type.STRING)
.put("MACADDR8", UnifiedMappingProvider.Type.STRING)
.put("MONEY", UnifiedMappingProvider.Type.DOUBLE)
.put("NUMERIC", UnifiedMappingProvider.Type.NUMBER)
.put("OID", UnifiedMappingProvider.Type.LONG)
.put("PATH", UnifiedMappingProvider.Type.UNSUPPORTED)
.put("PG_LSN", UnifiedMappingProvider.Type.UNSUPPORTED)
.put("PG_SNAPSHOT", UnifiedMappingProvider.Type.UNSUPPORTED)
.put("POINT", UnifiedMappingProvider.Type.UNSUPPORTED)
.put("POLYGON", UnifiedMappingProvider.Type.UNSUPPORTED)
.put("REAL", UnifiedMappingProvider.Type.FLOAT)
.put("SERIAL", UnifiedMappingProvider.Type.INTEGER)
.put("SERIAL2", UnifiedMappingProvider.Type.INTEGER)
.put("SERIAL4", UnifiedMappingProvider.Type.INTEGER)
.put("SERIAL8", UnifiedMappingProvider.Type.LONG)
.put("SMALLINT", UnifiedMappingProvider.Type.INTEGER)
.put("SMALLSERIAL", UnifiedMappingProvider.Type.INTEGER)
// TODO(thiagotnunes): Refine mapping type according to
// https://cloud.google.com/datastream/docs/unified-types#map-psql (if there is a limit
// for length we should use varchar instead)
.put("TEXT", UnifiedMappingProvider.Type.STRING)
.put("TIME", UnifiedMappingProvider.Type.TIME)
.put("TIMETZ", UnifiedMappingProvider.Type.TIME_WITH_TIME_ZONE)
.put("TIMESTAMP", UnifiedMappingProvider.Type.TIMESTAMP)
.put("TIMESTAMPTZ", UnifiedMappingProvider.Type.TIMESTAMP_WITH_TIME_ZONE)
.put("TIME WITH TIME ZONE", UnifiedMappingProvider.Type.TIME_WITH_TIME_ZONE)
.put("TIME WITHOUT TIME ZONE", UnifiedMappingProvider.Type.TIME)
.put("TIMESTAMP WITH TIME ZONE", UnifiedMappingProvider.Type.TIMESTAMP_WITH_TIME_ZONE)
.put("TIMESTAMP WITHOUT TIME ZONE", UnifiedMappingProvider.Type.TIMESTAMP)
.put("TSQUERY", UnifiedMappingProvider.Type.STRING)
.put("TSVECTOR", UnifiedMappingProvider.Type.STRING)
.put("TXID_SNAPSHOT", UnifiedMappingProvider.Type.STRING)
.put("UUID", UnifiedMappingProvider.Type.STRING)
.put("VARBIT", UnifiedMappingProvider.Type.BYTES)
// TODO(thiagotnunes): Refine mapping type according to
// https://cloud.google.com/datastream/docs/unified-types#map-psql (if there is a limit
// for length we should use varchar instead)
.put("VARCHAR", UnifiedMappingProvider.Type.STRING)
.put("XML", UnifiedMappingProvider.Type.STRING)
.build()
.entrySet()
.stream()
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
/*
* Copyright (C) 2024 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
package com.google.cloud.teleport.v2.source.reader.io;

import static org.junit.Assert.assertArrayEquals;
import static org.junit.Assert.assertEquals;

import java.nio.ByteBuffer;

public class CustomAsserts {

private static final double DELTA = 0.0001f;

private CustomAsserts() {}

public static void assertColumnEquals(String message, Object expected, Object actual) {
if (expected instanceof byte[] && actual instanceof byte[]) {
assertArrayEquals(message, (byte[]) expected, (byte[]) actual);
} else if (expected instanceof byte[] && actual instanceof ByteBuffer) {
assertArrayEquals(message, (byte[]) expected, ((ByteBuffer) actual).array());
} else if (expected instanceof Float && actual instanceof Float) {
assertEquals(message, (float) expected, (float) actual, DELTA);
} else if (expected instanceof Double && actual instanceof Double) {
assertEquals(message, (double) expected, (double) actual, DELTA);
} else {
assertEquals(message, expected, actual);
}
}
}
Loading

0 comments on commit c56eeaf

Please sign in to comment.