Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Support autoClose option #25

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
+134 −196
Open

Support autoClose option #25

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4c57a76
Support autoClose option
vicary Dec 19, 2024
a6e574a
Upgrade libsql
vicary Dec 19, 2024
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
31 changes: 26 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# kysely-libsql

A [Kysely][kysely] dialect for [libSQL][libsql], compatible with [@libsql/client][libsql-client-ts].
A [Kysely][kysely] dialect for [libSQL][libsql], compatible with
[@libsql/client][libsql-client-ts].

[kysely]: https://github.com/koskimas/kysely
[libsql]: https://github.com/tursodatabase/libsql
Expand All @@ -13,7 +14,8 @@ npm install @libsql/kysely-libsql

## Usage

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

```typescript
import { Kysely } from "kysely";
Expand All @@ -31,7 +33,8 @@ const db = new Kysely<Database>({
});
```

Instead of a `url`, you can also pass an existing `Client` from [`@libsql/client`][libsql-client-ts]:
Instead of a `url`, you can also pass an existing `Client` from
[`@libsql/client`][libsql-client-ts]:

```typescript
import { createClient } from "@libsql/client";
Expand All @@ -48,9 +51,25 @@ const db = new Kysely<Database>({
client.close();
```

Or pass a `createClient` function to have Kysely manage the client's lifecycle.

```typescript
import { createClient } from "@libsql/client";

const db = new Kysely<Database>({
createClient: () =>
createClient({
url: "file:local.db",
syncUrl: "libsql://localhost:8080",
authToken: "<token>",
}),
});
```

## Supported Configuration Options

The library accepts the exact same [options][client-options] as [`@libsql/client`][libsql-client-ts].
The library accepts the exact same [options][client-options] as
[`@libsql/client`][libsql-client-ts].

[libsql-client-ts]: https://github.com/tursodatabase/libsql-client-ts
[client-options]: https://docs.turso.tech/sdk/ts/reference#initializing
Expand All @@ -61,4 +80,6 @@ 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.
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.
Loading