dbtui

A terminal-based database client with Vim-style navigation. Browse schemas, write SQL, execute queries, and explore data — all from the terminal.

Built with Rust, Ratatui, and Tokio. Vim editing powered by vimltui (crates.io).

Features

• Multi-database support — Oracle, PostgreSQL, MySQL
• Vim editing — Powered by vimltui: full modal editing (Normal, Insert, Visual), operator+motion composition, f/F/t/T, dot repeat, search highlighting, registers, system clipboard
• Schema explorer — Browse connections, schemas, tables, views, packages, functions, and procedures
• SQL editor — Syntax highlighting, relative line numbers, search (/), and command mode (:)
• Smart query execution — Execute the query block at cursor (<Space>Enter) or visual selection
• Result tabs — Multiple result sets per script, switch with {/}
• SQL completion (CMP) — Context-aware autocompletion: tables after FROM, columns after SELECT/WHERE, Oracle schema hierarchy, alias resolution
• SQL diagnostics (LCP) — Real-time validation of table/view references against database metadata
• Bind variables — :variableName prompts with persistent value memory across sessions
• Error display — Split pane showing error message and failed SQL side by side, with real line numbers
• Data grid — Cell-level navigation, visual selection (v), copy to clipboard (y)
• Horizontal scroll — Navigate wide tables with many columns
• Per-tab connections — Each tab tracks its own connection, auto-reconnect on script open
• Theme system — 6 built-in themes with transparent backgrounds
• Leader key menu — <Space> opens a command palette with all available actions
• Encrypted storage — Connection credentials encrypted at rest (ChaCha20Poly1305 + Argon2)

Installation

git clone https://github.com/Di3go0-0/dbtui.git
cd dbtui
cargo build --release

The binary will be at target/release/dbtui.

Dependencies

• Rust 2024 edition
• For clipboard support: wl-copy (Wayland), xclip, or xsel
• For Oracle: Oracle Instant Client libraries

Quick Start

# Run dbtui
./target/release/dbtui

# Or with a PostgreSQL connection via environment variable
DBTUI_POSTGRES_URL="postgres://user:pass@localhost/db" ./target/release/dbtui

Press a to add a new connection, or ? for help.

Keybindings

Global

Leader Commands (<Space>)

SQL Completion (Insert mode)

Editor (Vim)

Data Grid

Scripts Panel

Supported Databases

Themes

Switch themes with <Space>t:

• Tokyo Night — Blue and purple tones
• Catppuccin — Pastel lavender palette
• Dracula — Purple and pink accents
• Nord — Arctic blue tones
• Gruvbox — Warm brown and orange
• Default — Classic blue

All themes use transparent backgrounds — your terminal's background shows through.

Architecture

src/
  core/       — Database adapter trait, models, errors, storage, encryption
  drivers/    — Per-database implementations (Oracle, PostgreSQL, MySQL)
  ui/         — Terminal UI (Ratatui rendering, input handling, widgets)
    completion.rs — Context-aware SQL autocompletion engine
    diagnostics.rs — SQL validation against database metadata
    sql_tokens.rs  — Shared SQL tokenizer for completion and diagnostics
    widgets/  — Sidebar, data grid, status bar, dialogs
    tabs/     — Tab management and workspace state
  main.rs     — Tokio runtime, terminal setup, event loop

Hard constraints:

• No database logic in src/ui/
• No UI logic in src/drivers/ or src/core/
• No blocking in UI thread (all DB operations async via Tokio + mpsc channels)
• No .unwrap() or .expect() in production code

Data Storage

Configuration and scripts are stored in the XDG data directory:

~/.local/share/dbtui/
  connections.enc    — Encrypted connection configs
  scripts/           — SQL script files
  object_filters.json — Saved schema/object filters
  script_connections.json — Script-to-connection mappings
  bind_variables.json    — Persisted bind variable values
  theme.txt          — Selected theme

License

MIT License. See LICENSE for details.