docs(ormin): clarify transaction and returning support
CI / test (push) Has been cancelled
CI / verify (push) Has been cancelled
Clients CI / build-server (push) Has been cancelled
Clients CI / test-python (push) Has been cancelled
Clients CI / test-javascript (push) Has been cancelled
Clients CI / test-nim (push) Has been cancelled
Clients CI / test-rust (push) Has been cancelled

- Top-level BEGIN/COMMIT/ROLLBACK work (server-side)
- SAVEPOINT (nested tx) does not work — BaraDB server limitation
- RETURNING parsed but ignored by BaraDB executor — server limitation
This commit is contained in:
2026-05-15 22:56:45 +03:00
parent 4ac147dc6c
commit 406dcf4f4e
+15 -3
View File
@@ -112,15 +112,27 @@ If you omit the port, the default `9472` is used.
| `query(T)` typed | ✅ | | `query(T)` typed | ✅ |
| `createProc` | ✅ | | `createProc` | ✅ |
| `createIter` | ✅ | | `createIter` | ✅ |
| `transaction` | ⚠️ (relies on server support) | | `transaction` | ✅ (top-level only) |
| `returning` | ⚠️ (single-row limit works) | | `returning` | ❌ (not yet supported by BaraDB server) |
## Limitations ## Limitations
- **Wire protocol strings**: BaraDB returns all column values as strings over the wire. The backend parses them at runtime. This is slightly less efficient than native SQLite/PostgreSQL bindings but keeps the implementation simple and portable. - **Wire protocol strings**: BaraDB returns all column values as strings over the wire. The backend parses them at runtime. This is slightly less efficient than native SQLite/PostgreSQL bindings but keeps the implementation simple and portable.
- **`getLastId`**: Currently returns `0`. If BaraDB supports `RETURNING id`, use `limit 1` queries instead. - **`getLastId` / `RETURNING`**: BaraDB's SQL parser recognizes `RETURNING`, but the executor ignores it — the result is always just the affected-row count. For now, use a `limit 1` `select` after `insert` to fetch the new row.
- **Nested transactions (SAVEPOINT)**: Not supported by BaraDB. Top-level `BEGIN` / `COMMIT` / `ROLLBACK` work fine, but nested `transaction:` blocks (which Ormin implements via `SAVEPOINT`) will fail.
- **Async**: Ormin's DSL is synchronous by design. This backend uses `SyncClient` under the hood. If you need async, use the raw `baradb/client` async API directly. - **Async**: Ormin's DSL is synchronous by design. This backend uses `SyncClient` under the hood. If you need async, use the raw `baradb/client` async API directly.
## Why some features are missing
These are **server-side limitations**, not client bugs:
| Feature | Status in BaraDB server | Needed for |
|---------|------------------------|------------|
| `SAVEPOINT` | Not implemented | Nested `transaction:` blocks |
| `RETURNING` | Parsed but ignored by executor | `insert ... returning id` |
If you need these, open an issue on the [BaraDB server repo](https://git.invoicing.top/baraba/Baradb) — the fixes belong in `src/barabadb/query/executor.nim` and `src/barabadb/query/parser.nim`.
## Running the example ## Running the example
```bash ```bash