add sqlocal connection including example

This commit is contained in:
dswbx
2025-03-15 14:40:41 +01:00
parent 5697b7891a
commit 622a7b2b9a
22 changed files with 1047 additions and 56 deletions

View File

@@ -0,0 +1,29 @@
# SQLocal adapter for `bknd` (experimental)
This packages adds an adapter to use a SQLocal database with `bknd`. It is based on [`sqlocal`](https://github.com/DallasHoff/sqlocal) and the driver included for `kysely`.
## Installation
Install the adapter with:
```bash
npm install @bknd/sqlocal
```
## Usage
Create a connection:
```ts
import { SQLocalConnection } from "@bknd/sqlocal";
const connection = new SQLocalConnection({
databasePath: "db.sqlite"
});
```
Use the connection depending on which framework or runtime you are using. E.g., when using `createApp`, you can use the connection as follows:
```ts
import { createApp } from "bknd";
import { SQLocalConnection } from "@bknd/sqlocal";
const connection = new SQLocalConnection();
const app = createApp({ connection });
```