From 1852d6639dffdfe0e8b85974f7f0dc1118ad965f Mon Sep 17 00:00:00 2001 From: Richie Varghese Date: Sun, 8 Feb 2026 21:16:09 +0530 Subject: [PATCH] feat: Update documentation to reflect new connection safety features and enhancements --- CHANGELOG.md | 2 +- MARKETPLACE.md | 21 +++++++++++++++++++-- README.md | 29 ++++++++++++++++++++++++++++- docs/ROADMAP.md | 33 +++++++++++++++++---------------- docs/index.html | 38 +++++++++++++++++++++++++++++++++++++- 5 files changed, 102 insertions(+), 21 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 6e57801..1c2ea66 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -7,7 +7,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 --- -## [Unreleased] - 0.8.1 +## [0.8.1] - 2026-02-08 ### Added - **Connection Safety Features**: Environment tagging (🔴 PROD, 🟡 STAGING, 🟢 DEV), read-only mode enforcement, query safety analyzer with risk scoring, and status bar risk indicator. diff --git a/MARKETPLACE.md b/MARKETPLACE.md index 875e2b6..2e34b73 100644 --- a/MARKETPLACE.md +++ b/MARKETPLACE.md @@ -33,10 +33,14 @@ | Feature | Description | |---------|-------------| | 🔌 **Secure Connections** | Manage multiple connections with VS Code SecretStorage encryption | +| 🛡️ **Connection Safety** | Environment tagging (🔴 PROD, 🟡 STAGING, 🟢 DEV), read-only mode, query safety analyzer | | 📊 **Live Dashboard** | Real-time metrics, active query monitoring, and performance graphs | | 📓 **SQL Notebooks** | Interactive notebooks with rich output, AI assistance, and export options | | 🌳 **Database Explorer** | Browse tables, views, functions, types, extensions, roles, and FDWs | | 🛠️ **Object Operations** | Full CRUD operations, scripts, VACUUM, ANALYZE, REINDEX | +| 📊 **Table Intelligence** | Profile, activity monitor, index usage analytics, definition viewer | +| 🔍 **EXPLAIN CodeLens** | One-click EXPLAIN/ANALYZE with results in notebooks | +| 🛡️ **Auto-LIMIT** | Automatic query protection with configurable row limits (default 1000) | | 🌍 **Foreign Data Wrappers** | Manage foreign servers, user mappings, and tables | | 🤖 **AI-Powered** | GitHub Copilot, OpenAI, Anthropic, and Google Gemini integration | | ⌨️ **Developer Tools** | IntelliSense, keyboard shortcuts, PSQL terminal access | @@ -72,13 +76,26 @@ ### 🔐 Secure & Reliable - VS Code SecretStorage for credentials -- Safe connection management +- Environment tagging & read-only mode +- Query safety analyzer with risk scoring +- Auto-LIMIT protection - Transaction support -- Data integrity protection +### 📊 Performance Intelligence +- Table profiling with size breakdown +- Real-time activity monitoring +- Index usage analytics +- Bloat detection & warnings +- EXPLAIN CodeLens for optimization + + + + + + ### 🚀 Developer Friendly - 🤖 GitHub Copilot integration - Keyboard shortcuts diff --git a/README.md b/README.md index 6f7ea6c..12541da 100644 --- a/README.md +++ b/README.md @@ -36,10 +36,14 @@ ## ✨ Key Features - 🔌 **Secure Connections** — VS Code SecretStorage encryption +- 🛡️ **Connection Safety** — Environment tagging (🔴 PROD, 🟡 STAGING, 🟢 DEV), read-only mode, query safety analyzer - 📊 **Live Dashboard** — Real-time metrics & query monitoring - 📓 **SQL Notebooks** — Interactive notebooks with AI assistance - 🌳 **Database Explorer** — Browse tables, views, functions, types, FDWs - 🛠️ **Object Operations** — CRUD, scripts, VACUUM, ANALYZE, REINDEX +- 📊 **Table Intelligence** — Profile, activity monitor, index usage, definition viewer +- 🔍 **EXPLAIN CodeLens** — One-click query analysis directly in notebooks +- 🛡️ **Auto-LIMIT** — Intelligent query protection (configurable, default 1000 rows) - 🌍 **Foreign Data Wrappers** — Manage foreign servers, user mappings & tables - 🤖 **AI-Powered** — Generate, Optimize, Explain & Analyze (OpenAI, Anthropic, Gemini) - 📤 **Export Data** — Export results to CSV, JSON, or Excel @@ -64,8 +68,31 @@ ### ⚡ Powerful Features - Interactive SQL notebooks - 🤖 AI-powered Copilot & agentic support -- Advanced query management +- Table intelligence & performance insights - Complete CRUD operations +- EXPLAIN CodeLens for query analysis + + + + + + +### 🛡️ Production-Ready Safety +- Environment tagging (Production/Staging/Dev) +- Read-only mode enforcement +- Query safety analyzer with risk scoring +- Auto-LIMIT for SELECT queries +- Status bar risk indicators + + + + +### 📊 Performance Insights +- Table profile with size & statistics +- Real-time activity monitoring +- Index usage analytics +- Bloat detection & warnings +- Complete table definitions diff --git a/docs/ROADMAP.md b/docs/ROADMAP.md index ba24399..4945149 100644 --- a/docs/ROADMAP.md +++ b/docs/ROADMAP.md @@ -95,22 +95,23 @@ --- -## 🧠 Phase 6: Data Intelligence & Productivity - -### Query Productivity -- [ ] **Query history with rerun & diff** -- [ ] **Auto `LIMIT` / sampling for SELECT** - - Implementation: Automatically append `LIMIT 100` if not present when in browsing mode. -- [ ] **One-click `EXPLAIN` / `EXPLAIN ANALYZE`** - - Implementation: CodeLens or button to wrap current query in `EXPLAIN ANALYZE` and visualize output. - -### Table Intelligence -- [ ] **Table profile** - - Implementation: Fetch row count, approximate size, null %, distinction stats. -- [ ] **Quick stats & recent activity** - - Implementation: Show recent tuples inserted/updated/deleted from `pg_stat_user_tables`. -- [ ] **Open definition / indexes / constraints** - - Implementation: Quick view for DDL, indexes list, and foreign key constraints. +## 🧠 Phase 6: Data Intelligence & Productivity ✅ COMPLETE + +### Query Productivity ✅ COMPLETE +- [x] **Auto `LIMIT` / sampling for SELECT** + - Implementation: Automatically append `LIMIT 1000` (configurable) if not present. Smart detection skips queries with existing LIMIT/OFFSET. Auto-disabled in read-only mode. +- [x] **One-click `EXPLAIN` / `EXPLAIN ANALYZE`** + - Implementation: CodeLens buttons on all SQL queries to wrap in `EXPLAIN` or `EXPLAIN ANALYZE`. Results inserted as new notebook cell for seamless workflow. + +### Table Intelligence ✅ COMPLETE +- [x] **Table profile** + - Implementation: Comprehensive statistics including approximate row count, storage size breakdown (table/indexes/TOAST), column-level stats (null %, distinct values, correlation), and complete column definitions. +- [x] **Quick stats & recent activity** + - Implementation: Real-time insights from `pg_stat_user_tables` showing access patterns (sequential/index scans), data modifications (inserts/updates/deletes/HOT updates), table health metrics (live/dead rows, bloat ratio), and maintenance history (VACUUM/ANALYZE timestamps). +- [x] **Index usage analytics** + - Implementation: Performance insights for all indexes including usage statistics (scans, tuples read/fetched), index definitions with DDL and size, automatic detection of unused indexes with recommendations. +- [x] **Open definition / indexes / constraints** + - Implementation: Complete table structure viewer with generated CREATE TABLE DDL, all constraints (PRIMARY KEY, UNIQUE, FOREIGN KEY, CHECK), complete index definitions, and incoming foreign key relationships. --- diff --git a/docs/index.html b/docs/index.html index 1d8b11e..92789f5 100644 --- a/docs/index.html +++ b/docs/index.html @@ -183,6 +183,18 @@

