Skip to content

Add clickhouse-sql-parser to Database Tools section - #6654

Merged
github-actions[bot] merged 1 commit into
avelino:mainfrom
git-hulk:add-clickhouse-sql-parser
Sep 2, 2026
Merged

Add clickhouse-sql-parser to Database Tools section#6654
github-actions[bot] merged 1 commit into
avelino:mainfrom
git-hulk:add-clickhouse-sql-parser

Conversation

@git-hulk

@git-hulk git-hulk commented Sep 2, 2026

Copy link
Copy Markdown
Contributor

Required links

Coverage: https://coveralls.io/github/AfterShip/clickhouse-sql-parser?branch=master

Pre-submission checklist

Repository requirements

  • The repo has a go.mod file and at least one SemVer release (vX.Y.Z) — latest is v0.5.6.
  • The repo has an open source license — MIT.
  • The repo documentation has a pkg.go.dev link.
  • The repo documentation has a goreportcard link (grade A- or better).
  • The repo documentation has a coverage service link.
  • The repo has a continuous integration process (GitHub Actions).
  • CI runs tests that must pass before merging.

Pull Request content

  • This PR adds only one package.
  • The package has been added in alphabetical order — Database Tools, between clickhouse-bulk and database-gateway.
  • The link text is the exact project name.
  • The description is clear, concise, non-promotional, and ends with a period.
  • The link in README.md matches the forge link above.

Category quality

  • The packages around my addition still meet the Quality Standards.

About the package

clickhouse-sql-parser is a Go library and CLI that parses ClickHouse-dialect SQL
into a typed AST and formats it back, used for query linting, static analysis,
rewriting and access-control enforcement. First commit September 2023, SemVer
release roughly every two weeks, MIT licensed. It is used in production by
SigNoz, Unkey,
Akvorado,
Trickster and
Substreams, among others.

Two of the required links deserve a note, in the interest of being upfront:

  • Go Report Card has been retired, so the report page no longer returns a grade
    for any repository. The link is included because the template asks for it. The
    project is gofmt/goimports clean and runs golangci-lint in CI on every PR.
  • Coverage is currently 56% overall — 58.6% for the parser package, which is
    the library itself; main.go is a thin CLI wrapper and is untested. That is below
    the 80% guideline. The grammar is exercised by a golden-file suite of ~800 SQL
    fixtures that round-trip each statement through parse → AST JSON → formatted SQL,
    so the parsing surface is well covered in practice, but I would rather state the
    number than have it turn up in review. Happy to raise it if that is a condition
    for merging.

clickhouse-sql-parser is a Go library and CLI that parses
ClickHouse-dialect SQL into a typed AST, with walk/transform helpers,
round-trip formatting and beautification.

Assistant By Claude Opus 5
@github-actions

github-actions Bot commented Sep 2, 2026

Copy link
Copy Markdown

Automated Quality Checks

Required checks

Repo: accessible, has go.mod and SemVer release
pkg.go.dev: OK
Go Report Card: OK (grade unknown)

Additional checks

License: MIT
Maturity: repo has 5+ months of history
CI/CD: GitHub Actions workflows detected
README: present
⚠️ Coverage: unreachable

How to fix: The coverage link could not be reached.
Ensure the coverage service is configured for your repository and the link is correct. If you just set it up, it may need a CI run to generate the first report.

These checks are automated and do not replace maintainer review. See CONTRIBUTING.md for full guidelines.


PR Diff Validation

Content checks

Files changed: only README.md
Single item: one package added
Link consistency: README link matches forge link in PR body
Link text: matches repository name
Description: ends with punctuation
Description tone: no promotional language detected
Category size: Database Tools has 27 items

Automated diff validation — does not replace maintainer review.

@github-actions
github-actions Bot merged commit 44694a8 into avelino:main Sep 2, 2026
7 of 8 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant