Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 23 additions & 0 deletions packages/plugins/driver-turso/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,29 @@ TursoDriver extends SqlDriver (dual transport)
pnpm add @objectstack/driver-turso
```

### Dependencies by Mode

The `driver-turso` package has different dependency requirements based on the connection mode:

| Mode | Required Dependencies | Notes |
|:---|:---|:---|
| **Remote** | `@libsql/client` only | ✅ Vercel/Edge compatible — no native dependencies |
| **Local** | `@libsql/client` + `better-sqlite3` | Requires `better-sqlite3` for local SQLite access |
| **Replica** | `@libsql/client` + `better-sqlite3` | Requires `better-sqlite3` for local SQLite + sync |

**For Vercel/Edge deployments (remote mode only):**
```bash
pnpm add @objectstack/driver-turso
# better-sqlite3 is NOT required
```

**For local/replica modes:**
```bash
pnpm add @objectstack/driver-turso better-sqlite3
```

The `better-sqlite3` package is an **optional peer dependency**. If you're only using remote mode (e.g., on Vercel), you don't need to install it. npm/pnpm will show a warning that can be safely ignored.

## Connection Modes

### Local File (Embedded SQLite)
Expand Down
10 changes: 9 additions & 1 deletion packages/plugins/driver-turso/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -33,11 +33,19 @@
"@objectstack/core": "workspace:*",
"@objectstack/driver-sql": "workspace:*",
"@objectstack/spec": "workspace:*",
"better-sqlite3": "^12.9.0",
"nanoid": "^5.1.7"
},
"peerDependencies": {
"better-sqlite3": "^12.9.0"
},
"peerDependenciesMeta": {
"better-sqlite3": {
"optional": true
}
},
"devDependencies": {
"@types/node": "^25.6.0",
"better-sqlite3": "^12.9.0",
"typescript": "^6.0.2",
"vitest": "^4.1.4"
}
Expand Down
6 changes: 3 additions & 3 deletions pnpm-lock.yaml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading