# czxieddan/rnovmodulardb architecture

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

- Interactive diagram: https://gitdiagram.com/czxieddan/rnovmodulardb
- Repository: https://github.com/czxieddan/rnovmodulardb

## Overview

RNovModularDB is a modular Rust database for embedded and edge workloads. Its principal workflow accepts SQL through a local session or TCP line protocol, parses and binds it, plans and executes it, and maintains database state in memory or encrypted single-file storage. Separate capabilities cover transactions, indexing and full-text search, authorization and row/column protection, Wasm scalar UDFs, and file inspection, backup, restore, upgrade, and key rotation. The README documents these product surfaces; many internal crate-to-crate calls are not shown in the excerpts, so those links are marked unverified.

Main entry points: [`crates/rnmdb-executor/src/memory.rs`](https://github.com/czxieddan/rnovmodulardb/blob/master/crates/rnmdb-executor/src/memory.rs) (Memory executor), [`crates/rnmdb-cli/src/lib.rs`](https://github.com/czxieddan/rnovmodulardb/blob/master/crates/rnmdb-cli/src/lib.rs) (Local session / CLI), [`crates/rnmdb-planner/src/logical.rs`](https://github.com/czxieddan/rnovmodulardb/blob/master/crates/rnmdb-planner/src/logical.rs) (Logical planning), [`crates/rnmdb-sql/src/binder.rs`](https://github.com/czxieddan/rnovmodulardb/blob/master/crates/rnmdb-sql/src/binder.rs) (Binder)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_interfaces["Interfaces"]
  node_local["Local session / CLI<br/>[lib.rs]"]
  node_tcp["TCP SQL protocol<br/>[sql_protocol.rs]"]
  node_output["CLI output<br/>[output.rs]"]
end

subgraph group_sql["SQL Engine"]
  node_lexer["SQL lexer<br/>[lexer.rs]"]
  node_parser["SQL parser / AST<br/>[parser.rs]"]
  node_ast["SQL AST<br/>[ast.rs]"]
  node_binder["Binder<br/>[binder.rs]"]
  node_planner["Logical planning<br/>[logical.rs]"]
  node_cost["Plan costing<br/>[cost.rs]"]
  node_optimizer["Plan optimization<br/>[optimizer.rs]"]
  node_executor["Memory executor<br/>[memory.rs]"]
  node_sort["Sorting<br/>[sort.rs]"]
  node_setops["Set operations<br/>[set_ops.rs]"]
  node_vectors["Vector batches<br/>[vector.rs]"]
end

subgraph group_state["State and Storage"]
  node_catalog[("Catalog<br/>[lib.rs]")]
  node_transactions["Transactions<br/>[lib.rs]"]
  node_storage[("Encrypted storage<br/>[lib.rs]")]
  node_upgrade["Legacy upgrade<br/>[legacy.rs]"]
  node_rekey["Page-key rotation"]
end

subgraph group_features["Query Features"]
  node_index[("Indexes<br/>[lib.rs]")]
  node_fts["Full-text search<br/>[lib.rs]"]
end

subgraph group_trust["Security and Extensions"]
  node_security["Authorization / policies<br/>[lib.rs]"]
  node_columncrypto["Column encryption<br/>[column_crypto.rs]"]
  node_udf["Wasm UDF runtime<br/>[wasm_runtime.rs]"]
  node_instance["Instance isolation<br/>[lib.rs]"]
end

node_user(("Application / operator"))

node_user -->|"submits SQL"| node_local
node_user -->|"sends SQL"| node_tcp
node_local -.->|"accepts SQL"| node_lexer
node_tcp -.->|"routes SQL"| node_parser
node_lexer -.->|"tokenizes for"| node_parser
node_parser -.->|"builds AST"| node_ast
node_ast -.->|"binds statements"| node_binder
node_binder -.->|"resolves metadata"| node_catalog
node_binder -.->|"plans bound SQL"| node_planner
node_planner -->|"estimates plans"| node_cost
node_planner -.->|"optimizes plans"| node_optimizer
node_planner -.->|"executes plans"| node_executor
node_executor -->|"delegates sorting"| node_sort
node_executor -->|"delegates set ops"| node_setops
node_executor -->|"produces batches"| node_vectors
node_executor -.->|"reads catalog"| node_catalog
node_executor -.->|"uses indexes"| node_index
node_executor -.->|"supports search"| node_fts
node_executor -.->|"applies transactions"| node_transactions
node_local -.->|"opens durable state"| node_storage
node_local -.->|"runs statements"| node_executor
node_local -->|"formats results"| node_output
node_storage -->|"upgrades v1 files"| node_upgrade
node_storage -->|"rotates page keys"| node_rekey
node_user -->|"requests upgrade"| node_upgrade
node_user -->|"requests rotation"| node_rekey
node_local -.->|"authorizes operations"| node_security
node_executor -->|"decrypts columns"| node_columncrypto
node_executor -.->|"runs scalar UDFs"| node_udf
node_instance -.->|"isolates sessions"| node_local

click node_local "https://github.com/czxieddan/rnovmodulardb/blob/master/crates/rnmdb-cli/src/lib.rs"
click node_tcp "https://github.com/czxieddan/rnovmodulardb/blob/master/crates/rnmdb-server/src/sql_protocol.rs"
click node_output "https://github.com/czxieddan/rnovmodulardb/blob/master/crates/rnmdb-cli/src/output.rs"
click node_lexer "https://github.com/czxieddan/rnovmodulardb/blob/master/crates/rnmdb-sql/src/lexer.rs"
click node_parser "https://github.com/czxieddan/rnovmodulardb/blob/master/crates/rnmdb-sql/src/parser.rs"
click node_ast "https://github.com/czxieddan/rnovmodulardb/blob/master/crates/rnmdb-sql/src/ast.rs"
click node_binder "https://github.com/czxieddan/rnovmodulardb/blob/master/crates/rnmdb-sql/src/binder.rs"
click node_planner "https://github.com/czxieddan/rnovmodulardb/blob/master/crates/rnmdb-planner/src/logical.rs"
click node_cost "https://github.com/czxieddan/rnovmodulardb/blob/master/crates/rnmdb-planner/src/cost.rs"
click node_optimizer "https://github.com/czxieddan/rnovmodulardb/blob/master/crates/rnmdb-planner/src/optimizer.rs"
click node_executor "https://github.com/czxieddan/rnovmodulardb/blob/master/crates/rnmdb-executor/src/memory.rs"
click node_sort "https://github.com/czxieddan/rnovmodulardb/blob/master/crates/rnmdb-executor/src/memory/sort.rs"
click node_setops "https://github.com/czxieddan/rnovmodulardb/blob/master/crates/rnmdb-executor/src/memory/set_ops.rs"
click node_vectors "https://github.com/czxieddan/rnovmodulardb/blob/master/crates/rnmdb-executor/src/vector.rs"
click node_catalog "https://github.com/czxieddan/rnovmodulardb/blob/master/crates/rnmdb-catalog/src/lib.rs"
click node_transactions "https://github.com/czxieddan/rnovmodulardb/blob/master/crates/rnmdb-txn/src/lib.rs"
click node_storage "https://github.com/czxieddan/rnovmodulardb/blob/master/crates/rnmdb-storage/src/lib.rs"
click node_upgrade "https://github.com/czxieddan/rnovmodulardb/blob/master/crates/rnmdb-storage/src/single_file_upgrade/legacy.rs"
click node_rekey "https://github.com/czxieddan/rnovmodulardb/blob/master/crates/rnmdb-storage/src/single_file_rekey.rs"
click node_index "https://github.com/czxieddan/rnovmodulardb/blob/master/crates/rnmdb-index/src/lib.rs"
click node_fts "https://github.com/czxieddan/rnovmodulardb/blob/master/crates/rnmdb-fts/src/lib.rs"
click node_security "https://github.com/czxieddan/rnovmodulardb/blob/master/crates/rnmdb-security/src/lib.rs"
click node_columncrypto "https://github.com/czxieddan/rnovmodulardb/blob/master/crates/rnmdb-executor/src/column_crypto.rs"
click node_udf "https://github.com/czxieddan/rnovmodulardb/blob/master/crates/rnmdb-udf/src/wasm_runtime.rs"
click node_instance "https://github.com/czxieddan/rnovmodulardb/blob/master/crates/rnmdb-instance/src/lib.rs"

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_local,node_tcp,node_output toneBlue
class node_lexer,node_parser,node_ast,node_binder,node_planner,node_cost,node_optimizer,node_executor,node_sort,node_setops,node_vectors toneAmber
class node_catalog,node_transactions,node_storage,node_upgrade,node_rekey toneMint
class node_index,node_fts toneRose
class node_security,node_columncrypto,node_udf,node_instance,node_user toneIndigo
```

## Components

### Interfaces

- [Local session / CLI](https://github.com/czxieddan/rnovmodulardb/blob/master/crates/rnmdb-cli/src/lib.rs): `crates/rnmdb-cli/src/lib.rs`
- [TCP SQL protocol](https://github.com/czxieddan/rnovmodulardb/blob/master/crates/rnmdb-server/src/sql_protocol.rs): `crates/rnmdb-server/src/sql_protocol.rs`
- [CLI output](https://github.com/czxieddan/rnovmodulardb/blob/master/crates/rnmdb-cli/src/output.rs): `crates/rnmdb-cli/src/output.rs`

### SQL Engine

- [SQL lexer](https://github.com/czxieddan/rnovmodulardb/blob/master/crates/rnmdb-sql/src/lexer.rs): `crates/rnmdb-sql/src/lexer.rs`
- [SQL parser / AST](https://github.com/czxieddan/rnovmodulardb/blob/master/crates/rnmdb-sql/src/parser.rs): `crates/rnmdb-sql/src/parser.rs`
- [SQL AST](https://github.com/czxieddan/rnovmodulardb/blob/master/crates/rnmdb-sql/src/ast.rs): `crates/rnmdb-sql/src/ast.rs`
- [Binder](https://github.com/czxieddan/rnovmodulardb/blob/master/crates/rnmdb-sql/src/binder.rs): `crates/rnmdb-sql/src/binder.rs`
- [Logical planning](https://github.com/czxieddan/rnovmodulardb/blob/master/crates/rnmdb-planner/src/logical.rs): `crates/rnmdb-planner/src/logical.rs`
- [Plan costing](https://github.com/czxieddan/rnovmodulardb/blob/master/crates/rnmdb-planner/src/cost.rs): `crates/rnmdb-planner/src/cost.rs`
- [Plan optimization](https://github.com/czxieddan/rnovmodulardb/blob/master/crates/rnmdb-planner/src/optimizer.rs): `crates/rnmdb-planner/src/optimizer.rs`
- [Memory executor](https://github.com/czxieddan/rnovmodulardb/blob/master/crates/rnmdb-executor/src/memory.rs): `crates/rnmdb-executor/src/memory.rs`
- [Sorting](https://github.com/czxieddan/rnovmodulardb/blob/master/crates/rnmdb-executor/src/memory/sort.rs): `crates/rnmdb-executor/src/memory/sort.rs`
- [Set operations](https://github.com/czxieddan/rnovmodulardb/blob/master/crates/rnmdb-executor/src/memory/set_ops.rs): `crates/rnmdb-executor/src/memory/set_ops.rs`
- [Vector batches](https://github.com/czxieddan/rnovmodulardb/blob/master/crates/rnmdb-executor/src/vector.rs): `crates/rnmdb-executor/src/vector.rs`

### State and Storage

- [Catalog](https://github.com/czxieddan/rnovmodulardb/blob/master/crates/rnmdb-catalog/src/lib.rs): `crates/rnmdb-catalog/src/lib.rs`
- [Transactions](https://github.com/czxieddan/rnovmodulardb/blob/master/crates/rnmdb-txn/src/lib.rs): `crates/rnmdb-txn/src/lib.rs`
- [Encrypted storage](https://github.com/czxieddan/rnovmodulardb/blob/master/crates/rnmdb-storage/src/lib.rs): `crates/rnmdb-storage/src/lib.rs`
- [Legacy upgrade](https://github.com/czxieddan/rnovmodulardb/blob/master/crates/rnmdb-storage/src/single_file_upgrade/legacy.rs): `crates/rnmdb-storage/src/single_file_upgrade/legacy.rs`
- [Page-key rotation](https://github.com/czxieddan/rnovmodulardb/blob/master/crates/rnmdb-storage/src/single_file_rekey.rs): `crates/rnmdb-storage/src/single_file_rekey.rs`

### Query Features

- [Indexes](https://github.com/czxieddan/rnovmodulardb/blob/master/crates/rnmdb-index/src/lib.rs): `crates/rnmdb-index/src/lib.rs`
- [Full-text search](https://github.com/czxieddan/rnovmodulardb/blob/master/crates/rnmdb-fts/src/lib.rs): `crates/rnmdb-fts/src/lib.rs`

### Security and Extensions

- [Authorization / policies](https://github.com/czxieddan/rnovmodulardb/blob/master/crates/rnmdb-security/src/lib.rs): `crates/rnmdb-security/src/lib.rs`
- [Column encryption](https://github.com/czxieddan/rnovmodulardb/blob/master/crates/rnmdb-executor/src/column_crypto.rs): `crates/rnmdb-executor/src/column_crypto.rs`
- [Wasm UDF runtime](https://github.com/czxieddan/rnovmodulardb/blob/master/crates/rnmdb-udf/src/wasm_runtime.rs): `crates/rnmdb-udf/src/wasm_runtime.rs`
- [Instance isolation](https://github.com/czxieddan/rnovmodulardb/blob/master/crates/rnmdb-instance/src/lib.rs): `crates/rnmdb-instance/src/lib.rs`

### Other components

- **Application / operator**

## Connections

- Application / operator → Local session / CLI: submits SQL (evidence: `README.md`)
- Application / operator → TCP SQL protocol: sends SQL (evidence: `README.md`)
- Local session / CLI → SQL lexer: accepts SQL
- TCP SQL protocol → SQL parser / AST: routes SQL
- SQL lexer → SQL parser / AST: tokenizes for
- SQL parser / AST → SQL AST: builds AST
- SQL AST → Binder: binds statements (evidence: `crates/rnmdb-sql/src/binder.rs`)
- Binder → Catalog: resolves metadata
- Binder → Logical planning: plans bound SQL
- Logical planning → Plan costing: estimates plans (evidence: `crates/rnmdb-planner/src/cost.rs`)
- Logical planning → Plan optimization: optimizes plans
- Logical planning → Memory executor: executes plans
- Memory executor → Sorting: delegates sorting (evidence: `crates/rnmdb-executor/src/memory.rs`)
- Memory executor → Set operations: delegates set ops (evidence: `crates/rnmdb-executor/src/memory.rs`)
- Memory executor → Vector batches: produces batches (evidence: `crates/rnmdb-executor/src/memory.rs`)
- Memory executor → Catalog: reads catalog
- Memory executor → Indexes: uses indexes
- Memory executor → Full-text search: supports search (evidence: `README.md`)
- Memory executor → Transactions: applies transactions (evidence: `README.md`)
- Local session / CLI → Encrypted storage: opens durable state (evidence: `README.md`)
- Local session / CLI → Memory executor: runs statements (evidence: `README.md`)
- Local session / CLI → CLI output: formats results
- Encrypted storage → Legacy upgrade: upgrades v1 files (evidence: `crates/rnmdb-storage/src/lib.rs`)
- Encrypted storage → Page-key rotation: rotates page keys (evidence: `crates/rnmdb-storage/src/lib.rs`)
- Application / operator → Legacy upgrade: requests upgrade (evidence: `README.md`)
- Application / operator → Page-key rotation: requests rotation (evidence: `README.md`)
- Local session / CLI → Authorization / policies: authorizes operations (evidence: `README.md`)
- Memory executor → Column encryption: decrypts columns (evidence: `crates/rnmdb-executor/src/memory.rs`)
- Memory executor → Wasm UDF runtime: runs scalar UDFs (evidence: `README.md`)
- Instance isolation → Local session / CLI: isolates sessions (evidence: `README.md`)
