Docs / Clients
libSQL clients and ORMs
A libSQL-compatible HTTP endpoint, and the ORMs that come with it, are planned for v1. They are not available today.
Coming View Markdown
# libSQL clients and ORMs
> Status: Coming. A libSQL-compatible HTTP endpoint, and the ORMs that come with it, are planned for v1. They are not available today.
> **Coming.** Gauntlet's [HTTP API](https://gauntlet-db.stavros.xyz/docs/clients/http.md) is its own JSON shape. A libSQL SDK pointed at a Gauntlet node will not work today.
## What is planned
| Item | Plan | What it will add |
|---|---|---|
| libSQL-compatible HTTP endpoint | P10.2 | A route to the existing libSQL client and ORM ecosystem, in the dialect Gauntlet already speaks |
| Certified client and ORM list | P10.8 | One page of what works, what is partial and what is refused, per combination |
| SDK helpers | P10.7 | Retry on `40001` and outcome lookup on `40003`, which no stock driver does |
## Why libSQL and not PostgreSQL
Gauntlet's SQL is the SQLite family. The libSQL protocol carries that dialect, so tools built for it send SQL Gauntlet can run. Promising PostgreSQL compatibility would mean PostgreSQL types, `pg_catalog` and a second SQL dialect; that is not planned for v1. PostgreSQL wire stays a transport.
## Until then
- Use a PostgreSQL driver with hand-written SQL: [PostgreSQL wire](https://gauntlet-db.stavros.xyz/docs/clients/pgwire.md).
- From an edge runtime that has only `fetch`, call the [HTTP API](https://gauntlet-db.stavros.xyz/docs/clients/http.md) directly.
---
Source: https://gauntlet-db.stavros.xyz/docs/clients/libsql
Connect this project to my existing Gauntlet database.
Context:
- Documentation index for agents: https://gauntlet-db.stavros.xyz/llms.txt
- Quickstart: https://gauntlet-db.stavros.xyz/docs/quickstart.md
- SQL compatibility and error codes: https://gauntlet-db.stavros.xyz/docs/sql/compatibility.md
- Database: the one already configured for this project
- Protocol: PostgreSQL wire or the native HTTP JSON API, whichever this project already uses
- Connection values are in environment variables: GAUNTLET_DATABASE_URL (PostgreSQL wire),
GAUNTLET_HTTP_URL (HTTP base URL) and GAUNTLET_DATABASE_TOKEN (the database token).
These names are a convention, not a shipped SDK setting. Keep this project's own names if it has them.
Before editing, read the Gauntlet documentation above and inspect how this project
already talks to its database. Gauntlet is pre-beta software; where the documentation
and my deployment disagree, tell me instead of guessing.
What Gauntlet is:
- A distributed SQL database. SQL is the SQLite family, run by the Turso engine.
- The PostgreSQL wire protocol is a transport only. There is no PostgreSQL SQL dialect,
no pg_catalog or information_schema, no extensions, and no ORM is certified yet.
- libSQL client compatibility is not available yet. Do not assume it.
Connecting:
- PostgreSQL wire: dbname is the database name, the user name is ignored, and the
password is the database token. Authentication is SCRAM-SHA-256. Keep TLS
verification on (sslmode=verify-full with the deployment's CA certificate).
- HTTP: POST <GAUNTLET_HTTP_URL>/db/<name>/sql with a JSON body
{"sql": "...", "params": [...]} and the header "Authorization: Bearer <token>".
POST /db/<name>/tx runs a list of statements atomically.
SQL rules that differ from PostgreSQL:
- Every table needs an explicit primary key, and INSERT supplies the key value.
- CREATE TABLE is a standalone statement outside a transaction. There is no ALTER TABLE,
DROP TABLE or CREATE INDEX; an index comes only from a UNIQUE constraint at creation.
- Parameters are $1, ?1 or ?. Names are single-part (no schema.table).
- Column types follow SQLite affinity. In prepared statements ordinary columns are
described as text; CAST(x AS INTEGER) when the driver needs a number.
Errors you must handle (SQLSTATE):
- 40001: conflict. Roll back and retry the whole transaction. Locking is no-wait, so
this is normal under contention.
- 40003: commit outcome unknown. Do NOT retry. Look the transaction up with
GET /db/<name>/txn/<txid> and replay only if the status is `aborted`.
- 57P03: cannot serve right now. Roll back, then retry the whole transaction with backoff.
- 53300: too many connections. Back off; keep the pool below the node's limit.
Credentials and scope:
- Use only the database token for this one database. Keep it server-side and out of
source, logs, browser bundles and this conversation.
- Never use or ask for a deployment admin token, a client token or bucket credentials.
- Do not create, drop, back up, restore or branch databases, and do not rotate credentials.
Task:
1. Add the smallest connection integration that fits this project.
2. Run one explicit `SELECT 1` connectivity check. It may activate this database if it
is idle; do not probe or wake any other database.
3. Do not change the schema or write application data unless I ask for it.
Report the files changed, the protocol and client used, the result of the check, and
anything this project needs that Gauntlet does not support.Coming. Gauntlet's HTTP API is its own JSON shape. A libSQL SDK pointed at a Gauntlet node will not work today.
#What is planned
| Item | Plan | What it will add |
|---|---|---|
| libSQL-compatible HTTP endpoint | P10.2 | A route to the existing libSQL client and ORM ecosystem, in the dialect Gauntlet already speaks |
| Certified client and ORM list | P10.8 | One page of what works, what is partial and what is refused, per combination |
| SDK helpers | P10.7 | Retry on 40001 and outcome lookup on 40003, which no stock driver does |
#Why libSQL and not PostgreSQL
Gauntlet's SQL is the SQLite family. The libSQL protocol carries that dialect, so tools built for it send SQL Gauntlet can run. Promising PostgreSQL compatibility would mean PostgreSQL types, pg_catalog and a second SQL dialect; that is not planned for v1. PostgreSQL wire stays a transport.
#Until then
- Use a PostgreSQL driver with hand-written SQL: PostgreSQL wire.
- From an edge runtime that has only
fetch, call the HTTP API directly.