# bytebase/omni architecture

> Architecture diagram of the GitHub repository bytebase/omni, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-10-04). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/bytebase/omni
- Repository: https://github.com/bytebase/omni

## Overview

Omni is a pure-Go toolkit for parsing SQL and database query languages across multiple engines, producing location-aware ASTs and, depending on the engine, offering analysis, catalog simulation, completion, validation, or deparsing. The principal workflow is client SQL or query text → an engine parser → an AST; optional engine-specific layers then analyze query structure or model schema changes. The README documents this common package shape and capabilities. Source excerpts show several analysis implementations, but not every engine’s entry-point wiring, so those links are omitted where the evidence is insufficient.

Main entry points: [`redshift/parser/database.go`](https://github.com/bytebase/omni/blob/main/redshift/parser/database.go) (Redshift parser), [`pg/parser/database.go`](https://github.com/bytebase/omni/blob/main/pg/parser/database.go) (PostgreSQL parser), [`doris/parser/storage.go`](https://github.com/bytebase/omni/blob/main/doris/parser/storage.go) (Doris parser), [`starrocks/parser/storage.go`](https://github.com/bytebase/omni/blob/main/starrocks/parser/storage.go) (StarRocks parser)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_sql["SQL engines"]
  node_pgparse["PostgreSQL parser<br/>[database.go]"]
  node_pgast["PostgreSQL AST<br/>[parsenodes.go]"]
  node_mariadb["MariaDB parser"]
  node_mysql["MySQL parser<br/>[create_database.go]"]
  node_redparse["Redshift parser<br/>[database.go]"]
  node_redast["Redshift AST<br/>[parsenodes.go]"]
  node_mssql["T-SQL parser<br/>[server.go]"]
  node_oracle["Oracle parser<br/>[database.go]"]
  node_doris["Doris parser<br/>[storage.go]"]
  node_starrocks["StarRocks parser<br/>[storage.go]"]
  node_googlesql["GoogleSQL parser<br/>[graph_query.go]"]
end

subgraph group_special["Specialized engines"]
  node_mongo["MongoDB parser"]
  node_es["Elasticsearch parser<br/>[parser.go]"]
  node_cosmos["Cosmos DB parser"]
  node_cassandra["Cassandra parser"]
end

subgraph group_analysis["Query analysis"]
  node_dorisanalysis["Doris query spans<br/>[query_span.go]"]
  node_staranalysis["StarRocks query spans<br/>[query_span.go]"]
  node_googleanalysis["GoogleSQL query spans<br/>[query_span.go]"]
  node_redanalysis["Redshift query spans<br/>[query_span.go]"]
  node_trinoanalysis["Trino query spans<br/>[query_span.go]"]
  node_snowanalysis["Snowflake query spans<br/>[query_span.go]"]
  node_mongoanalysis["Pipeline analysis<br/>[pipeline.go]"]
end

subgraph group_schema["Schema tooling"]
  node_pgcatalog[("PostgreSQL catalog<br/>[query.go]")]
  node_mysqlcatalog[("MySQL catalog<br/>[query.go]")]
  node_mariacatalog[("MariaDB catalog<br/>[query.go]")]
  node_trino_catalog[("Trino catalog")]
end

node_client(("SQL client"))

node_client -->|"submits SQL"| node_pgparse
node_pgparse -->|"builds AST"| node_pgast
node_client -->|"submits SQL"| node_mariadb
node_client -->|"submits SQL"| node_mysql
node_client -->|"submits SQL"| node_redparse
node_redparse -->|"builds AST"| node_redast
node_client -->|"submits SQL"| node_mssql
node_client -->|"submits SQL"| node_oracle
node_client -->|"submits SQL"| node_doris
node_client -->|"submits SQL"| node_starrocks
node_client -->|"submits SQL"| node_googlesql
node_client -->|"submits query"| node_mongo
node_client -->|"submits request"| node_es
node_client -->|"submits query"| node_cosmos
node_client -->|"submits CQL"| node_cassandra
node_doris -.->|"analyzes AST"| node_dorisanalysis
node_starrocks -.->|"analyzes AST"| node_staranalysis
node_googlesql -.->|"analyzes AST"| node_googleanalysis
node_redparse -.->|"analyzes query"| node_redanalysis
node_client -.->|"requests spans"| node_trinoanalysis
node_client -.->|"requests spans"| node_snowanalysis
node_mongo -->|"analyzes pipeline"| node_mongoanalysis
node_client -.->|"uses schema tools"| node_pgcatalog
node_client -.->|"uses schema tools"| node_mysqlcatalog
node_client -.->|"uses schema tools"| node_mariacatalog
node_client -.->|"uses schema tools"| node_trino_catalog

click node_pgparse "https://github.com/bytebase/omni/blob/main/pg/parser/database.go"
click node_pgast "https://github.com/bytebase/omni/blob/main/pg/ast/parsenodes.go"
click node_mariadb "https://github.com/bytebase/omni/tree/main/mariadb/parser"
click node_mysql "https://github.com/bytebase/omni/blob/main/mysql/parser/create_database.go"
click node_redparse "https://github.com/bytebase/omni/blob/main/redshift/parser/database.go"
click node_redast "https://github.com/bytebase/omni/blob/main/redshift/ast/parsenodes.go"
click node_mssql "https://github.com/bytebase/omni/blob/main/mssql/parser/server.go"
click node_oracle "https://github.com/bytebase/omni/blob/main/oracle/parser/database.go"
click node_doris "https://github.com/bytebase/omni/blob/main/doris/parser/storage.go"
click node_starrocks "https://github.com/bytebase/omni/blob/main/starrocks/parser/storage.go"
click node_googlesql "https://github.com/bytebase/omni/blob/main/googlesql/parser/graph_query.go"
click node_dorisanalysis "https://github.com/bytebase/omni/blob/main/doris/analysis/query_span.go"
click node_staranalysis "https://github.com/bytebase/omni/blob/main/starrocks/analysis/query_span.go"
click node_googleanalysis "https://github.com/bytebase/omni/blob/main/googlesql/analysis/query_span.go"
click node_redanalysis "https://github.com/bytebase/omni/blob/main/redshift/analysis/query_span.go"
click node_trinoanalysis "https://github.com/bytebase/omni/blob/main/trino/analysis/query_span.go"
click node_snowanalysis "https://github.com/bytebase/omni/blob/main/snowflake/analysis/query_span.go"
click node_mongo "https://github.com/bytebase/omni/tree/main/mongo/parser"
click node_mongoanalysis "https://github.com/bytebase/omni/blob/main/mongo/analysis/pipeline.go"
click node_es "https://github.com/bytebase/omni/blob/main/elasticsearch/parser/parser.go"
click node_cosmos "https://github.com/bytebase/omni/tree/main/cosmosdb/parser"
click node_cassandra "https://github.com/bytebase/omni/tree/main/cassandra/parser"
click node_pgcatalog "https://github.com/bytebase/omni/blob/main/pg/catalog/query.go"
click node_mysqlcatalog "https://github.com/bytebase/omni/blob/main/mysql/catalog/query.go"
click node_mariacatalog "https://github.com/bytebase/omni/blob/main/mariadb/catalog/query.go"
click node_trino_catalog "https://github.com/bytebase/omni/tree/main/trino/catalog"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_pgparse,node_pgast,node_mariadb,node_mysql,node_redparse,node_redast,node_mssql,node_oracle,node_doris,node_starrocks,node_googlesql,node_client toneBlue
class node_mongo,node_es,node_cosmos,node_cassandra toneAmber
class node_dorisanalysis,node_staranalysis,node_googleanalysis,node_redanalysis,node_trinoanalysis,node_snowanalysis,node_mongoanalysis toneMint
class node_pgcatalog,node_mysqlcatalog,node_mariacatalog,node_trino_catalog toneRose
```

## Components

### SQL engines

- [PostgreSQL parser](https://github.com/bytebase/omni/blob/main/pg/parser/database.go): `pg/parser/database.go`
- [PostgreSQL AST](https://github.com/bytebase/omni/blob/main/pg/ast/parsenodes.go): `pg/ast/parsenodes.go`
- [MariaDB parser](https://github.com/bytebase/omni/tree/main/mariadb/parser): `mariadb/parser`
- [MySQL parser](https://github.com/bytebase/omni/blob/main/mysql/parser/create_database.go): `mysql/parser/create_database.go`
- [Redshift parser](https://github.com/bytebase/omni/blob/main/redshift/parser/database.go): `redshift/parser/database.go`
- [Redshift AST](https://github.com/bytebase/omni/blob/main/redshift/ast/parsenodes.go): `redshift/ast/parsenodes.go`
- [T-SQL parser](https://github.com/bytebase/omni/blob/main/mssql/parser/server.go): `mssql/parser/server.go`
- [Oracle parser](https://github.com/bytebase/omni/blob/main/oracle/parser/database.go): `oracle/parser/database.go`
- [Doris parser](https://github.com/bytebase/omni/blob/main/doris/parser/storage.go): `doris/parser/storage.go`
- [StarRocks parser](https://github.com/bytebase/omni/blob/main/starrocks/parser/storage.go): `starrocks/parser/storage.go`
- [GoogleSQL parser](https://github.com/bytebase/omni/blob/main/googlesql/parser/graph_query.go): `googlesql/parser/graph_query.go`

### Specialized engines

- [MongoDB parser](https://github.com/bytebase/omni/tree/main/mongo/parser): `mongo/parser`
- [Elasticsearch parser](https://github.com/bytebase/omni/blob/main/elasticsearch/parser/parser.go): `elasticsearch/parser/parser.go`
- [Cosmos DB parser](https://github.com/bytebase/omni/tree/main/cosmosdb/parser): `cosmosdb/parser`
- [Cassandra parser](https://github.com/bytebase/omni/tree/main/cassandra/parser): `cassandra/parser`

### Query analysis

- [Doris query spans](https://github.com/bytebase/omni/blob/main/doris/analysis/query_span.go): `doris/analysis/query_span.go`
- [StarRocks query spans](https://github.com/bytebase/omni/blob/main/starrocks/analysis/query_span.go): `starrocks/analysis/query_span.go`
- [GoogleSQL query spans](https://github.com/bytebase/omni/blob/main/googlesql/analysis/query_span.go): `googlesql/analysis/query_span.go`
- [Redshift query spans](https://github.com/bytebase/omni/blob/main/redshift/analysis/query_span.go): `redshift/analysis/query_span.go`
- [Trino query spans](https://github.com/bytebase/omni/blob/main/trino/analysis/query_span.go): `trino/analysis/query_span.go`
- [Snowflake query spans](https://github.com/bytebase/omni/blob/main/snowflake/analysis/query_span.go): `snowflake/analysis/query_span.go`
- [Pipeline analysis](https://github.com/bytebase/omni/blob/main/mongo/analysis/pipeline.go): `mongo/analysis/pipeline.go`

### Schema tooling

- [PostgreSQL catalog](https://github.com/bytebase/omni/blob/main/pg/catalog/query.go): `pg/catalog/query.go`
- [MySQL catalog](https://github.com/bytebase/omni/blob/main/mysql/catalog/query.go): `mysql/catalog/query.go`
- [MariaDB catalog](https://github.com/bytebase/omni/blob/main/mariadb/catalog/query.go): `mariadb/catalog/query.go`
- [Trino catalog](https://github.com/bytebase/omni/tree/main/trino/catalog): `trino/catalog`

### Other components

- **SQL client**

## Connections

- SQL client → PostgreSQL parser: submits SQL (evidence: `README.md`)
- PostgreSQL parser → PostgreSQL AST: builds AST (evidence: `README.md`)
- SQL client → MariaDB parser: submits SQL (evidence: `README.md`)
- SQL client → MySQL parser: submits SQL (evidence: `README.md`)
- SQL client → Redshift parser: submits SQL (evidence: `README.md`)
- Redshift parser → Redshift AST: builds AST (evidence: `README.md`)
- SQL client → T-SQL parser: submits SQL (evidence: `README.md`)
- SQL client → Oracle parser: submits SQL (evidence: `README.md`)
- SQL client → Doris parser: submits SQL (evidence: `README.md`)
- SQL client → StarRocks parser: submits SQL (evidence: `README.md`)
- SQL client → GoogleSQL parser: submits SQL (evidence: `README.md`)
- SQL client → MongoDB parser: submits query (evidence: `README.md`)
- SQL client → Elasticsearch parser: submits request (evidence: `README.md`)
- SQL client → Cosmos DB parser: submits query (evidence: `README.md`)
- SQL client → Cassandra parser: submits CQL (evidence: `README.md`)
- Doris parser → Doris query spans: analyzes AST
- StarRocks parser → StarRocks query spans: analyzes AST
- GoogleSQL parser → GoogleSQL query spans: analyzes AST
- Redshift parser → Redshift query spans: analyzes query
- SQL client → Trino query spans: requests spans
- SQL client → Snowflake query spans: requests spans
- MongoDB parser → Pipeline analysis: analyzes pipeline (evidence: `mongo/analysis/pipeline.go`)
- SQL client → PostgreSQL catalog: uses schema tools
- SQL client → MySQL catalog: uses schema tools
- SQL client → MariaDB catalog: uses schema tools
- SQL client → Trino catalog: uses schema tools
