Skip to content

Commit 36b5b93

Browse files
committed
feat: enhance FEATURES.md with SQLite support details and test coverage information
1 parent 18e9bb1 commit 36b5b93

1 file changed

Lines changed: 36 additions & 4 deletions

File tree

FEATURES.md

Lines changed: 36 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,13 @@
22

33
This document provides a comprehensive breakdown of all features and capabilities in RelWave. For installation and setup instructions, see the main [README](README.md).
44

5-
**Tech Stack:** Tauri + React 18 + TypeScript + Tailwind CSS + shadcn/ui + React Query + ReactFlow + Recharts + CodeMirror
5+
**Tech Stack:** Tauri + React 18 + TypeScript + Tailwind CSS + shadcn/ui + React Query + ReactFlow + Recharts + CodeMirror + better-sqlite3
66

77
---
88

99
## Table of Contents
1010

11+
- [Supported Databases](#supported-databases)
1112
- [Core Pages and Navigation](#core-pages-and-navigation)
1213
- [Git Version Control](#git-version-control)
1314
- [Visual Tools](#visual-tools)
@@ -19,6 +20,26 @@ This document provides a comprehensive breakdown of all features and capabilitie
1920

2021
---
2122

23+
## Supported Databases
24+
25+
| Database | Connection Type | Schema Explorer | ER Diagram | Query Builder | Migrations | CRUD |
26+
| -------- | --------------- | --------------- | ---------- | ------------- | ---------- | ---- |
27+
| PostgreSQL | Host/port + SSL ||||||
28+
| MySQL | Host/port + SSL ||||||
29+
| MariaDB | Host/port + SSL ||||||
30+
| SQLite | Local file path ||||||
31+
32+
### SQLite-Specific Features
33+
34+
- **File-based connections** — no server required; connect directly to `.db`, `.sqlite`, `.sqlite3`, `.s3db` files
35+
- **Native file picker** — Tauri file dialog for browsing and selecting database files
36+
- **Read-only mode** — open databases in read-only mode when write access isn't needed
37+
- **PRAGMA-based introspection** — uses `table_xinfo`, `foreign_key_list`, `index_list`, and `index_info` for full schema discovery
38+
- **Synchronous driver** — uses `better-sqlite3` for efficient, synchronous access to SQLite databases
39+
- **Full test coverage** — 69 tests covering connector operations and caching (38 integration + 31 unit)
40+
41+
---
42+
2243
## Core Pages and Navigation
2344

2445
### 1. Dashboard
@@ -28,8 +49,9 @@ The main landing page for managing database connections. Features a clean, IDE-i
2849
**Connection Management**
2950

3051
- Add new database connections with detailed configuration (name, type, host, port, user, password, SSL options)
52+
- **SQLite support** — connect to local `.db`, `.sqlite`, `.sqlite3`, `.s3db` files via native file picker
3153
- Connect via URL — paste connection strings like `postgres://user:pass@host:port/db`
32-
- Auto-parse URLs to populate connection form fields
54+
- Auto-parse URLs to populate connection form fields (including `sqlite://` protocol)
3355
- Delete existing database connections
3456
- Test connections with real-time feedback
3557
- Connection status indicators for all databases
@@ -38,6 +60,7 @@ The main landing page for managing database connections. Features a clean, IDE-i
3860

3961
- Automatically discover databases running on the local machine
4062
- TCP port scanning for PostgreSQL (5432–5434) and MySQL (3306–3308)
63+
- SQLite file-based connections (no host/port — uses native file browser)
4164
- Docker container detection with image recognition
4265
- Docker credential extraction — reads `POSTGRES_USER`, `POSTGRES_PASSWORD`, `MYSQL_ROOT_PASSWORD`, etc. from container environment variables
4366
- One-click add with pre-filled connection details
@@ -104,7 +127,7 @@ Detailed view for individual database operations with a split-panel layout.
104127
**Search**
105128

106129
- Cross-column search across all table fields
107-
- Case-insensitive matching (ILIKE for PostgreSQL, LIKE for MySQL/MariaDB)
130+
- Case-insensitive matching (ILIKE for PostgreSQL, LIKE for MySQL/MariaDB/SQLite)
108131
- Paginated search results
109132
- Real-time result count display
110133
- Clear search to return to the default view
@@ -435,6 +458,15 @@ RelWave includes native Git integration powered by `simple-git`, providing a ful
435458
- Toggle to collapse/expand with smooth width transition
436459
- Persistent state across sessions
437460

461+
### Database Engine Colors
462+
463+
| Engine | Color |
464+
| ------ | ----- |
465+
| PostgreSQL | Blue |
466+
| MySQL | Orange |
467+
| MariaDB | Purple |
468+
| SQLite | Cyan |
469+
438470
### Theming
439471

440472
- Dark and light mode with seamless switching
@@ -542,6 +574,6 @@ All database and Git operations use a JSON-RPC protocol over stdin/stdout. The b
542574

543575
---
544576

545-
**Last Updated:** February 2026
577+
**Last Updated:** March 2026
546578

547579
This document is maintained alongside the application and updated with each release.

0 commit comments

Comments
 (0)