Hacktoberfest 2026: những issue maintainer đã đánh dấu cho tháng Mười, đang mở và phù hợp người mới. Xem issue Hacktoberfest

ClickHouse: `Display` implementation converts types to uppercase, causing `UNKNOWN_TYPE` errors

Đang mở
  • Có gì không ổn?
#2,153 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

Maintainer thường phản hồi trong vòng 2 ngày

Chưa có ai nhận issue này.

Đánh giá

Độ khó
5/5
Thời gian dự kiến
Hơn một tuần
Mức phù hợp với người mới
35/100
Loại issue
Lỗi
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Đình trệ
Công nghệ
clickhouse, rust
Lĩnh vực
databases

Hướng nghiên cứu

Bắt đầu bằng cách kiểm tra triển khai DataType Display và các kiểu AST được liệt kê trong issue, bao gồm Statement, Query, Expr, ColumnDef và các node liên quan. Theo dõi cách quá trình serialization tiếp cận các kiểu dữ liệu lồng nhau, sau đó đánh giá API to_sql có nhận biết dialect được đề xuất trên toàn bộ hierarchy. Công việc được xem là hoàn tất khi ví dụ ClickHouse round-trip với các kiểu PascalCase và hành vi Display hiện có vẫn tương thích ngược.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

Problem

ClickHouse data types are case-sensitive and require PascalCase (e.g., String, Int32, Nullable). However, the sqlparser-rs library's Display implementation for DataType converts certain types to uppercase, causing UNKNOWN_TYPE errors when round-tripping SQL through ClickHouse.

Example

use sqlparser::dialect::ClickHouseDialect;
use sqlparser::parser::Parser;

let sql = "CREATE TABLE t (col Nullable(String))";
let dialect = ClickHouseDialect {};
let ast = Parser::parse_sql(&dialect, sql).unwrap();

// Round-trip: parse and convert back to string
let regenerated = ast[0].to_string();
// Result: "CREATE TABLE t (col Nullable(STRING))"
//                                       ^^^^^^ uppercase!

When this regenerated SQL is executed against ClickHouse, it fails with:

Code: 47. DB::Exception: Unknown type STRING. (UNKNOWN_TYPE)

Affected Types

Type Current Output ClickHouse Requires
DataType::Int8 INT8 Int8
DataType::Int64 INT64 Int64
DataType::Float64 FLOAT64 Float64
DataType::String STRING String
DataType::Bool BOOL Bool
DataType::Date DATE Date
DataType::Datetime DATETIME DateTime

Types already correct (PascalCase):

  • Int16, Int32, Int128, Int256
  • UInt8, UInt16, UInt32, UInt64, UInt128, UInt256
  • Float32
  • Nullable, LowCardinality, Array, Map, Tuple, Nested

Root Cause

The Display trait implementation for DataType uses uppercase for type names (e.g., write!(f, "STRING")), which is standard for most SQL dialects but incorrect for ClickHouse.

The challenge is that Display doesn't have access to dialect context, so it can't conditionally format based on the active dialect.

The Problem with Display

Most users serialize SQL by calling Display on top-level AST types:

let ast = Parser::parse_sql(&dialect, sql).unwrap();
let regenerated = ast[0].to_string();  // Uses Display on Statement
// or
let regenerated = format!("{}", query);  // Uses Display on Query

The Display trait signature doesn't allow passing context:

fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result

Proposed Solution

To solve this, we need dialect-aware serialization throughout the AST hierarchy:

Add to_sql(&dyn Dialect) to all AST types

  • Add to_sql(&dyn Dialect) -> String method to Statement, Query, Expr, ColumnDef, and other AST types
  • Each type's implementation calls to_sql() on its children, propagating the dialect
  • Keep existing Display implementations unchanged for backwards compatibility
// Example usage after fix:
let ast = Parser::parse_sql(&dialect, sql).unwrap();
let regenerated = ast[0].to_sql(&dialect);  // Correct PascalCase for ClickHouse
Implementation Scope

The affected types include (non-exhaustive):

  • Statement (top-level)
  • Query, SetExpr, Select
  • Expr (especially Cast, TryCast, SafeCast)
  • ColumnDef, ColumnOption
  • TableConstraint
  • AlterTableOperation
  • FunctionArg, FunctionArgExpr

This is a significant change but provides the cleanest API and maintains backwards compatibility.

Workarounds

Currently, users must post-process the SQL string output to fix casing. See 514-labs/moosestack#3152 for an example regex-based workaround.

References

Ngôn ngữ chính
Rust
Star
3.5k
Fork
780
Merge trung bình
4 ngày 10 giờ
Pull request đã merge (30 ngày)
60

Chuẩn bị môi trường

  • Không có Dockerfile hay tệp Docker Compose
  • Có mẫu pull request
  • Không có hướng dẫn đóng góp

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của apache/datafusion-sqlparser-rs

Tất cả issue của apache/datafusion-sqlparser-rs

Issue tương tự

Thêm issue về Rust

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.