sql-query-copilot

# SQL Query Copilot

## Overview

Use this skill to turn plain-language requests into executable SQL with a predictable, low-risk workflow.
Default to read-only execution and validate every query against schema before running.

## Quick Start

Set `SQL_DSN` first (or pass `--dsn` each time).

```bash
# PowerShell
$env:SQL_DSN="mysql://user:password@127.0.0.1:3306/stock_monitor"
$env:SQL_DSN="postgres://user:password@127.0.0.1:5432/stock_monitor"
$env:SQL_DSN="sqlite:///d:/data/demo.db"

# Windows CMD
set SQL_DSN=mysql://user:password@127.0.0.1:3306/stock_monitor
set SQL_DSN=postgres://user:password@127.0.0.1:5432/stock_monitor
set SQL_DSN=sqlite:///d:/data/demo.db

# Bash / Zsh
export SQL_DSN="mysql://user:password@127.0.0.1:3306/stock_monitor"
export SQL_DSN="postgres://user:password@127.0.0.1:5432/stock_monitor"
export SQL_DSN="sqlite:///d:/data/demo.db"
```

Core commands:

```bash
python scripts/sql_easy.py tables
python scripts/sql_easy.py describe daily_kline
python scripts/sql_easy.py lint --sql "SELECT * FROM daily_kline"
python scripts/sql_easy.py explain --sql "SELECT code, close FROM daily_kline WHERE trade_date >= '2026-01-01'"
python scripts/sql_easy.py query --sql "SELECT code, close FROM daily_kline ORDER BY trade_date DESC" --limit 50
python scripts/sql_easy.py query --sql "SELECT code, close FROM daily_kline" --summary
python scripts/sql_easy.py ask --q "show symbols with old sell signals older than 20 days" --summary
python scripts/sql_easy.py profile
```

Set `OPENAI_API_KEY` (or pass `--api-key`) to use `ask`.

## v0.2 Highlights

- Multi-engine support: MySQL, PostgreSQL, SQLite.
- SQL lint engine: catches high-risk patterns before execution.
- Explain mode: quickly inspect query plan (`EXPLAIN` / `EXPLAIN QUERY PLAN`).
- Natural-language mode: `ask` generates SQL from user intent.
- Query summary: auto profile returned columns (null ratio, distinct count, min/max/avg).
- Slow query warning: highlights expensive queries using `--slow-ms`.
- Audi...