Skip to content

Commit

Permalink
[CALCITE-6315] Support PostgreSQL TO_CHAR, TO_DATE, TO_TIMESTAMP
Browse files Browse the repository at this point in the history 
* Both functions use PostgreSQL format patterns
* Added tests for format patterns supported by PostgreSQL but missing from Calcite
* If the data or timestamp cannot be parsed using format string, then an exception
  is thrown.
  • Loading branch information
@normanj-bitquill
normanj-bitquill committed Apr 9, 2024
1 parent 4c69588 commit 12a505e
Show file tree
Hide file tree
Showing 9 changed files with 178 additions and 6 deletions.
14 changes: 12 additions & 2 deletions babel/src/test/resources/sql/postgresql.iq
View file
Original file line number Diff line number Diff line change
Expand Up @@ -63,9 +63,19 @@ EXPR$0
2022-06-03 12:15:48.678
!ok

select to_char(timestamp '2022-06-03 12:15:48.678', 'CC');
select to_date('2022-06-03', 'YYYY-MM-DD');
EXPR$0
21
2022-06-03
!ok

select to_timestamp('18:46:32 2022-06-03', 'HH24:MI:SS YYYY-MM-DD');
EXPR$0
2022-06-03 18:46:32
!ok

select to_timestamp('18:46:32 Jun 03, 2022', 'HH24:MI:SS Mon DD, YYYY');
EXPR$0
2022-06-03 18:46:32
!ok

