Skip to content

Add support for timestamptz/timestamp with PostgresqlDialect #1480

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add support for timestamptz/timestamp with PostgresqlDialect #1480

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
41 changes: 40 additions & 1 deletion src/main/java/io/confluent/connect/jdbc/dialect/PostgreSqlDatabaseDialect.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,13 +44,19 @@
import java.sql.ResultSet;
import java.sql.SQLException;
import java.sql.Types;
import java.time.LocalDate;
import java.time.LocalDateTime;
import java.time.OffsetDateTime;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.Map;
import java.util.Set;
import java.util.UUID;

import static java.time.format.DateTimeFormatter.ISO_DATE_TIME;
import static java.time.format.DateTimeFormatter.ISO_OFFSET_DATE_TIME;

/**
* A {@link DatabaseDialect} for PostgreSQL.
*/
Expand Down Expand Up @@ -78,6 +84,8 @@ public DatabaseDialect create(AbstractConfig config) {
static final String JSON_TYPE_NAME = "json";
static final String JSONB_TYPE_NAME = "jsonb";
static final String UUID_TYPE_NAME = "uuid";
static final String TIMESTAMP_WITH_TIMEZONE = "timestamptz";
static final String TIMESTAMP_WITHOUT_TIMEZONE = "timestamp";

/**
* Define the PG datatypes that require casting upon insert/update statements.
Expand All @@ -86,7 +94,9 @@ public DatabaseDialect create(AbstractConfig config) {
Utils.mkSet(
JSON_TYPE_NAME,
JSONB_TYPE_NAME,
UUID_TYPE_NAME
UUID_TYPE_NAME,
TIMESTAMP_WITH_TIMEZONE,
TIMESTAMP_WITHOUT_TIMEZONE
)
);

Expand Down Expand Up @@ -239,6 +249,28 @@ public String addFieldToSchema(
return fieldName;
}

if (OffsetDateTime.class.getName().equals(columnDefn.classNameForType())) {
builder.field(
fieldName,
columnDefn.isOptional()
?
Schema.OPTIONAL_STRING_SCHEMA :
Schema.STRING_SCHEMA
);
return fieldName;
}

if (LocalDate.class.getName().equals(columnDefn.classNameForType())) {
builder.field(
fieldName,
columnDefn.isOptional()
?
Schema.OPTIONAL_STRING_SCHEMA :
Schema.STRING_SCHEMA
);
return fieldName;
}

break;
}
default:
Expand Down Expand Up @@ -280,6 +312,13 @@ protected ColumnConverter columnConverterFor(
if (UUID.class.getName().equals(columnDefn.classNameForType())) {
return rs -> rs.getString(col);
}

if (OffsetDateTime.class.getName().equals(columnDefn.classNameForType())) {
return rs -> rs.getObject(col, OffsetDateTime.class).format(ISO_OFFSET_DATE_TIME);
Copy link
Author

@mdedetrich mdedetrich Mar 4, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Using format here with explicit formatters is strictly not necessary as you could use toString instead (the value output is the same), but the usage of an explicit formatter is better as there is no risk that it would change in the future (where as .toString representations can)

}
if (LocalDateTime.class.getName().equals(columnDefn.classNameForType())) {
return rs -> rs.getObject(col, LocalDateTime.class).format(ISO_DATE_TIME);
}
break;
}
default:
Expand Down
28 changes: 24 additions & 4 deletions src/test/java/io/confluent/connect/jdbc/dialect/PostgreSqlDatabaseDialectTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,8 @@
import java.sql.SQLException;
import java.sql.Statement;
import java.sql.Types;
import java.time.LocalDateTime;
import java.time.OffsetDateTime;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collections;
Expand Down Expand Up @@ -83,6 +85,8 @@ public void testCustomColumnConverters() {
assertColumnConverter(Types.OTHER, PostgreSqlDatabaseDialect.JSON_TYPE_NAME, Schema.STRING_SCHEMA, String.class);
assertColumnConverter(Types.OTHER, PostgreSqlDatabaseDialect.JSONB_TYPE_NAME, Schema.STRING_SCHEMA, String.class);
assertColumnConverter(Types.OTHER, PostgreSqlDatabaseDialect.UUID_TYPE_NAME, Schema.STRING_SCHEMA, UUID.class);
assertColumnConverter(Types.OTHER, PostgreSqlDatabaseDialect.TIMESTAMP_WITHOUT_TIMEZONE, Schema.STRING_SCHEMA, LocalDateTime.class);
assertColumnConverter(Types.OTHER, PostgreSqlDatabaseDialect.TIMESTAMP_WITH_TIMEZONE, Schema.STRING_SCHEMA, OffsetDateTime.class);
}

@Test
Expand Down Expand Up @@ -221,16 +225,20 @@ public void shouldBuildInsertStatement() {
builder.withColumn("id2").type("int", JDBCType.INTEGER, Integer.class);
builder.withColumn("columnA").type("varchar", JDBCType.VARCHAR, Integer.class);
builder.withColumn("uuidColumn").type("uuid", JDBCType.OTHER, UUID.class);
builder.withColumn("timestamptzColumn").type("timestamptz", JDBCType.OTHER, OffsetDateTime.class);
builder.withColumn("timestampColumn").type("timestamp", JDBCType.OTHER, LocalDateTime.class);
builder.withColumn("dateColumn").type("date", JDBCType.DATE, java.sql.Date.class);
tableDefn = builder.build();
List<ColumnId> nonPkColumns = new ArrayList<>();
nonPkColumns.add(new ColumnId(tableId, "columnA"));
nonPkColumns.add(new ColumnId(tableId, "uuidColumn"));
nonPkColumns.add(new ColumnId(tableId, "timestamptzColumn"));
nonPkColumns.add(new ColumnId(tableId, "timestampColumn"));
nonPkColumns.add(new ColumnId(tableId, "dateColumn"));
assertEquals(
"INSERT INTO myTable (" +
"id1,id2,columnA,uuidColumn,dateColumn" +
") VALUES (?,?,?,?::uuid,?)",
"id1,id2,columnA,uuidColumn,timestamptzColumn,timestampColumn,dateColumn" +
") VALUES (?,?,?,?::uuid,?::timestamptz,?::timestamp,?)",
dialect.buildInsertStatement(tableId, pkColumns, nonPkColumns, tableDefn)
);
}
Expand Down Expand Up @@ -270,19 +278,25 @@ public void shouldBuildUpsertStatement() {
builder.withColumn("id2").type("int", JDBCType.INTEGER, Integer.class);
builder.withColumn("columnA").type("varchar", JDBCType.VARCHAR, Integer.class);
builder.withColumn("uuidColumn").type("uuid", JDBCType.OTHER, UUID.class);
builder.withColumn("timestamptzColumn").type("timestamptz", JDBCType.OTHER, OffsetDateTime.class);
builder.withColumn("timestampColumn").type("timestamp", JDBCType.OTHER, LocalDateTime.class);
builder.withColumn("dateColumn").type("date", JDBCType.DATE, java.sql.Date.class);
tableDefn = builder.build();
List<ColumnId> nonPkColumns = new ArrayList<>();
nonPkColumns.add(new ColumnId(tableId, "columnA"));
nonPkColumns.add(new ColumnId(tableId, "uuidColumn"));
nonPkColumns.add(new ColumnId(tableId, "timestamptzColumn"));
nonPkColumns.add(new ColumnId(tableId, "timestampColumn"));
nonPkColumns.add(new ColumnId(tableId, "dateColumn"));
assertEquals(
"INSERT INTO myTable (" +
"id1,id2,columnA,uuidColumn,dateColumn" +
") VALUES (?,?,?,?::uuid,?) ON CONFLICT (id1," +
"id1,id2,columnA,uuidColumn,timestamptzColumn,timestampColumn,dateColumn" +
") VALUES (?,?,?,?::uuid,?::timestamptz,?::timestamp,?) ON CONFLICT (id1," +
"id2) DO UPDATE SET " +
"columnA=EXCLUDED.columnA," +
"uuidColumn=EXCLUDED.uuidColumn," +
"timestamptzColumn=EXCLUDED.timestamptzColumn," +
"timestampColumn=EXCLUDED.timestampColumn," +
"dateColumn=EXCLUDED.dateColumn",
dialect.buildUpsertQueryStatement(tableId, pkColumns, nonPkColumns, tableDefn)
);
Expand All @@ -295,14 +309,20 @@ public void shouldComputeValueTypeCast() {
builder.withColumn("id2").type("int", JDBCType.INTEGER, Integer.class);
builder.withColumn("columnA").type("varchar", JDBCType.VARCHAR, Integer.class);
builder.withColumn("uuidColumn").type("uuid", JDBCType.OTHER, UUID.class);
builder.withColumn("timestamptzColumn").type("timestamptz", JDBCType.OTHER, OffsetDateTime.class);
builder.withColumn("timestampColumn").type("timestamp", JDBCType.OTHER, LocalDateTime.class);
builder.withColumn("dateColumn").type("date", JDBCType.DATE, java.sql.Date.class);
TableDefinition tableDefn = builder.build();
ColumnId uuidColumn = tableDefn.definitionForColumn("uuidColumn").id();
ColumnId timestamptzColumn = tableDefn.definitionForColumn("timestamptzColumn").id();
ColumnId timestampColumn = tableDefn.definitionForColumn("timestampColumn").id();
ColumnId dateColumn = tableDefn.definitionForColumn("dateColumn").id();
assertEquals("", dialect.valueTypeCast(tableDefn, columnPK1));
assertEquals("", dialect.valueTypeCast(tableDefn, columnPK2));
assertEquals("", dialect.valueTypeCast(tableDefn, columnA));
assertEquals("::uuid", dialect.valueTypeCast(tableDefn, uuidColumn));
assertEquals("::timestamptz", dialect.valueTypeCast(tableDefn, timestamptzColumn));
assertEquals("::timestamp", dialect.valueTypeCast(tableDefn, timestampColumn));
assertEquals("", dialect.valueTypeCast(tableDefn, dateColumn));
}

Expand Down