Skip to content

Commit 4c108e8

Browse files
authored
feat: add @libsql/client as a replacement for sqlite3 (#837)
1 parent 890517a commit 4c108e8

2 files changed

Lines changed: 23 additions & 1 deletion

File tree

docs/modules/sqlite3.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,3 +37,20 @@ const db = new Database('app.db') // [!code ++]
3737
db.all('SELECT * FROM users', (err, rows) => {}) // [!code --]
3838
const rows = db.prepare('SELECT * FROM users').all() // [!code ++]
3939
```
40+
41+
## `@libsql/client`
42+
43+
[`@libsql/client`](https://github.com/tursodatabase/libsql-client-ts) is a modern, promise-based client that is fully compatible with SQLite. It supports local SQLite files, remote LibSQL servers, and Turso databases, making it easy to transition to the edge in the future.
44+
45+
Example:
46+
47+
```ts
48+
import sqlite3 from 'sqlite3' // [!code --]
49+
import { createClient } from '@libsql/client' // [!code ++]
50+
51+
const db = new sqlite3.Database('app.db') // [!code --]
52+
const db = createClient({ url: 'file:app.db' }) // [!code ++]
53+
54+
db.all('SELECT * FROM users', (err, rows) => {}) // [!code --]
55+
const { rows } = await db.execute('SELECT * FROM users') // [!code ++]
56+
```

manifests/preferred.json

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2593,7 +2593,7 @@
25932593
"sqlite3": {
25942594
"type": "module",
25952595
"moduleName": "sqlite3",
2596-
"replacements": ["node:sqlite", "better-sqlite3"],
2596+
"replacements": ["node:sqlite", "better-sqlite3", "@libsql/client"],
25972597
"url": {"type": "e18e", "id": "sqlite3"}
25982598
},
25992599
"stream-buffers": {
@@ -2824,6 +2824,11 @@
28242824
"type": "documented",
28252825
"replacementModule": "@fastify/deepmerge"
28262826
},
2827+
"@libsql/client": {
2828+
"id": "@libsql/client",
2829+
"type": "documented",
2830+
"replacementModule": "@libsql/client"
2831+
},
28272832
"@material/web": {
28282833
"id": "@material/web",
28292834
"type": "documented",

0 commit comments

Comments
 (0)