Awesome ClickHouse › Other sdk/libraries

AfterShip/clickhouse-sql-parser

⭐ 251 Go repository created 2023-09-22

The AfterShip/clickhouse-sql-parser project is a Go-based SQL parser specifically designed for ClickHouse, a popular columnar database management system. The primary goal of this project is to parse ClickHouse SQL queries into an Abstract Syntax Tree (AST) and to provide functionality for beautifying the SQL format. This makes it easier for developers and database administrators to analyze, manipulate, and format ClickHouse SQL queries programmatically. Inspired by the memefish project, which is a SQL parser for Google Spanner, this parser offers both a Go library and a command-line interface (CLI) tool. Users can integrate the parser into their Go applications to parse SQL queries into ASTs, enabling advanced query analysis and transformation. The CLI tool allows users to parse SQL queries directly from the command line, beautify SQL statements for improved readability, and parse queries from files. The project includes comprehensive documentation and examples demonstrating how to use the parser both as a library and a CLI tool. It supports parsing SQL statements into ASTs and converting the AST back into SQL strings, facilitating round-trip query processing. The repository also contains benchmarks that measure the parser's performance across various SQL query types, highlighting its efficiency and low memory allocation. Additional features include automated testing with coverage reports and the ability to update test assets easily. The project is actively maintained with continuous integration workflows to ensure code quality and reliability. It is licensed under an open-source license, making it accessible for community use and contributions. Overall, AfterShip/clickhouse-sql-parser is a specialized tool aimed at developers working with ClickHouse who need robust SQL parsing and formatting capabilities within Go environments or via CLI, enhancing productivity and query management.

https://github.com/AfterShip/clickhouse-sql-parser

astbenchmarkingcli-toolclickhousegomemefishopen-sourcequery-parsingsql-beautifysql-parser