mirror of
https://github.com/aljazceru/turso.git
synced 2026-01-06 17:54:20 +01:00
7765bafb13
This package is for serverless access to the Turso Cloud using SQL over HTTP protocol. The purpose of this package is to provide the same interface as `@tursodatabase/turso`, but for serverless environments that cannot host the database engine. The package also provides a `@libsql/client` compatibility layer in the `@tursodatabase/serverless/compat` module for drop-in replacement for existing clients.
79 lines
1.9 KiB
Markdown
79 lines
1.9 KiB
Markdown
# Turso serverless JavaScript driver
|
|
|
|
A serverless database driver for Turso Cloud, using only `fetch()`. Connect to your database from serverless and edge functions, such as Cloudflare Workers and Vercel.
|
|
|
|
> [!NOTE]
|
|
> This driver is experimental and, therefore, subject to change at any time.
|
|
|
|
## Installation
|
|
|
|
```bash
|
|
npm install @tursodatabase/serverless
|
|
```
|
|
|
|
## Usage
|
|
|
|
```javascript
|
|
import { connect } from "@tursodatabase/serverless";
|
|
|
|
const conn = connect({
|
|
url: process.env.TURSO_DATABASE_URL,
|
|
authToken: process.env.TURSO_AUTH_TOKEN,
|
|
});
|
|
|
|
// Prepare a statement
|
|
const stmt = conn.prepare("SELECT * FROM users WHERE id = ?");
|
|
|
|
// Get first row
|
|
const row = await stmt.get([123]);
|
|
console.log(row);
|
|
|
|
// Get all rows
|
|
const rows = await stmt.all([123]);
|
|
console.log(rows);
|
|
|
|
// Iterate through rows (streaming)
|
|
for await (const row of stmt.iterate([123])) {
|
|
console.log(row);
|
|
}
|
|
|
|
// Execute multiple statements in a batch
|
|
await conn.batch([
|
|
"CREATE TABLE IF NOT EXISTS users (id INTEGER PRIMARY KEY, email TEXT)",
|
|
"INSERT INTO users (email) VALUES ('user@example.com')",
|
|
"INSERT INTO users (email) VALUES ('admin@example.com')",
|
|
]);
|
|
```
|
|
|
|
### Compatibility layer for libSQL API
|
|
|
|
This driver supports the libSQL API as a compatibility layer.
|
|
|
|
```javascript
|
|
import { createClient } from "@tursodatabase/serverless/compat";
|
|
|
|
const client = createClient({
|
|
url: process.env.TURSO_DATABASE_URL,
|
|
authToken: process.env.TURSO_AUTH_TOKEN,
|
|
});
|
|
|
|
// Execute a single SQL statement
|
|
const result = await client.execute("SELECT * FROM users WHERE id = ?", [123]);
|
|
console.log(result.rows);
|
|
|
|
// Execute multiple statements in a batch
|
|
await client.batch([
|
|
"CREATE TABLE IF NOT EXISTS users (id INTEGER PRIMARY KEY, email TEXT)",
|
|
"INSERT INTO users (email) VALUES ('user@example.com')",
|
|
"INSERT INTO users (email) VALUES ('admin@example.com')",
|
|
]);
|
|
```
|
|
|
|
## Examples
|
|
|
|
Check out the `examples/` directory for complete usage examples.
|
|
|
|
## License
|
|
|
|
MIT
|