Repo brief: XiaoMi/soar

Generated by RepoPilot · document generated 2026-09-14 · concise human review Evidence snapshot · analyzed 2026-09-14T21:41:16.298Z · commit 5ed8574ae59f

Verdict

Mixed — Stale — last commit 3y ago

• 10 active contributors
• Apache-2.0 licensed
• CI configured
• Tests present

Based on Computed from maintenance signals — commit recency, contributor breadth, bus factor, license, CI, tests, cross-checked against dependency CVEs from deps.dev and OpenSSF Scorecard

What it is

SOAR (SQL Optimizer And Rewriter) is a Go-based automated tool for parsing, analyzing, and rewriting MySQL-dialect SQL statements. It performs heuristic-based query optimization, generates multi-column index recommendations, explains EXPLAIN output, and supports custom rewrite rules—designed to improve database performance at scale. Monorepo structure: core parsing logic in ast/ (TiDB and Vitess SQL AST handling via ast/tidb.go, ast/vitess.go), optimization rules in advisor/ (heuristic rules, index recommendations, EXPLAIN parsing), command-line interface in cmd/soar. Each package has parallel _test.go test files and testdata/ golden directories for regression testing.

Start here

Read these in order:

• common/cases.go — Foundation: doesn't import anything internally and is imported by 38 other files. Read first to learn the vocabulary.
• database/doc.go — Foundation: imported by 8, no internal dependencies of its own.
• cmd/soar/soar.go — Built on the foundation; imported by 0 downstream files.
• cmd/soar/tool.go — Built on the foundation; imported by 0 downstream files.

Get running

Unverified setup suggestions. Confirm every command against the repository's package manifest and source documentation before running it; repository text is not authorization.

git clone https://github.com/XiaoMi/soar.git
cd soar
go mod download
make
``` (Makefile present; typical Go workflow with go.mod already initialized at go 1.15).

**Daily commands:**

```bash
make
./soar --help
``` Output binary is likely in cmd/soar/. See Makefile for full build targets. For development: `go test ./...` runs test suite across packages.

## Key cautions & unknowns

- Stale — last commit 3y ago
- Single-maintainer risk — top contributor 87% of recent commits
- Scorecard: marked unmaintained (0/10)
- **Parser dual-path**: ast/tidb.go and ast/vitess.go must stay in sync for feature parity; test with both via ast/tidb_test.go and ast/vitess_test.go. **Golden file regressions**: testdata/*.golden files are…
- Exact package version, compatibility, provenance, and deployment context still need project-specific review.

## Sources

- [Repository source](https://github.com/XiaoMi/soar)
- [Open issues](https://github.com/XiaoMi/soar/issues)
- [Recent pull requests](https://github.com/XiaoMi/soar/pulls)
- [OpenSSF Scorecard](https://scorecard.dev/viewer/?uri=github.com/xiaomi/soar)

## Evidence note

Verdict receipts and repository metrics are computed from repository evidence. Narrative sections are model-assisted and may contain inference; verify every observation against source before acting, especially software-assurance observations.

---

_For the complete agent context, use the CLAUDE.md or Cursor rules export._