Skip to content

Commit 782199f

Browse files
committed
docs: add limitations section, honest positioning, remove unsubstantiated claims
1 parent 091ad4d commit 782199f

File tree

1 file changed

+17
-5
lines changed

1 file changed

+17
-5
lines changed

README.md

Lines changed: 17 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# LiveSQL
22

3-
> See how your SQL actually executes. Real-time query visualization with bottleneck detection, index recommendations, and animated execution flow.
3+
> Query plan visualization with bottleneck detection, index recommendations, and animated execution flow.
44
55
[![.NET 8](https://img.shields.io/badge/.NET-8.0-512BD4?logo=dotnet)](https://dotnet.microsoft.com/)
66
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)
@@ -22,7 +22,7 @@ You write SQL. The database does... something. SSMS shows you a confusing execut
2222
LiveSQL makes it visual, animated, and understandable:
2323

2424
- **See** data flow step by step through every operator
25-
- **Spot** table scans, expensive sorts, and bad estimates instantly
25+
- **Spot** table scans, expensive sorts, and bad estimates at a glance
2626
- **Fix** problems with ready-to-run index recommendations
2727
- **Compare** before/after plans side by side
2828

@@ -71,6 +71,18 @@ Run a query, optimize it, run it again -- then compare both execution plans side
7171

7272
---
7373

74+
## Limitations
75+
76+
- **Read-only** — LiveSQL never modifies your database. It only retrieves execution plans.
77+
78+
- **Estimated plans only** — for SQL Server, uses `SET STATISTICS XML ON` which requires the query to actually execute. For safe analysis of expensive queries, use estimated plans.
79+
80+
- **No query result display** — this is a plan visualizer, not a query runner.
81+
82+
- **Demo mode uses synthetic data** — the 6 example plans are handcrafted to demonstrate common patterns, not captured from a real database.
83+
84+
---
85+
7486
## Architecture
7587

7688
```
@@ -162,15 +174,15 @@ Tests cover XML/JSON plan parsing, bottleneck detection rules, index recommendat
162174

163175
---
164176

165-
## Born From Production
177+
## Why This Exists
166178

167-
> LiveSQL was built from years of performance tuning SQL queries powering enterprise platforms with millions of rows. The patterns it detects -- missing indexes, estimate skew, unnecessary sorts -- are the same ones that cause real outages and slow dashboards in production systems.
179+
> Built after spending too many hours squinting at SSMS execution plan icons and scrolling through EXPLAIN ANALYZE walls of text. The bottleneck detection rules come from real performance incidents — queries that looked fine until they hit 10M+ row tables and ground dashboards to a halt.
168180
169181
---
170182

171183
## Security
172184

173-
LiveSQL is designed to be **read-only** and safe to point at production databases:
185+
LiveSQL is designed to be **read-only**:
174186

175187
- **Read-only by design.** Uses `SET STATISTICS XML ON` / `EXPLAIN (ANALYZE, FORMAT JSON)` only -- never modifies data or schema
176188
- **Connection strings are never logged.** The connector layer treats connection strings as opaque secrets

0 commit comments

Comments
 (0)