This folder holds the prime (canonical) reference for each database provider in LibreDB Studio.
There is exactly one document per provider, named by the provider's canonical type-id and kept
in lockstep with the code (see the tri-sync rule in ../../CLAUDE.md).
| Provider | type-id | Family | Driver | Query language | Reference |
|---|---|---|---|---|---|
| PostgreSQL | postgres |
SQL | pg |
SQL | postgres.md |
| MySQL | mysql |
SQL | mysql2 |
SQL | mysql.md |
| Oracle | oracle |
SQL | oracledb (Thin) |
SQL | oracle.md |
| Microsoft SQL Server | mssql |
SQL | mssql |
SQL (T-SQL) | mssql.md |
| SQLite | sqlite |
SQL (embedded) | bun:sqlite (Bun) / node:sqlite (Node) |
SQL | sqlite.md |
| Redis | redis |
Key-Value | ioredis |
JSON | redis.md |
| MongoDB | mongodb |
Document | mongodb |
JSON (MQL) | mongodb.md |
| LibreDB | libredb |
Embedded (Key-Value) | @libredb/libredb |
JSON (command grammar) | libredb.md |
- Filename = canonical type-id (
postgres.md,mssql.md, …), mirroring the source file (src/lib/db/providers/<family>/<type-id>.ts). The official product name (e.g. "SQL Server") is used only in each doc's title and prose. - Each doc mirrors the code. Every
file:linecitation is verified, and the per-provider triad — code, this doc, andtests/integration/db/<type-id>-provider.test.ts— must stay in sync in the same PR (the provider tri-sync invariant). - Each doc follows the same ~15-section shape: Overview → Architecture → Design decisions → Connection → Query interface → Schema → Monitoring → Maintenance → Capabilities & labels → Error handling → Testing → Usage → Known limitations → References.
- Provider architecture & how to add a new provider:
../DATABASE_PROVIDERS.md— the Strategy-Pattern architecture, the provider hierarchy, the shared interface/base classes, and a step-by-step guide to adding a new database type. - HTTP API contract (request/response for
/api/db/query, schema, maintenance, …):../API_DOCS.md.