Skip to content

ARCHITECTURE.md

Latest commit

 

History

History
57 lines (50 loc) · 2.08 KB

ARCHITECTURE.md

File metadata and controls

57 lines (50 loc) · 2.08 KB
Raw

Architecture

omni-sql is a local desktop application. The browser Vite mode exists only for frontend development.

flowchart LR
  UI[React 19 + Fluent UI v9 + Monaco] -->|HTTP JSON-RPC| API[Node backend\n127.0.0.1:41920]
  Shell[Rust Tauri shell] --> UI
  Shell --> API
  API --> Cache[(SQLite metadata cache\nnode:sqlite)]
  API --> Keyring[OS keyring]
  API --> Native[Native adapters\npg / mysql2 / mssql / oracledb]
  API --> JDBC[Generic JDBC adapter]
  JDBC -->|HTTP loopback| JVM[Kotlin JVM sidecar\n127.0.0.1:41921]
  JVM --> DB[(Database)]
  Native --> DB
Loading

Components

  • Tauri shell: Rust starts and stops the Node backend and optional JVM sidecar, owns the native window, and exposes restricted file-picker commands.
  • Frontend: React 19, Fluent UI React v9, and Monaco Editor. It calls the backend through the desktop HTTP JSON-RPC contract.
  • Node backend: TypeScript HTTP JSON-RPC service on loopback port 41920. It owns connection state, handlers, adapters, metadata synchronization, and autocomplete orchestration.
  • Metadata cache: SQLite through Node's built-in node:sqlite, including metadata timestamps. Passwords use the OS keyring; development fallback is explicitly opt-in.
  • Native adapters: PostgreSQL (pg), MySQL/MariaDB (mysql2/promise), SQL Server (mssql/Tedious), and Oracle (oracledb thin mode).
  • JVM sidecar: Kotlin/JDK HTTP service on 127.0.0.1:41921. Apache Calcite resolves CTE output column names for tier-2 autocomplete. It also loads user-supplied JDBC drivers.

Runtime flows

sequenceDiagram
  participant T as Tauri
  participant N as Node :41920
  participant J as JVM :41921
  participant D as Database
  T->>N: spawn and health-check
  T->>J: spawn JAR when present
  UI->>N: JSON-RPC request
  N->>D: native adapter query/introspection
  N->>J: JDBC or CTE scope request
  J->>D: JDBC request when needed
  N-->>UI: JSON-RPC result
Loading

The JVM sidecar is optional and used on a best-effort basis. If absent, unavailable, or slow, completion falls back to tier 1; the request does not fail.