# -----------------------------------------------------------------------------
Expand Down
4 changes: 4 additions & 0 deletions core/src/main/java/org/apache/calcite/adapter/enumerable/RexImpTable.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -279,7 +279,9 @@
import static org.apache.calcite.sql.fun.SqlLibraryOperators.TO_BASE64;
import static org.apache.calcite.sql.fun.SqlLibraryOperators.TO_CHAR;
import static org.apache.calcite.sql.fun.SqlLibraryOperators.TO_CODE_POINTS;
import static org.apache.calcite.sql.fun.SqlLibraryOperators.TO_DATE;
import static org.apache.calcite.sql.fun.SqlLibraryOperators.TO_HEX;
import static org.apache.calcite.sql.fun.SqlLibraryOperators.TO_TIMESTAMP;
import static org.apache.calcite.sql.fun.SqlLibraryOperators.TRANSLATE3;
import static org.apache.calcite.sql.fun.SqlLibraryOperators.TRUNC_BIG_QUERY;
import static org.apache.calcite.sql.fun.SqlLibraryOperators.TRY_CAST;
Expand Down Expand Up @@ -783,6 +785,8 @@ Builder populate2() {

// Datetime formatting methods
defineReflective(TO_CHAR, BuiltInMethod.TO_CHAR.method);
defineReflective(TO_DATE, BuiltInMethod.TO_DATE.method);
defineReflective(TO_TIMESTAMP, BuiltInMethod.TO_TIMESTAMP.method);
final FormatDatetimeImplementor datetimeFormatImpl =
new FormatDatetimeImplementor();
map.put(FORMAT_DATE, datetimeFormatImpl);
Expand Down
34 changes: 34 additions & 0 deletions core/src/main/java/org/apache/calcite/runtime/SqlFunctions.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4022,6 +4022,40 @@ public String toChar(long timestamp, String pattern) {
return sb.toString().trim();
}

public int toDate(String dateString, String fmtString) {
return toInt(
new java.sql.Date(internalToDateTime(dateString, fmtString)));
}

public long toTimestamp(String timestampString, String fmtString) {
return toLong(
new java.sql.Timestamp(internalToDateTime(timestampString, fmtString)));
}

private long internalToDateTime(String dateString, String fmtString) {
final ParsePosition pos = new ParsePosition(0);

sb.setLength(0);
withElements(FormatModels.POSTGRESQL, fmtString, elements ->
elements.forEach(element -> element.toPattern(sb)));
final String dateFormatString = sb.toString().trim();

final SimpleDateFormat sdf = new SimpleDateFormat(dateFormatString, Locale.ENGLISH);
final Date date = sdf.parse(dateString, pos);
if (pos.getErrorIndex() >= 0 || pos.getIndex() != dateString.length()) {
SQLException e =
new SQLException(
String.format(Locale.ROOT,
"Invalid format: '%s' for datetime string: '%s'.", fmtString,
dateString));
throw Util.toUnchecked(e);
}

@SuppressWarnings("JavaUtilDate")
final long millisSinceEpoch = date.getTime();
return millisSinceEpoch;
}

public String formatDate(DataContext ctx, String fmtString, int date) {
return internalFormatDatetime(fmtString, internalToDate(date));
}
Expand Down
2 changes: 1 addition & 1 deletion core/src/main/java/org/apache/calcite/sql/fun/SqlLibraryOperators.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1672,7 +1672,7 @@ private static RelDataType deriveTypeMapFromEntries(SqlOperatorBinding opBinding
@LibraryOperator(libraries = {POSTGRESQL, ORACLE})
public static final SqlFunction TO_TIMESTAMP =
SqlBasicFunction.create("TO_TIMESTAMP",
ReturnTypes.DATE_NULLABLE,
ReturnTypes.TIMESTAMP_NULLABLE,
OperandTypes.STRING_STRING,
SqlFunctionCategory.TIMEDATE);

Expand Down
4 changes: 4 additions & 0 deletions core/src/main/java/org/apache/calcite/util/BuiltInMethod.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -646,6 +646,10 @@ public enum BuiltInMethod {
DataContext.class, String.class, long.class),
TO_CHAR(SqlFunctions.DateFormatFunction.class, "toChar", long.class,
String.class),
TO_DATE(SqlFunctions.DateFormatFunction.class, "toDate", String.class,
String.class),
TO_TIMESTAMP(SqlFunctions.DateFormatFunction.class, "toTimestamp", String.class,
String.class),
FORMAT_DATE(SqlFunctions.DateFormatFunction.class, "formatDate",
DataContext.class, String.class, int.class),
FORMAT_TIME(SqlFunctions.DateFormatFunction.class, "formatTime",
Expand Down
2 changes: 1 addition & 1 deletion core/src/main/java/org/apache/calcite/util/format/FormatModels.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -167,8 +167,8 @@ MI, literalElement(":"), SS, literalElement(" "),
map.put("DDD", DDD);
map.put("DD", DD);
map.put("D", D);
map.put("W", W);
map.put("WW", WW);
map.put("W", W);
map.put("IW", IW);
map.put("Q", Q);
// Our implementation of TO_CHAR does not support TIMESTAMPTZ
Expand Down
18 changes: 18 additions & 0 deletions core/src/test/java/org/apache/calcite/test/SqlFunctionsTest.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1759,6 +1759,24 @@ private void thereAndBack(byte[] bytes) {
is("1500-04-30 12:00:00.123"));
}

@Test void testToDate() {
String pattern1 = "YYYY-MM-DD";

final SqlFunctions.DateFormatFunction f =
new SqlFunctions.DateFormatFunction();

assertThat(f.toDate("2001-10-06", pattern1), is(11601));
}

@Test void testToTimestamp() {
String pattern1 = "HH24:MI:SS YYYY-MM-DD";

final SqlFunctions.DateFormatFunction f =
new SqlFunctions.DateFormatFunction();

assertThat(f.toTimestamp("18:43:36 2001-10-06", pattern1), is(1002393816000L));
}

/**
* Tests that a Unix timestamp converts to a SQL timestamp in the local time
* zone.
Expand Down
4 changes: 2 additions & 2 deletions core/src/test/java/org/apache/calcite/test/SqlValidatorTest.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1615,14 +1615,14 @@ void testLikeAndSimilarFails() {
final SqlOperatorTable opTable = operatorTableFor(SqlLibrary.POSTGRESQL);
expr("TO_TIMESTAMP('2000-01-01 01:00:00', 'YYYY-MM-DD HH:MM:SS')")
.withOperatorTable(opTable)
.columnType("DATE NOT NULL");
.columnType("TIMESTAMP(0) NOT NULL");
wholeExpr("TO_TIMESTAMP('2000-01-01 01:00:00')")
.withOperatorTable(opTable)
.fails("Invalid number of arguments to function 'TO_TIMESTAMP'. "
+ "Was expecting 2 arguments");
expr("TO_TIMESTAMP(2000, 'YYYY')")
.withOperatorTable(opTable)
.columnType("DATE NOT NULL");
.columnType("TIMESTAMP(0) NOT NULL");
wholeExpr("TO_TIMESTAMP(2000, 'YYYY')")
.withOperatorTable(opTable)
.withTypeCoercion(false)
Expand Down
102 changes: 102 additions & 0 deletions testkit/src/main/java/org/apache/calcite/test/SqlOperatorTest.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4498,11 +4498,113 @@ void testBitGetFunc(SqlOperatorFixture f, String functionName) {
f.checkString("to_char(timestamp '2022-06-03 13:15:48.678', 'IW')",
"23",
"VARCHAR NOT NULL");
f.checkString("to_char(timestamp '2022-06-03 13:15:48.678', 'YYYY')",
"2022",
"VARCHAR NOT NULL");
f.checkString("to_char(timestamp '2022-06-03 13:15:48.678', 'YY')",
"22",
"VARCHAR NOT NULL");
f.checkString("to_char(timestamp '2022-06-03 13:15:48.678', 'Month')",
"June",
"VARCHAR NOT NULL");
f.checkString("to_char(timestamp '2022-06-03 13:15:48.678', 'Mon')",
"Jun",
"VARCHAR NOT NULL");
f.checkString("to_char(timestamp '2022-06-03 13:15:48.678', 'MM')",
"06",
"VARCHAR NOT NULL");
f.checkString("to_char(timestamp '2022-06-03 13:15:48.678', 'CC')",
"21",
"VARCHAR NOT NULL");
f.checkString("to_char(timestamp '2022-06-03 13:15:48.678', 'DDD')",
"154",
"VARCHAR NOT NULL");
f.checkString("to_char(timestamp '2022-06-03 13:15:48.678', 'DD')",
"03",
"VARCHAR NOT NULL");
f.checkString("to_char(timestamp '2022-06-03 13:15:48.678', 'D')",
"6",
"VARCHAR NOT NULL");
f.checkString("to_char(timestamp '2022-06-03 13:15:48.678', 'W')",
"1",
"VARCHAR NOT NULL");
f.checkString("to_char(timestamp '2022-06-03 13:15:48.678', 'WW')",
"23",
"VARCHAR NOT NULL");
f.checkString("to_char(timestamp '2022-06-03 13:15:48.678', 'gggggg')",
"gggggg",
"VARCHAR NOT NULL");
f.checkNull("to_char(timestamp '2022-06-03 12:15:48.678', NULL)");
f.checkNull("to_char(cast(NULL as timestamp), NULL)");
f.checkNull("to_char(cast(NULL as timestamp), 'Day')");
}

@Test void testToDate() {
final SqlOperatorFixture f = fixture().withLibrary(SqlLibrary.POSTGRESQL);
f.setFor(SqlLibraryOperators.TO_DATE);

f.checkString("to_date('2022-06-03', 'YYYY-MM-DD')",
"2022-06-03",
"DATE NOT NULL");
f.checkString("to_date('0001-01-01', 'YYYY-MM-DD')",
"0001-01-01",
"DATE NOT NULL");
f.checkString("to_date('Jun 03, 2022', 'Mon DD, YYYY')",
"2022-06-03",
"DATE NOT NULL");
f.checkString("to_date('2022-June-03', 'YYYY-Month-DD')",
"2022-06-03",
"DATE NOT NULL");
f.checkString("to_date('2022-Jun-03', 'YYYY-Mon-DD')",
"2022-06-03",
"DATE NOT NULL");
f.checkString("to_date('2022-154', 'YYYY-DDD')",
"2022-06-03",
"DATE NOT NULL");
f.checkFails("to_date('ABCD', 'YYYY-MM-DD')",
"java.sql.SQLException: Invalid format: 'YYYY-MM-DD' for datetime string: 'ABCD'.",
true);
f.checkFails("to_date('2022-06-03', 'Invalid')",
"Illegal pattern character 'I'",
true);
f.checkNull("to_date(NULL, 'YYYY-MM-DD')");
f.checkNull("to_date('2022-06-03', NULL)");
f.checkNull("to_date(NULL, NULL)");
}

@Test void testToTimestamp() {
final SqlOperatorFixture f = fixture().withLibrary(SqlLibrary.POSTGRESQL);
f.setFor(SqlLibraryOperators.TO_TIMESTAMP);

f.checkString("to_timestamp('2022-06-03 18:34:56', 'YYYY-MM-DD HH24:MI:SS')",
"2022-06-03 18:34:56",
"TIMESTAMP(0) NOT NULL");
f.checkString("to_timestamp('0001-01-01 18:43:56', 'YYYY-MM-DD HH24:MI:SS')",
"0001-01-01 18:43:56",
"TIMESTAMP(0) NOT NULL");
f.checkString("to_timestamp('18:34:56 Jun 03, 2022', 'HH24:MI:SS Mon DD, YYYY')",
"2022-06-03 18:34:56",
"TIMESTAMP(0) NOT NULL");
f.checkString("to_timestamp('18:34:56 2022-June-03', 'HH24:MI:SS YYYY-Month-DD')",
"2022-06-03 18:34:56",
"TIMESTAMP(0) NOT NULL");
f.checkString("to_timestamp('18:34:56 2022-Jun-03', 'HH24:MI:SS YYYY-Mon-DD')",
"2022-06-03 18:34:56",
"TIMESTAMP(0) NOT NULL");
f.checkString("to_timestamp('18:34:56 2022-154', 'HH24:MI:SS YYYY-DDD')",
"2022-06-03 18:34:56",
"TIMESTAMP(0) NOT NULL");
f.checkFails("to_timestamp('ABCD', 'YYYY-MM-DD HH24:MI:SS')",
"java.sql.SQLException: Invalid format: 'YYYY-MM-DD HH24:MI:SS' for datetime string: 'ABCD'.",
true);
f.checkFails("to_timestamp('2022-06-03 18:34:56', 'Invalid')",
"Illegal pattern character 'I'",
true);
f.checkNull("to_timestamp(NULL, 'YYYY-MM-DD HH24:MI:SS')");
f.checkNull("to_timestamp('2022-06-03 18:34:56', NULL)");
f.checkNull("to_timestamp(NULL, NULL)");
}

@Test void testFromBase64() {
final SqlOperatorFixture f0 = fixture()
.setFor(SqlLibraryOperators.FROM_BASE64);
Expand Down

0 comments on commit 12a505e

Please sign in to comment.