Everything You Need

Comprehensive database management tools built for modern development

+
+
🛡️
+

Connection Safety

+

Production-ready safety features for enterprise environments.

+
    +
  • Environment tagging (🔴 PROD, 🟡 STAGING, 🟢 DEV)
    • +
  • Read-only mode enforcement
    • +
  • Query safety analyzer with risk scoring
    • +
  • Status bar risk indicators
    • +
+
+
🔐

Secure Connections

@@ -190,13 +202,37 @@

Secure Connections

  • VS Code SecretStorage encryption
  • Multiple simultaneous connections
    • -
  • One-click connect/disconnect
    • +
  • Auto-LIMIT protection (default 1000 rows)
  • Connection string import
📊
+

Table Intelligence

+

Comprehensive insights into table performance and health.

+
    +
  • Table profile with size breakdown & statistics
    • +
  • Real-time activity monitoring
    • +
  • Index usage analytics
    • +
  • Bloat detection & complete definitions
    • +
+
+ +
+
🔍
+

EXPLAIN CodeLens

+

One-click query analysis directly in your notebooks.

+
    +
  • EXPLAIN & EXPLAIN ANALYZE buttons
    • +
  • Results inserted as notebook cells
    • +
  • Performance optimization insights
    • +
  • Query execution plan visualization
    • +
+
+ +
+
📈

Live Dashboard

Real-time database metrics and performance monitoring.