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

ClickHouse SQL Parser writing in Go
https://github.com/AfterShip/clickhouse-sql-parser

clickhouse go sql-parser

Last synced: about 2 months ago
JSON representation

ClickHouse SQL Parser writing in Go

• Host: GitHub
• URL: https://github.com/AfterShip/clickhouse-sql-parser
• Owner: AfterShip
• License: mit
• Created: 2023-09-22T02:56:16.000Z (about 1 year ago)
• Default Branch: master
• Last Pushed: 2024-10-09T11:11:06.000Z (2 months ago)
• Last Synced: 2024-10-14T22:34:32.448Z (about 2 months ago)
• Topics: clickhouse, go, sql-parser
• Language: Go
• Homepage:
• Size: 630 KB
• Stars: 128
• Watchers: 5
• Forks: 16
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-clickhouse - AfterShip/clickhouse-sql-parser - A Go library and CLI tool for parsing ClickHouse SQL into an Abstract Syntax Tree (AST) and beautifying SQL format. (Language bindings / Golang)

README

        
# ClickHouse SQL Parser 

![GitHub CI](https://github.com/AfterShip/clickhouse-sql-parser/actions/workflows/ci.yaml/badge.svg) [![Go Report Card](https://goreportcard.com/badge/github.com/AfterShip/clickhouse-sql-parser)](https://goreportcard.com/report/github.com/AfterShip/clickhouse-sql-parser) [![LICENSE](https://img.shields.io/github/license/AfterShip/clickhouse-sql-parser.svg)](https://github.com/AfterShip/clickhouse-sql-parser/blob/master/LICENSE) [![GoDoc](https://img.shields.io/badge/Godoc-reference-blue.svg)](https://godoc.org/github.com/AfterShip/clickhouse-sql-parser) [![Coverage Status](https://coveralls.io/repos/github/AfterShip/clickhouse-sql-parser/badge.svg?branch=master)](https://coveralls.io/github/AfterShip/clickhouse-sql-parser?branch=master) 

The goal of this project is to build a ClickHouse SQL parser in Go with the following key features:

- Parse ClickHouse SQL into AST

- Beautify ClickHouse SQL format

This project is inspired by [memefish](https://github.com/cloudspannerecosystem/memefish) which is a SQL parser for Spanner in Go.

## How to use

You can use it as your Go library or CLI tool, see the following examples:

- Use clickhouse-sql-parser as a Go library

```Go

package main

import (

    clickhouse "github.com/AfterShip/clickhouse-sql-parser/parser"

)

query := "SELECT * FROM clickhouse"

parser := clickhouse.NewParser(query)

// Parse query into AST

statements, err := parser.ParseStmts()

if err != nil {

    return nil, err

}

```

- Use clickhouse-sql-parser as a CLI tool

```bash

$ go install github.com/AfterShip/clickhouse-sql-parser@latest

## Parse query into AST

$ clickhouse-sql-parser "SELECT * FROM clickhouse WHERE a=100"

## Beautify query

$ clickhouse-sql-parser -format "SELECT * FROM clickhouse WHERE a=100"

## Parse query from file

$ clickhouse-sql-parser -file ./test.sql

```

- Parsed tree(AST) back into a SQL statement

```Go

parser := clickhouse.NewParser("SELECT * FROM clickhouse")

// Parse query into AST

statements, err := parser.ParseStmts()

if err != nil {

    return nil, err

}

// Call the String method to unparsed AST into a SQL string

for _, stmt := range statements {

  fmt.Println(stmt.String())

}

```

## Update test assets

For the files inside `output` and `format` dir are generated by the test cases,

if you want to update them, you can run the following command:

```bash

$ make update_test

```

## Contact us

Feel free to open an issue or discussion if you have any issues or questions.