Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions .env.example
Original file line number Diff line number Diff line change
Expand Up @@ -136,6 +136,15 @@ EMBEDDING_FAIL_OPEN=false
#DEEPSQL_SKIP_AGENT_SETUP=0
#DEEPSQL_SMOKE_AGENT=1

# ── Demo Data Seeding ───────────────────────────────────────────────────────
# Seed a ready-to-explore demo database with sample e-commerce data, users,
# saved queries, slow query history, and index recommendations.
# Set to 1 to automatically run seed-demo-data.sh during install.
# Can also be run manually: ./scripts/self-host/seed-demo-data.sh
#DEEPSQL_SEED_DEMO_DATA=0
#DEEPSQL_SEED_CONNECTION_NAME=Demo Shop (E-commerce)
#DEEPSQL_SEED_SKIP_DEMO_DB=0

# ── The /api/llm/v1 agent gateway ───────────────────────────────────────────
# The DeepSQL CLI agent (`@deepsql/mcp`) points its model at <backend>/api/llm/v1
# and authenticates with a DeepSQL token; the backend forwards those calls
Expand Down
18 changes: 18 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -249,10 +249,28 @@ your schema — all from one shared brain.
```bash
./scripts/self-host/status.sh # compose ps + health probes
./scripts/self-host/smoke-test.sh # end-to-end check against the vault DB
./scripts/self-host/seed-demo-data.sh # seed demo e-commerce database for exploration
./scripts/self-host/uninstall.sh # stop and remove containers, keep data
./scripts/self-host/uninstall.sh --purge-data # also drop the volumes
```

### Demo Database

To explore DeepSQL features without connecting your own database, run:

```bash
./scripts/self-host/seed-demo-data.sh
```

This creates a **demo_shop** e-commerce database with:
- 100 products, 500 customers, 5,000+ orders
- Intentionally suboptimal query patterns (to trigger recommendations)
- Pre-configured slow query analysis and index recommendations
- Sample saved queries in the SQL Editor
- Sample agent conversation history

Alternatively, set `DEEPSQL_SEED_DEMO_DATA=1` in `.env` before running `install.sh` to seed automatically.

Upgrading:

```bash
Expand Down
Loading
Loading