File size: 14,788 Bytes
2f0a742 7c63b3a 2f0a742 d645205 3b23d1d 2f0a742 3b23d1d d645205 3b23d1d d645205 2f0a742 | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 | """DB schema introspection — SQLite and PostgreSQL."""
from __future__ import annotations
import re
from dataclasses import dataclass, field
from typing import Any
import aiosqlite
@dataclass
class ColumnInfo:
name: str
type: str
not_null: bool
pk: bool
@dataclass
class TableSchema:
name: str
columns: list[ColumnInfo]
sample_rows: list[dict]
row_count: int
foreign_keys: list[dict]
@dataclass
class DBSchema:
tables: dict[str, TableSchema]
db_type: str # "sqlite" | "postgresql"
async def load_sqlite_schema(db_path: str) -> DBSchema:
tables: dict[str, TableSchema] = {}
async with aiosqlite.connect(db_path) as db:
db.row_factory = aiosqlite.Row
async with db.execute(
"SELECT name FROM sqlite_master WHERE type='table' ORDER BY name"
) as cur:
table_names = [row[0] for row in await cur.fetchall()]
for tname in table_names:
async with db.execute(f"PRAGMA table_info(\"{tname}\")") as cur:
cols_raw = await cur.fetchall()
columns = [
ColumnInfo(
name=r["name"], type=r["type"],
not_null=bool(r["notnull"]), pk=bool(r["pk"]),
)
for r in cols_raw
]
async with db.execute(f"PRAGMA foreign_key_list(\"{tname}\")") as cur:
fks_raw = await cur.fetchall()
fks = [
{"from_col": r["from"], "to_table": r["table"], "to_col": r["to"]}
for r in fks_raw
]
async with db.execute(f"SELECT COUNT(*) FROM \"{tname}\"") as cur:
row_count = (await cur.fetchone())[0]
async with db.execute(f"SELECT * FROM \"{tname}\" LIMIT 3") as cur:
sample = [dict(r) for r in await cur.fetchall()]
tables[tname] = TableSchema(
name=tname, columns=columns,
sample_rows=sample, row_count=row_count, foreign_keys=fks,
)
return DBSchema(tables=tables, db_type="sqlite")
async def load_mysql_schema(conn_str: str) -> DBSchema:
import asyncmy
from urllib.parse import urlparse
p = urlparse(conn_str)
params = {
"host": p.hostname or "localhost",
"port": p.port or 3306,
"user": p.username or "",
"password": p.password or "",
"db": (p.path or "").lstrip("/"),
}
conn = await asyncmy.connect(**params)
tables: dict[str, TableSchema] = {}
try:
async with conn.cursor() as cur:
await cur.execute(
"SELECT table_name FROM information_schema.tables "
"WHERE table_schema = DATABASE() ORDER BY table_name"
)
table_names = [r[0] for r in await cur.fetchall()]
for tname in table_names:
async with conn.cursor() as cur:
await cur.execute(
"SELECT column_name, data_type, is_nullable, column_key "
"FROM information_schema.columns "
"WHERE table_schema = DATABASE() AND table_name = %s "
"ORDER BY ordinal_position",
(tname,),
)
columns = [
ColumnInfo(name=r[0], type=r[1], not_null=(r[2] == "NO"), pk=(r[3] == "PRI"))
for r in await cur.fetchall()
]
await cur.execute(
"SELECT kcu.column_name, kcu.referenced_table_name, kcu.referenced_column_name "
"FROM information_schema.key_column_usage kcu "
"JOIN information_schema.referential_constraints rc "
" ON kcu.constraint_name = rc.constraint_name "
"WHERE kcu.table_schema = DATABASE() AND kcu.table_name = %s",
(tname,),
)
fks = [
{"from_col": r[0], "to_table": r[1], "to_col": r[2]}
for r in await cur.fetchall() if r[1]
]
await cur.execute(f"SELECT COUNT(*) FROM `{tname}`")
row_count = (await cur.fetchone())[0]
await cur.execute(f"SELECT * FROM `{tname}` LIMIT 3")
raw = await cur.fetchall()
col_names = [d[0] for d in cur.description]
sample = [dict(zip(col_names, r)) for r in raw]
tables[tname] = TableSchema(
name=tname, columns=columns,
sample_rows=sample, row_count=row_count, foreign_keys=fks,
)
finally:
conn.close()
return DBSchema(tables=tables, db_type="mysql")
async def load_duckdb_schema(db_path: str) -> DBSchema:
import asyncio
from pathlib import Path as _Path
def _load() -> DBSchema:
import duckdb
ext = _Path(db_path).suffix.lower()
if ext == ".duckdb":
con = duckdb.connect(db_path, read_only=True)
else:
con = duckdb.connect()
if ext == ".parquet":
con.execute(f"CREATE VIEW data AS SELECT * FROM read_parquet('{db_path}')")
elif ext == ".csv":
con.execute(f"CREATE VIEW data AS SELECT * FROM read_csv_auto('{db_path}')")
table_names = [r[0] for r in con.execute("SHOW TABLES").fetchall()]
tables: dict[str, TableSchema] = {}
for tname in table_names:
cols_raw = con.execute(
"SELECT column_name, data_type, is_nullable FROM information_schema.columns "
f"WHERE table_name = '{tname}' ORDER BY ordinal_position"
).fetchall()
columns = [
ColumnInfo(name=r[0], type=r[1], not_null=(r[2] == "NO"), pk=False)
for r in cols_raw
]
try:
row_count = con.execute(f'SELECT COUNT(*) FROM "{tname}"').fetchone()[0]
except Exception:
row_count = 0
try:
sample_df = con.execute(f'SELECT * FROM "{tname}" LIMIT 3').fetchdf()
sample = sample_df.to_dict(orient="records")
except Exception:
sample = []
tables[tname] = TableSchema(
name=tname, columns=columns,
sample_rows=sample, row_count=row_count, foreign_keys=[],
)
con.close()
return DBSchema(tables=tables, db_type="duckdb")
return await asyncio.to_thread(_load)
async def load_pg_schema(conn_str: str) -> DBSchema:
import asyncpg
tables: dict[str, TableSchema] = {}
conn = await asyncpg.connect(conn_str)
try:
table_names = await conn.fetch(
"SELECT table_name FROM information_schema.tables "
"WHERE table_schema = 'public' ORDER BY table_name"
)
for rec in table_names:
tname = rec["table_name"]
cols_raw = await conn.fetch(
"SELECT column_name, data_type, is_nullable "
"FROM information_schema.columns "
"WHERE table_schema='public' AND table_name=$1 ORDER BY ordinal_position",
tname,
)
columns = [
ColumnInfo(
name=r["column_name"], type=r["data_type"],
not_null=(r["is_nullable"] == "NO"), pk=False,
)
for r in cols_raw
]
pk_rows = await conn.fetch(
"SELECT kcu.column_name FROM information_schema.table_constraints tc "
"JOIN information_schema.key_column_usage kcu "
" ON tc.constraint_name=kcu.constraint_name "
"WHERE tc.constraint_type='PRIMARY KEY' AND tc.table_name=$1",
tname,
)
pk_cols = {r["column_name"] for r in pk_rows}
for c in columns:
if c.name in pk_cols:
c.pk = True
fk_rows = await conn.fetch(
"SELECT kcu.column_name, ccu.table_name AS ft, ccu.column_name AS fc "
"FROM information_schema.table_constraints tc "
"JOIN information_schema.key_column_usage kcu "
" ON tc.constraint_name=kcu.constraint_name "
"JOIN information_schema.constraint_column_usage ccu "
" ON tc.constraint_name=ccu.constraint_name "
"WHERE tc.constraint_type='FOREIGN KEY' AND tc.table_name=$1",
tname,
)
fks = [
{"from_col": r["column_name"], "to_table": r["ft"], "to_col": r["fc"]}
for r in fk_rows
]
count = await conn.fetchval(f'SELECT COUNT(*) FROM "{tname}"')
sample_raw = await conn.fetch(f'SELECT * FROM "{tname}" LIMIT 3')
sample = [dict(r) for r in sample_raw]
tables[tname] = TableSchema(
name=tname, columns=columns,
sample_rows=sample, row_count=count, foreign_keys=fks,
)
finally:
await conn.close()
return DBSchema(tables=tables, db_type="postgresql")
def _tokenize(text: str) -> set[str]:
return set(re.sub(r"[^a-z0-9 ]", " ", text.lower()).split())
_STOPWORDS = {"the","a","an","is","in","of","for","to","and","or","by","all",
"what","which","how","many","show","me","get","list","find","give",
"with","from","per","each","top","average","total","count","number"}
def link_tables(schema: DBSchema, question: str, top_k: int = 6) -> list[str]:
"""Score tables by keyword overlap with question, expand via FK relationships.
Scoring:
+3 per question word matching the table name
+2 per question word matching a column name
+1 per question word matching a sample cell value
After picking top_k, add every directly FK-linked table so JOINs work.
"""
q_words = _tokenize(question) - _STOPWORDS
if not q_words:
return list(schema.tables.keys())
scores: dict[str, float] = {}
for tname, t in schema.tables.items():
score = 0.0
score += 3 * len(q_words & _tokenize(tname))
for col in t.columns:
score += 2 * len(q_words & _tokenize(col.name))
for row in t.sample_rows:
for val in row.values():
if val is not None:
score += len(q_words & _tokenize(str(val)))
scores[tname] = score
ranked = sorted(scores, key=lambda n: scores[n], reverse=True)
selected = set(ranked[:top_k])
# FK expansion: include tables directly linked to any selected table
for tname in list(selected):
for fk in schema.tables[tname].foreign_keys:
selected.add(fk["to_table"])
for other, t in schema.tables.items():
if any(fk["to_table"] == tname for fk in t.foreign_keys):
selected.add(other)
return [n for n in ranked if n in selected] + [
n for n in schema.tables if n in selected and n not in ranked[:top_k]
]
_RAG_THRESHOLD = 20 # use BM25 for DBs larger than this
def _table_doc(t: TableSchema) -> list[str]:
"""Tokenize a table into a BM25 document (name + columns + sample values)."""
tokens = list(_tokenize(t.name))
for col in t.columns:
tokens.extend(_tokenize(col.name))
for row in t.sample_rows:
for val in row.values():
if val is not None:
tokens.extend(_tokenize(str(val)))
return tokens or ["__empty__"]
def schema_rag_retrieve(schema: DBSchema, question: str, top_k: int = 8) -> list[str]:
"""BM25 retrieval for large schemas (>20 tables) — returns table names ranked by relevance.
Builds a BM25 index over table documents (name + columns + sample values), scores
each table against the question tokens, then expands via FK relationships so JOINs work.
"""
from rank_bm25 import BM25Okapi
table_names = list(schema.tables.keys())
corpus = [_table_doc(schema.tables[n]) for n in table_names]
bm25 = BM25Okapi(corpus)
q_tokens = list((_tokenize(question) - _STOPWORDS) or _tokenize(question))
scores = bm25.get_scores(q_tokens)
ranked_idx = sorted(range(len(table_names)), key=lambda i: scores[i], reverse=True)
ranked = [table_names[i] for i in ranked_idx]
selected = set(ranked[:top_k])
for tname in list(selected):
for fk in schema.tables[tname].foreign_keys:
selected.add(fk["to_table"])
for other, t in schema.tables.items():
if any(fk["to_table"] == tname for fk in t.foreign_keys):
selected.add(other)
return [n for n in ranked if n in selected] + [
n for n in schema.tables if n in selected and n not in ranked[:top_k]
]
def schema_to_prompt_text(schema: DBSchema, question: str = "", max_tables: int = 30) -> str:
"""Compact schema text for LLM prompt; links relevant tables when question given.
Small DBs (≤20 tables): keyword overlap scoring via link_tables().
Large DBs (>20 tables): BM25 retrieval via schema_rag_retrieve().
"""
if question:
if len(schema.tables) > _RAG_THRESHOLD:
linked = schema_rag_retrieve(schema, question, top_k=min(8, len(schema.tables)))
else:
linked = link_tables(schema, question, top_k=min(6, len(schema.tables)))
tables = [schema.tables[n] for n in linked if n in schema.tables]
else:
tables = list(schema.tables.values())[:max_tables]
lines: list[str] = [f"Database type: {schema.db_type}, total tables: {len(schema.tables)}\n"]
for t in tables:
lines.append(f"Table: {t.name} ({t.row_count:,} rows)")
for c in t.columns:
flags = " [PK]" if c.pk else ""
lines.append(f" {c.name} {c.type}{flags}")
for fk in t.foreign_keys:
lines.append(f" FK: {fk['from_col']} → {fk['to_table']}.{fk['to_col']}")
if t.sample_rows:
first = t.sample_rows[0]
preview = {k: v for k, v in list(first.items())[:5]}
lines.append(f" -- sample: {preview}")
lines.append("")
return "\n".join(lines)
def schema_to_dict(schema: DBSchema) -> dict:
return {
"db_type": schema.db_type,
"table_count": len(schema.tables),
"tables": {
tname: {
"columns": [
{"name": c.name, "type": c.type, "pk": c.pk, "not_null": c.not_null}
for c in t.columns
],
"row_count": t.row_count,
"foreign_keys": t.foreign_keys,
}
for tname, t in schema.tables.items()
},
} |