# ð€ Rowdy
[](https://crates.io/crates/rowdy-db)
[](#-license)
A fast, modern, and rowdy **Terminal User Interface (TUI)** database management tool written in Rust.
Rowdy is designed for developers, DBAs, and terminal enthusiasts who want to inspect, query, and manage their databases without ever leaving their terminal or touching a mouse. Built on `ratatui` and `sqlx`, it compiles into a single standalone binary with no runtime dependencies.
---
## âš Features
| SQLite, PostgreSQL, MySQL/MariaDB connectors | â
|
| libsql / Turso connector (remote SQLite via libsql protocol) | â
|
| Redis connector (key listing) | â
|
| Saved connection profiles (`~/.config/rowdy/config.toml`) | â
|
| Save new connection with `Ctrl+S` â persists to config file | â
|
| Delete profile with confirmation (`D` â `y` / `n`) | â
|
| Vim-style keyboard navigation (`h j k l`, `/` to filter) | â
|
| Table list with live filter | â
|
| Data Grid â column scroll, collapse/expand, manual resize (`-`/`=`) | â
|
| Data Grid â cell preview panel (full value, no truncation) | â
|
| Data Grid â infinite scroll pagination (200 rows/page + COUNT) | â
|
| Data Grid â cumulative column filters (`f` / `d` / `F`) | â
|
| Data Grid â type-aware filters (bool â `= TRUE/FALSE`, numeric â `= n`) | â
|
| Data Grid â cell cursor (row à column highlight) | â
|
| Data Grid â FK badges + expandable sub-grid (recursive navigation) | â
|
| SQL Editor â multi-line, F5 to execute, F4 opens result in full grid | â
|
| SQL Editor â query history with `Alt+â/â`, persisted to `~/.config/rowdy/history.toml` | â
|
| Schema introspection â PK, FK, types (all 4 SQL engines) | â
|
| Inline record editing â field type display, bool toggle, live SQL preview | â
|
| Format validation in Edit Record â DATE/TIME/TIMESTAMP/UUID/JSON/INET validated on exit, red highlight + format hint | â
|
| Confirmation modal â `Ctrl+S` in Edit Record prompts before executing UPDATE | â
|
| Error modal â save failures displayed as a prominent overlay dialog | â
|
| Status bar â mode, connection indicator, DB info, row count, flash messages | â
|
| URL redaction â passwords and tokens masked in UI (`user:***@host`, `authToken=***`) | â
|
| Export CSV / JSON â `E` key in any data grid, file saved to `~/rowdy_<table>_<ts>.csv/json` | â
|
| Export JSON simple (`j`) or with recursive FK resolution (`J`) â nested `__ref` objects up to 3 levels deep, cycle detection | â
|
| Table list â TABLE / VIEW distinction with `[T]` / `[V]` badges; VIEW opens read-only with cyan badge | â
|
| Read-only safe mode â `?readonly=true` in URL, blocks all writes, `READ-ONLY` badge in status bar | â
|
| Pre-connect / post-disconnect hooks per profile â run shell scripts before connecting and after disconnecting (SSH tunnels, VPNâŠ) | â
|
| Async I/O â UI never blocks during queries | â
|
| Redis key-detail view â `Enter` on a key shows its content (string/hash/list/set/zset) in a read-only grid with TTL | â
|
| Schema panel in table list â columns with PK/FK badges, outgoing and incoming FK relations, auto-loaded on connect | â
|
| ERD graph view (`r`) â star layout with box-drawing, bent arrows routed from exact FK column, navigate between boxes | â
|
| MongoDB connector (`--features mongodb`) â browse collections, MQL editor, nested field navigation | â
|
| MongoDB document editing â `replace_one` with confirmation, recursive nested object / array editor | â
|
---
## ð Quick Start
### Build from source
```bash
git clone https://github.com/TSODev/rowdy.git
cd rowdy
cargo build --release
./target/release/rowdy-db
```
### Install from crates.io
```bash
cargo install rowdy-db
```
---
## âïž Configuration
Create `~/.config/rowdy/config.toml` to save connection profiles:
```toml
[[connections]]
name = "Local Postgres"
type = "postgres"
url = "postgres://user:password@localhost:5432/my_db"
[[connections]]
name = "Dev SQLite"
type = "sqlite"
url = "sqlite:///home/user/dev.db"
[[connections]]
name = "Turso Cloud"
type = "libsql"
url = "libsql://your-db-org.turso.io?authToken=eyJ..."
[[connections]]
name = "Cache Redis"
type = "redis"
url = "redis://127.0.0.1:6379"
[[connections]]
name = "MySQL Local"
type = "mysql"
url = "mysql://root:password@localhost:3306/my_db"
```
Profiles appear in the left panel of the connection screen at startup.
You can also add optional **pre-connect** and **post-disconnect** shell scripts per profile (useful for SSH tunnels, VPN, etc.):
```toml
[[connections]]
name = "VPS Postgres (SSH tunnel)"
type = "postgres"
url = "postgres://user:password@localhost:5432/mydb"
pre_connect = "ssh -f -N -L 5432:localhost:5432 user@remote-host"
post_disconnect = "pkill -f 'ssh -L 5432:localhost:5432'"
```
The `pre_connect` script runs before the database connection is established; `post_disconnect` runs when you disconnect or quit the app.
To connect in **read-only mode** (blocks all writes â safe for production), append `?readonly=true` to any URL:
```toml
[[connections]]
name = "Production (read-only)"
type = "postgres"
url = "postgres://user:pass@prod-host/mydb?sslmode=require&readonly=true"
```
A red `READ-ONLY` badge appears in the status bar. `Enter` (edit record) and all DML statements in the SQL editor are disabled. Filters, pagination, and export still work normally.
---
## âšïž Keyboard shortcuts
### Connection screen
| `j` / `k` | Navigate profiles |
| `Enter` | Connect to selected profile |
| `n` | Enter a new connection URL |
| `e` | Edit selected profile (pre-fills all fields for modification) |
| `Tab` | Cycle focus between fields: DB Type â URL â Pre-connect â Post-disconnect |
| `â` / `â` | Cycle database type when DB Type field is active |
| `Ctrl+S` | Save current connection (URL + scripts) as a named profile |
| `D` | Delete selected profile (with confirmation) |
| `q` | Quit |
### Table list
| `j` / `k` | Navigate tables |
| `Enter` | Open table in Data Grid |
| `e` | Open SQL Editor |
| `r` | Open ERD graph view centered on selected table |
| `/` | Filter tables |
| `q` | Disconnect |
### Data Grid
| `j` / `k` | Next / previous row |
| `h` / `l` | Previous / next column |
| `g` / `G` | First / last row |
| `PgDn` / `PgUp` | ±10 rows |
| `Space` | Collapse / expand selected column |
| `-` / `=` | Shrink / grow selected column width (step 5) |
| `f` | Open filter input for selected column |
| `d` | Remove filter on selected column |
| `F` | Clear all filters |
| `Enter` | FK cell â open linked sub-grid ; other cell â Edit Record |
| `E` | Export prompt (then `c`=CSV, `j`=JSON, `J`=JSON+FK, `Esc`=cancel) |
| `q` | Back to table list |
### Edit Record
| `j` / `k` | Next / previous field |
| `Enter` / `i` | Edit selected field â or drill into nested `[obj]` / `[arr]` (MongoDB) |
| `Space` | Toggle boolean field (`true` â `false`) |
| `â` / `â` | Move cursor within field |
| `Home` / `End` | Jump to start / end of field |
| `Backspace` / `Del` | Delete character |
| `Ctrl+S` | Save changes â confirmation modal before UPDATE (SQL) or `replace_one` (MongoDB) |
| `Esc` / `q` | Back to Data Grid without saving â or confirm nested edit and go up one level (MongoDB) |
**MongoDB nested editor** â when drilling into `[obj]` or `[arr]` fields, the title shows the breadcrumb (`collection ⺠field ⺠subfield`). Press `Esc` at any nested level to confirm that level's edits and return to the parent. `Ctrl+S` is only available at the root level.
**Array editor** â additional keys when editing an array field:
| `a` | Add new item at end (enters edit mode immediately) |
| `D` | Delete selected item and renumber remaining items |
### ERD graph view (`r`)
| `j` / `k` or `Tab` | Cycle between visible table boxes |
| `Enter` | Re-center view on selected box (navigate the graph) |
| `q` / `Esc` | Back to table list |
The ERD view displays a **star layout**: the selected table in the center (yellow box), tables with incoming FK on the left (cyan), and tables referenced by outgoing FK on the right (cyan). Arrows are routed from the exact FK column line. No additional queries are made â the schema is reused from the panel loaded on connect.
### SQL Editor
| `F5` / `Ctrl+Enter` | Execute query |
| `F4` | Open SELECT result in full Data Grid (read-only) |
| `Alt+â` | Recall previous query from history |
| `Alt+â` | Recall next query from history (empty = clear) |
| `Tab` | Switch focus to results pane |
| `Tab` / `Esc` | Switch focus back to editor |
| `Ctrl+Q` | Back to table list |
`SELECT`, `WITH`, `EXPLAIN`, `SHOW`, `PRAGMA` â returns rows.
`INSERT`, `UPDATE`, `DELETE`, `CREATE`, ⊠â shows rows affected.
**`Ctrl-C` quits from anywhere.**
---
## ðïž Supported databases
| PostgreSQL | SQL | `sqlx` (native TLS) | `postgres://user:pass@host:5432/db` |
| SQLite | SQL | `sqlx` | `sqlite:///path/to/file.db` |
| libsql / Turso | SQL | `libsql` (remote HTTP) | `libsql://host?authToken=TOKEN` |
| MySQL / MariaDB | SQL | `sqlx` | `mysql://user:pass@host:3306/db` |
| Redis | Key-value | `redis-rs` (async multiplexed) | `redis://host:6379` |
| MongoDB | Document | `mongodb` 3 (feature-gated) | `mongodb://user:pass@host:27017/dbname` |
MongoDB requires building with the optional feature flag:
```bash
cargo build --release --features mongodb
cargo install rowdy-db --features mongodb
```
---
## ð Full documentation
See [USAGE.md](USAGE.md) for the complete user guide including connection URL formats, all keyboard shortcuts, and feature details.
---
## ðš Development
```bash
cargo run # run in dev mode
cargo build # debug build
cargo test # run tests
cargo clippy # lint
```
---
## ð License
Licensed under either of [MIT](LICENSE-MIT) or [Apache 2.0](LICENSE-APACHE) at your option.