Apache DataFusion SQL Query Engine
fix: keep the time zone when unparsing timestamp literals (#25949)
Mohd Quamar Tyagi39e230422260
diff --git a/datafusion/sql/src/unparser/expr.rs b/datafusion/sql/src/unparser/expr.rsindex 70ee725e80..40a45d106c 100644--- a/datafusion/sql/src/unparser/expr.rs+++ b/datafusion/sql/src/unparser/expr.rs@@ -1265,7 +1265,7 @@ impl Unparser<'_> {Ok(ast::Expr::Cast {kind: ast::CastKind::Cast,expr: Box::new(ast::Expr::value(SingleQuotedString(ts))),- data_type: self.dialect.timestamp_cast_dtype(&time_unit, &None),+ data_type: self.dialect.timestamp_cast_dtype(&time_unit, &tz.cloned()),format: None,})}@@ -2214,7 +2214,7 @@ mod tests {ScalarValue::TimestampSecond(Some(10001), Some("+08:00".into())),None,),- r#"CAST('1970-01-01T10:46:41+08:00' AS TIMESTAMP)"#,+ r#"CAST('1970-01-01T10:46:41+08:00' AS TIMESTAMP WITH TIME ZONE)"#,),(Expr::Literal(ScalarValue::TimestampMillisecond(Some(10001), None), None),@@ -2225,7 +2225,7 @@ mod tests {ScalarValue::TimestampMillisecond(Some(10001), Some("+08:00".into())),None,),- r#"CAST('1970-01-01T08:00:10.001+08:00' AS TIMESTAMP)"#,+ r#"CAST('1970-01-01T08:00:10.001+08:00' AS TIMESTAMP WITH TIME ZONE)"#,),(Expr::Literal(ScalarValue::TimestampMicrosecond(Some(10001), None), None),@@ -2236,7 +2236,7 @@ mod tests {ScalarValue::TimestampMicrosecond(Some(10001), Some("+08:00".into())),None,),- r#"CAST('1970-01-01T08:00:00.010001+08:00' AS TIMESTAMP)"#,+ r#"CAST('1970-01-01T08:00:00.010001+08:00' AS TIMESTAMP WITH TIME ZONE)"#,),(Expr::Literal(ScalarValue::TimestampNanosecond(Some(10001), None), None),@@ -2247,7 +2247,7 @@ mod tests {ScalarValue::TimestampNanosecond(Some(10001), Some("+08:00".into())),None,),- r#"CAST('1970-01-01T08:00:00.000010001+08:00' AS TIMESTAMP)"#,+ r#"CAST('1970-01-01T08:00:00.000010001+08:00' AS TIMESTAMP WITH TIME ZONE)"#,),(Expr::Literal(ScalarValue::Time32Second(Some(10001)), None),@@ -3082,19 +3082,37 @@ mod tests {).build();- for (dialect, identifier) in [- (&default_dialect, "TIMESTAMP"),- (&mysql_dialect, "DATETIME"),+ let timestamp = ScalarValue::TimestampMillisecond(Some(1738285549123), None);+ let timestamp_with_tz =+ ScalarValue::TimestampMillisecond(Some(1738285549123), Some("+08:00".into()));++ for (dialect, scalar, expected) in [+ (+ &default_dialect,+ ×tamp,+ "CAST('2025-01-31 01:05:49.123' AS TIMESTAMP)",+ ),+ (+ &default_dialect,+ ×tamp_with_tz,+ "CAST('2025-01-31T09:05:49.123+08:00' AS TIMESTAMP WITH TIME ZONE)",+ ),+ (+ &mysql_dialect,+ ×tamp,+ "CAST('2025-01-31 01:05:49.123' AS DATETIME)",+ ),+ (+ &mysql_dialect,+ ×tamp_with_tz,+ "CAST('2025-01-31T09:05:49.123+08:00' AS DATETIME)",+ ),] {let unparser = Unparser::new(dialect);- let expr = Expr::Literal(- ScalarValue::TimestampMillisecond(Some(1738285549123), None),- None,- );+ let expr = Expr::Literal(scalar.clone(), None);let ast = unparser.expr_to_sql(&expr)?;let actual = format!("{ast}");- let expected = format!(r#"CAST('2025-01-31 01:05:49.123' AS {identifier})"#);assert_eq!(actual, expected);}@@ -3746,12 +3764,13 @@ mod tests {let duckdb_dialect: Arc<dyn Dialect> = Arc::new(DuckDBDialect::new());let bigquery_dialect: Arc<dyn Dialect> = Arc::new(BigQueryDialect::new());+ let snowflake_dialect: Arc<dyn Dialect> = Arc::new(SnowflakeDialect::new());for (dialect, scalar, expected) in [(Arc::clone(&default_dialect),ScalarValue::TimestampSecond(Some(1757934000), Some("+00:00".into())),- "CAST('2025-09-15T11:00:00+00:00' AS TIMESTAMP)",+ "CAST('2025-09-15T11:00:00+00:00' AS TIMESTAMP WITH TIME ZONE)",),(Arc::clone(&default_dialect),@@ -3759,7 +3778,7 @@ mod tests {Some(1757934000123),Some("+01:00".into()),),- "CAST('2025-09-15T12:00:00.123+01:00' AS TIMESTAMP)",+ "CAST('2025-09-15T12:00:00.123+01:00' AS TIMESTAMP WITH TIME ZONE)",),(Arc::clone(&default_dialect),@@ -3767,7 +3786,7 @@ mod tests {Some(1757934000123456),Some("-01:00".into()),),- "CAST('2025-09-15T10:00:00.123456-01:00' AS TIMESTAMP)",+ "CAST('2025-09-15T10:00:00.123456-01:00' AS TIMESTAMP WITH TIME ZONE)",),(Arc::clone(&default_dialect),@@ -3775,12 +3794,12 @@ mod tests {Some(1757934000123456789),Some("+00:00".into()),),- "CAST('2025-09-15T11:00:00.123456789+00:00' AS TIMESTAMP)",+ "CAST('2025-09-15T11:00:00.123456789+00:00' AS TIMESTAMP WITH TIME ZONE)",),(Arc::clone(&duckdb_dialect),ScalarValue::TimestampSecond(Some(1757934000), Some("+00:00".into())),- "CAST('2025-09-15T11:00:00+00:00' AS TIMESTAMP)",+ "CAST('2025-09-15T11:00:00+00:00' AS TIMESTAMP WITH TIME ZONE)",),(Arc::clone(&duckdb_dialect),@@ -3788,7 +3807,7 @@ mod tests {Some(1757934000123),Some("+01:00".into()),),- "CAST('2025-09-15T12:00:00.123+01:00' AS TIMESTAMP)",+ "CAST('2025-09-15T12:00:00.123+01:00' AS TIMESTAMP WITH TIME ZONE)",),(Arc::clone(&duckdb_dialect),@@ -3796,7 +3815,7 @@ mod tests {Some(1757934000123456),Some("-01:00".into()),),- "CAST('2025-09-15T10:00:00.123456-01:00' AS TIMESTAMP)",+ "CAST('2025-09-15T10:00:00.123456-01:00' AS TIMESTAMP WITH TIME ZONE)",),(Arc::clone(&duckdb_dialect),@@ -3804,7 +3823,7 @@ mod tests {Some(1757934000123456789),Some("+00:00".into()),),- "CAST('2025-09-15T11:00:00.123456789+00:00' AS TIMESTAMP)",+ "CAST('2025-09-15T11:00:00.123456789+00:00' AS TIMESTAMP WITH TIME ZONE)",),(Arc::clone(&bigquery_dialect),@@ -3835,6 +3854,14 @@ mod tests {),"CAST('2025-09-15T11:00:00.123456789+00:00' AS TIMESTAMP)",),+ (+ Arc::clone(&snowflake_dialect),+ ScalarValue::TimestampMillisecond(+ Some(1757934000123),+ Some("+01:00".into()),+ ),+ "CAST('2025-09-15T12:00:00.123+01:00' AS TIMESTAMP WITH TIME ZONE)",+ ),] {let unparser = Unparser::new(dialect.as_ref());@@ -3846,6 +3873,56 @@ mod tests {Ok(())}+ #[test]+ fn test_timestamp_literal_passes_tz_to_dialect() -> Result<()> {+ // Puts the time zone it receives into the cast type, so the generated+ // SQL shows which zone the unparser passed to the dialect.+ struct TzEchoDialect;++ impl Dialect for TzEchoDialect {+ fn identifier_quote_style(&self, _identifier: &str) -> Option<char> {+ None+ }++ fn timestamp_cast_dtype(+ &self,+ _time_unit: &TimeUnit,+ tz: &Option<Arc<str>>,+ ) -> ast::DataType {+ match tz {+ Some(tz) => ast::DataType::Custom(+ ObjectName::from(vec![Ident::new("TIMESTAMPTZ")]),+ vec![tz.to_string()],+ ),+ None => ast::DataType::Timestamp(None, TimezoneInfo::None),+ }+ }+ }++ let unparser = Unparser::new(&TzEchoDialect);++ let literal = Expr::Literal(+ ScalarValue::TimestampSecond(Some(1704078000), Some("Asia/Tokyo".into())),+ None,+ );+ let cast_expr = cast(+ col("a"),+ DataType::Timestamp(TimeUnit::Second, Some("Asia/Tokyo".into())),+ );++ for (expr, expected) in [+ (+ literal,+ "CAST('2024-01-01T12:00:00+09:00' AS TIMESTAMPTZ(Asia/Tokyo))",+ ),+ (cast_expr, "CAST(a AS TIMESTAMPTZ(Asia/Tokyo))"),+ ] {+ let actual = format!("{}", unparser.expr_to_sql(&expr)?);+ assert_eq!(actual, expected);+ }+ Ok(())+ }+#[test]fn test_bigquery_dialect_overrides() -> Result<()> {let bigquery_dialect: Arc<dyn Dialect> = Arc::new(BigQueryDialect::new());