Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tursodatabase/libsql-js
A better-sqlite3 compatible API for libSQL that supports Bun, Deno, and Node
https://github.com/tursodatabase/libsql-js
bun deno javascript libsql nodejs sqlite typescript
Last synced: 6 days ago
JSON representation
A better-sqlite3 compatible API for libSQL that supports Bun, Deno, and Node
- Host: GitHub
- URL: https://github.com/tursodatabase/libsql-js
- Owner: tursodatabase
- License: mit
- Created: 2023-07-18T10:39:21.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-11-15T08:57:32.000Z (27 days ago)
- Last Synced: 2024-12-04T01:37:53.505Z (9 days ago)
- Topics: bun, deno, javascript, libsql, nodejs, sqlite, typescript
- Language: JavaScript
- Homepage:
- Size: 581 KB
- Stars: 208
- Watchers: 7
- Forks: 22
- Open Issues: 29
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-turso - JavaScript/TypeScript SDK (Better-sqlite3 compatible API for libSQL. Supports Bun, Deno, & Node)
README
# libSQL API for JavaScript/TypeScript
[](https://badge.fury.io/js/libsql)
[](https://www.phorm.ai/query?projectId=3c9a471f-4a47-469f-81f6-4ea1ff9ab418)
[libSQL](https://github.com/libsql/libsql) is an open source, open contribution fork of SQLite.
This source repository contains libSQL API bindings for Node, which aims to be compatible with [better-sqlite3](https://github.com/WiseLibs/better-sqlite3/), but with opt-in promise API.
*Please note that there is also the [libSQL SDK](https://github.com/libsql/libsql-client-ts), which is useful if you don't need `better-sqlite3` compatibility or use libSQL in environments like serverless functions that require `fetch()`-based database access protocol.*
## Features
* In-memory and local libSQL/SQLite databases
* Remote libSQL databases
* Embedded, in-app replica that syncs with a remote libSQL database
* Supports Bun, Deno, and Node on macOS, Linux, and Windows.
## Installing
You can install the package with:
**Node:**
```sh
npm i libsql
```
**Bun:**
```sh
bun add libsql
```
**Deno:**
Use the `npm:` prefix for package import:
```typescript
import Database from 'npm:libsql';
```
## Documentation
* [API reference](docs/api.md)
## Getting Started
To try out your first libsql program, type the following in `hello.js`:
```javascript
import Database from 'libsql';
const db = new Database(':memory:');
db.exec("CREATE TABLE users (id INTEGER PRIMARY KEY, name TEXT, email TEXT)");
db.exec("INSERT INTO users (id, name, email) VALUES (1, 'Alice', '[email protected]')");
const row = db.prepare("SELECT * FROM users WHERE id = ?").get(1);
console.log(`Name: ${row.name}, email: ${row.email}`);
```
and then run:
```shell
$ node hello.js
```
To use the promise API, import `libsql/promise`:
```javascript
import Database from 'libsql/promise';
const db = new Database(':memory:');
await db.exec("CREATE TABLE users (id INTEGER PRIMARY KEY, name TEXT, email TEXT)");
await db.exec("INSERT INTO users (id, name, email) VALUES (1, 'Alice', '[email protected]')");
const stmt = await db.prepare("SELECT * FROM users WHERE id = ?");
const row = stmt.get(1);
console.log(`Name: ${row.name}, email: ${row.email}`);
```
#### Connecting to a local database file
```javascript
import Database from 'libsql';
const db = new Database('hello.db');
````
#### Connecting to a Remote libSQL server
```javascript
import Database from 'libsql';
const url = process.env.LIBSQL_URL;
const authToken = process.env.LIBSQL_AUTH_TOKEN;
const opts = {
authToken: authToken,
};
const db = new Database(url, opts);
```
#### Creating an in-app replica and syncing it
```javascript
import libsql
const opts = { syncUrl: "", authToken: "" };
const db = new Database('hello.db', opts);
db.sync();
```
#### Creating a table
```javascript
db.exec("CREATE TABLE users (id INTEGER, email TEXT);")
```
#### Inserting rows into a table
```javascript
db.exec("INSERT INTO users VALUES (1, '[email protected]')")
```
#### Querying rows from a table
```javascript
const row = db.prepare("SELECT * FROM users WHERE id = ?").get(1);
```
## Developing
To build the `libsql` package, run:
```console
LIBSQL_JS_DEV=1 npm run build
```
You can then run the integration tests with:
```console
export LIBSQL_JS_DEV=1
npm link
cd integration-tests
npm link libsql
npm test
```
## License
This project is licensed under the [MIT license].
### Contribution
Unless you explicitly state otherwise, any contribution intentionally submitted
for inclusion in libSQL by you, shall be licensed as MIT, without any additional
terms or conditions.
[MIT license]: https://github.com/libsql/libsql-node/blob/main/LICENSE