Forked from Libsql/kysely-libsql
A Kysely using the @libsql/client from Turso official sdk.
npm install @maxzpr/kysely-libsql-client
Pass a LibsqlDialect
instance as the dialect
when creating the Kysely
object:
import { Kysely } from "kysely";
import { LibsqlDialect } from "@maxzpr/kysely-libsql-client";
interface Database {
...
}
const db = new Kysely<Database>({
dialect: new LibsqlDialect({
url: "libsql://localhost:8080?tls=0",
authToken: "<token>", // optional
}),
});
// or
const db = new Kysely<Database>({
dialect: new LibsqlDialect({
url: "libsql://localhost:8080?authToken=<token>"
}),
});
The library accepts the same URL schemas as @libsql/client
except file:
:
-
http://
andhttps://
connect to a libsql server over HTTP, -
ws://
andwss://
connect to the server over WebSockets, -
libsql://
connects to the server using the default protocol (which is now HTTP).libsql://
URLs use TLS by default, but you can use?tls=0
to disable TLS (e.g. when you run your own instance of the server locally).
Connecting to a local SQLite file using file:
URL is not supported; we suggest that you use the native Kysely dialect for SQLite.
This project is licensed under the MIT license.
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in @maxzpr/kysely-libsql-client
by you, shall be licensed as MIT, without any additional terms or conditions.