Skip to content

Apache DataFusion SQL Query Engine

feat: add `custom_string_literal_override` to unparser Dialect trait (#20590)

Jax Liubd071be1dcc0
diff --git a/datafusion/sql/src/unparser/dialect.rs b/datafusion/sql/src/unparser/dialect.rs
index 31d2662cc4..fe278a0e1e 100644
--- a/datafusion/sql/src/unparser/dialect.rs
+++ b/datafusion/sql/src/unparser/dialect.rs
@@ -248,6 +248,17 @@ pub trait Dialect: Send + Sync {
fn supports_empty_select_list(&self) -> bool {
false
}
+
+ /// Override the default string literal unparsing.
+ ///
+ /// Returns `Some(ast::Expr)` to replace the default single-quoted string,
+ /// or `None` to use the default behavior.
+ ///
+ /// For example, MSSQL requires non-ASCII strings to use national string
+ /// literal syntax (`N'datafusion資料融合'`).
+ fn string_literal_to_sql(&self, _s: &str) -> Option<ast::Expr> {
+ None
+ }
}
/// `IntervalStyle` to use for unparsing
diff --git a/datafusion/sql/src/unparser/expr.rs b/datafusion/sql/src/unparser/expr.rs
index 503048bb3c..54c8eeb125 100644
--- a/datafusion/sql/src/unparser/expr.rs
+++ b/datafusion/sql/src/unparser/expr.rs
@@ -1294,18 +1294,17 @@ impl Unparser<'_> {
Ok(ast::Expr::value(ast::Value::Number(ui.to_string(), false)))
}
ScalarValue::UInt64(None) => Ok(ast::Expr::value(ast::Value::Null)),
- ScalarValue::Utf8(Some(str)) => {
- Ok(ast::Expr::value(SingleQuotedString(str.to_string())))
- }
- ScalarValue::Utf8(None) => Ok(ast::Expr::value(ast::Value::Null)),
- ScalarValue::Utf8View(Some(str)) => {
- Ok(ast::Expr::value(SingleQuotedString(str.to_string())))
- }
- ScalarValue::Utf8View(None) => Ok(ast::Expr::value(ast::Value::Null)),
- ScalarValue::LargeUtf8(Some(str)) => {
+ ScalarValue::Utf8(Some(str))
+ | ScalarValue::Utf8View(Some(str))
+ | ScalarValue::LargeUtf8(Some(str)) => {
+ if let Some(expr) = self.dialect.string_literal_to_sql(str) {
+ return Ok(expr);
+ }
Ok(ast::Expr::value(SingleQuotedString(str.to_string())))
}
- ScalarValue::LargeUtf8(None) => Ok(ast::Expr::value(ast::Value::Null)),
+ ScalarValue::Utf8(None)
+ | ScalarValue::Utf8View(None)
+ | ScalarValue::LargeUtf8(None) => Ok(ast::Expr::value(ast::Value::Null)),
ScalarValue::Binary(Some(_)) => not_impl_err!("Unsupported scalar: {v:?}"),
ScalarValue::Binary(None) => Ok(ast::Expr::value(ast::Value::Null)),
ScalarValue::BinaryView(Some(_)) => {
@@ -2397,7 +2396,6 @@ mod tests {
let expected = r#"('a' > 4)"#;
assert_eq!(actual, expected);
-
Ok(())
}
@@ -2960,6 +2958,70 @@ mod tests {
Ok(())
}
+ #[test]
+ fn test_mssql_dialect_national_literal() -> Result<()> {
+ struct MsSqlDialect;
+
+ impl Dialect for MsSqlDialect {
+ fn identifier_quote_style(&self, _identifier: &str) -> Option<char> {
+ Some('[')
+ }
+
+ fn string_literal_to_sql(&self, s: &str) -> Option<ast::Expr> {
+ if !s.is_ascii() {
+ Some(ast::Expr::value(ast::Value::NationalStringLiteral(
+ s.to_string(),
+ )))
+ } else {
+ None
+ }
+ }
+ }
+
+ let dialect = MsSqlDialect;
+ let unparser = Unparser::new(&dialect);
+
+ // Get nation string literal for the custom mssql dialect
+ for (s, expected) in [
+ ("national string", "'national string'"),
+ ("datafusion資料融合", "N'datafusion資料融合'"),
+ ] {
+ let expr = Expr::Literal(ScalarValue::Utf8(Some(s.to_string())), None);
+ let ast = unparser.expr_to_sql(&expr)?;
+ assert_eq!(ast.to_string(), expected);
+
+ let expr = Expr::Literal(ScalarValue::Utf8View(Some(s.to_string())), None);
+ let ast = unparser.expr_to_sql(&expr)?;
+ assert_eq!(ast.to_string(), expected);
+
+ let expr = Expr::Literal(ScalarValue::LargeUtf8(Some(s.to_string())), None);
+ let ast = unparser.expr_to_sql(&expr)?;
+ assert_eq!(ast.to_string(), expected);
+ }
+
+ let dialect = DefaultDialect {};
+ let unparser = Unparser::new(&dialect);
+
+ // Get normal string literal for default dialect
+ for (s, expected) in [
+ ("national string", "'national string'"),
+ ("datafusion資料融合", "'datafusion資料融合'"),
+ ] {
+ let expr = Expr::Literal(ScalarValue::Utf8(Some(s.to_string())), None);
+ let ast = unparser.expr_to_sql(&expr)?;
+ assert_eq!(ast.to_string(), expected);
+
+ let expr = Expr::Literal(ScalarValue::Utf8View(Some(s.to_string())), None);
+ let ast = unparser.expr_to_sql(&expr)?;
+ assert_eq!(ast.to_string(), expected);
+
+ let expr = Expr::Literal(ScalarValue::LargeUtf8(Some(s.to_string())), None);
+ let ast = unparser.expr_to_sql(&expr)?;
+ assert_eq!(ast.to_string(), expected);
+ }
+ Ok(())
+ }
+
#[test]
fn test_cast_value_to_dict_expr() {
let tests = [(