Skip to content

Commit b08bbf8

Browse files
committed
docs: update README with current test count and TUI Dashboard features
- Update test count: 3806 tests, 12180 assertions (was 2325 tests, 7759 assertions) - Expand TUI Dashboard description with all 8 panes across 2 screens - Add detailed features list: global search, schema browser, migration manager, server variables, SQL scratchpad - Mention dual-screen support and keyboard navigation improvements
1 parent 65f45fb commit b08bbf8

File tree

1 file changed

+15
-9
lines changed

1 file changed

+15
-9
lines changed

README.md

Lines changed: 15 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ Built on top of PDO with **zero external dependencies**, it offers:
3636
- **ActiveRecord Pattern** - Optional lightweight ORM for object-based database operations with relationships (hasOne, hasMany, belongsTo, hasManyThrough), eager/lazy loading, and query scopes
3737

3838
**Developer Experience:**
39-
- **🖥️ Interactive TUI Dashboard** - Real-time database monitoring with full-screen terminal interface. Monitor active queries, connection pool, cache statistics, and server metrics. Kill long-running queries, view query details, and track performance metrics in real-time. Launch with `pdodb ui`
39+
- **🖥️ Interactive TUI Dashboard** - Real-time database monitoring with full-screen terminal interface. 8 panes across 2 screens: Active Queries, Connection Pool, Cache Statistics, Server Metrics, Schema Browser, Migration Manager, Server Variables, and SQL Scratchpad. Features include global search filter, query inspection, performance tracking, query management, and keyboard navigation. Launch with `pdodb ui`
4040
- **CLI Tools** - Database management, user management, dump/restore, migration generator, seed generator, model generator, schema inspector, interactive query tester (REPL)
4141
- **Enhanced EXPLAIN** - Automatic detection of full table scans, missing indexes, and optimization recommendations
4242
- **Exception Hierarchy** - Typed exceptions for precise error handling
@@ -47,7 +47,7 @@ Built on top of PDO with **zero external dependencies**, it offers:
4747
- **Plugin System** - Extend PdoDb with custom plugins for macros, scopes, and event listeners
4848

4949
**Production Ready:**
50-
- **Fully Tested** - 2325 tests, 7759 assertions across all dialects
50+
- **Fully Tested** - 3806 tests, 12180 assertions across all dialects
5151
- **Type-Safe** - PHPStan level 8 validated, PSR-12 compliant
5252
- **Zero Memory Leaks** - Production-tested memory management with automatic cursor cleanup
5353
- **Connection Retry** - Automatic retry with exponential backoff
@@ -650,14 +650,20 @@ vendor/bin/pdodb ui
650650
```
651651

652652
**Features:**
653-
- 📊 **Real-time monitoring** - Active queries, connection pool, cache stats, server metrics
654-
- 🔍 **Query inspection** - View full query text, execution time, user, database
655-
-**Performance tracking** - Cache hit rates, connection counts, server uptime
656-
- 🛑 **Query management** - Kill long-running queries with a single keystroke
657-
- ⌨️ **Keyboard navigation** - Switch panes, scroll, fullscreen mode, refresh intervals
653+
- 📊 **8 Monitoring Panes** - Active Queries, Connection Pool, Cache Statistics, Server Metrics, Schema Browser, Migration Manager, Server Variables, SQL Scratchpad
654+
- 🔍 **Global Search** - Press `/` to filter tables and server variables in real-time (case-insensitive)
655+
- 📋 **Schema Browser** - Navigate database schema, view tables, columns, indexes, and foreign keys with tree navigation
656+
- 🔧 **Migration Manager** - View migration status, run pending migrations, rollback last migration, create new migrations
657+
- 📈 **Server Variables** - Browse all server configuration variables with highlighting for important performance settings
658+
- 💻 **SQL Scratchpad** - Interactive SQL editor with query history, autocomplete, transaction mode, and result viewing
659+
- 🔍 **Query inspection** - View full query text, execution time, user, database in detail view
660+
-**Performance tracking** - Cache hit rates, connection counts, server uptime, query execution times
661+
- 🛑 **Query management** - Kill long-running queries and connections with a single keystroke
662+
- ⌨️ **Keyboard navigation** - Switch between 8 panes (1-8 keys), navigate screens (Tab/arrows), fullscreen mode, refresh intervals
658663
- 🎨 **Color-coded metrics** - Visual indicators for performance and health
664+
- 📱 **Dual-screen support** - Navigate between two screens (panes 1-4 and 5-8)
659665

660-
Perfect for debugging, monitoring production databases, and understanding query patterns.
666+
Perfect for debugging, monitoring production databases, understanding query patterns, and managing database schema.
661667

662668
### Available Commands
663669

@@ -909,7 +915,7 @@ $users = $db->rawQuery('SELECT * FROM users WHERE age > :age', ['age' => 18]);
909915
Yes! PDOdb is framework-agnostic. Works with Laravel, Symfony, Yii, or no framework at all.
910916

911917
### Is it production-ready?
912-
Yes! 2325+ tests, PHPStan level 8, used in production environments.
918+
Yes! 3806+ tests, 12180+ assertions, PHPStan level 8, used in production environments.
913919

914920
### What about security?
915921
All queries use **prepared statements** automatically. SQL injection protection is built-in.

0 commit comments

Comments
 (0)