Skip to content

Navigation Menu

Sign in
Sign up

Repository files navigation

kysely-libsql

A Kysely dialect for libSQL, compatible with @libsql/client.

Installation

npm install @libsql/kysely-libsql

Usage

Pass a LibsqlDialect instance as the dialect when creating the Kysely object:

import { Kysely } from "kysely";
import { LibsqlDialect } from "@libsql/kysely-libsql";
interface Database {
 ...
}
const db = new Kysely<Database>({
 dialect: new LibsqlDialect({
 url: "libsql://localhost:8080?tls=0",
 authToken: "<token>", // optional
 }),
});

Instead of a url, you can also pass an existing Client from @libsql/client:

import { createClient } from "@libsql/client";
const client = createClient({
 url: "libsql://localhost:8080",
});
const db = new Kysely<Database>({
 dialect: new LibsqlDialect({ client }),
});
// after you are done with the `db`, you must close the `client`:
client.close();

Supported Configuration Options

The library accepts the exact same options as @libsql/client.

License

This project is licensed under the MIT license.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in @libsql/kysely-libsql by you, shall be licensed as MIT, without any additional terms or conditions.

About

Kysely dialect for sqld

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Used by

Contributors

Languages

AltStyle によって変換されたページ (->オリジナル) /