omni

module

v0.0.0-...-768cf3d Latest Latest Go to latest Published: Apr 1, 2026 License: MIT

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/bytebase/omni

Links

Open Source Insights

README ¶

Omni

SQL toolchain for multiple database engines. Each engine provides a parser, AST, and additional components such as catalog simulation and semantic analysis -- all in pure Go with zero dependencies.

Features

Zero dependencies -- pure Go, no CGo, no generated code at runtime
Full AST -- every parsed statement produces a complete abstract syntax tree
Position tracking -- every AST node carries byte-offset location info
Beyond parsing -- catalog simulation, DDL semantic analysis, and more per engine

Status

Engine	Parser	Catalog	Completion
PostgreSQL	✅	✅	Planned
MySQL	🚧	Planned	Planned
SQL Server	🚧	Planned	Planned
Oracle	🚧	Planned	Planned

Quick Start

go get github.com/bytebase/omni

PostgreSQL

package main

import (
    "fmt"
    "github.com/bytebase/omni/pg"
    "github.com/bytebase/omni/pg/ast"
)

func main() {
    stmts, err := pg.Parse("SELECT 1; CREATE TABLE t (id int);")
    if err != nil {
        panic(err)
    }
    for _, s := range stmts {
        fmt.Printf("%-20T  %s\n", s.AST, s.Text)
    }
    // *ast.SelectStmt       SELECT 1;
    // *ast.CreateStmt        CREATE TABLE t (id int);
}

Architecture

omni/
├── pg/                     PostgreSQL
│   ├── parse.go            Public API: Parse(sql) → []Statement
│   ├── ast/                210+ AST node types
│   ├── parser/             Recursive descent parser (~29K lines)
│   ├── catalog/            In-memory catalog simulation & DDL analysis
│   ├── parsertest/         746 test cases
│   └── pgregress/          PostgreSQL regression test compatibility
├── mysql/                  MySQL
│   ├── ast/                AST node types
│   ├── parser/             Recursive descent parser
│   └── parsertest/         Test cases
├── mssql/                  SQL Server (T-SQL)
│   ├── ast/                AST node types
│   ├── parser/             Recursive descent parser
│   └── parsertest/         Test cases
├── oracle/                 Oracle
│   ├── ast/                AST node types
│   └── parser/             Recursive descent parser
└── scripts/                Shared build & audit tooling

Development

# Run all tests
make test

# Test a specific engine
make test-pg
make test-mysql
make test-mssql
make test-oracle

# Build everything
make build

License

MIT -- see LICENSE.

Directories ¶

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL

Path	Synopsis
cosmosdb Package cosmosdb provides a parser for Azure Cosmos DB NoSQL SQL API queries.	Package cosmosdb provides a parser for Azure Cosmos DB NoSQL SQL API queries.
analysis Package analysis extracts field-level information from parsed CosmosDB queries.	Package analysis extracts field-level information from parsed CosmosDB queries.
ast Package ast defines parse tree node types for Azure Cosmos DB NoSQL SQL API.	Package ast defines parse tree node types for Azure Cosmos DB NoSQL SQL API.
parser Package parser implements a hand-written parser for Azure Cosmos DB NoSQL SQL API.	Package parser implements a hand-written parser for Azure Cosmos DB NoSQL SQL API.
mongo Package mongo provides a parser for MongoDB shell (mongosh) commands.	Package mongo provides a parser for MongoDB shell (mongosh) commands.
ast Package ast defines MongoDB (mongosh) parse tree node types.	Package ast defines MongoDB (mongosh) parse tree node types.
parser
mssql
ast Package ast defines T-SQL parse tree node types.	Package ast defines T-SQL parse tree node types.
completion Package completion provides parser-native C3-style SQL completion for MSSQL.	Package completion provides parser-native C3-style SQL completion for MSSQL.
parser Package parser - alter_objects.go implements T-SQL ALTER DATABASE and ALTER INDEX parsing.	Package parser - alter_objects.go implements T-SQL ALTER DATABASE and ALTER INDEX parsing.
mysql
ast Package ast defines MySQL parse tree node types.	Package ast defines MySQL parse tree node types.
catalog
completion Package completion provides parser-native C3-style SQL completion for MySQL.	Package completion provides parser-native C3-style SQL completion for MySQL.
deparse Package deparse converts MySQL AST nodes back to SQL text, matching MySQL 8.0's SHOW CREATE VIEW formatting.	Package deparse converts MySQL AST nodes back to SQL text, matching MySQL 8.0's SHOW CREATE VIEW formatting.
parser Package parser implements a recursive descent SQL parser for MySQL.	Package parser implements a recursive descent SQL parser for MySQL.
oracle
ast Package ast defines Oracle PL/SQL parse tree node types.	Package ast defines Oracle PL/SQL parse tree node types.
parser Package parser implements an Oracle PL/SQL lexer and recursive descent parser.	Package parser implements an Oracle PL/SQL lexer and recursive descent parser.
pg
ast Package nodes defines PostgreSQL parse tree node types.	Package nodes defines PostgreSQL parse tree node types.
ast/cmd/genwalker command Command genwalker generates walk_generated.go from parsenodes.go.	Command genwalker generates walk_generated.go from parsenodes.go.
catalog
completion Package completion provides parser-native C3-style SQL completion for PostgreSQL.	Package completion provides parser-native C3-style SQL completion for PostgreSQL.
parser Package parser implements a PostgreSQL-compatible SQL lexer and parser.	Package parser implements a PostgreSQL-compatible SQL lexer and parser.
pgregress Package pgregress provides tools for running PostgreSQL regression test SQL files against the pgparser parser to verify parse compatibility.	Package pgregress provides tools for running PostgreSQL regression test SQL files against the pgparser parser to verify parse compatibility.
plpgsql/ast Package ast defines PL/pgSQL AST node types.	Package ast defines PL/pgSQL AST node types.
plpgsql/parser Package parser implements a recursive descent PL/pgSQL parser.	Package parser implements a recursive descent PL/pgSQL parser.
scripts Dashboard serves a web-based monitoring UI for all parser engine pipelines.	Dashboard serves a web-based monitoring UI for all parser engine pipelines.