https://github.com/aidenwallis/kysely-d1

D1 dialect for Kysely
https://github.com/aidenwallis/kysely-d1

cloudflare cloudflare-workers d1 hacktoberfest kysely kysely-dialect sqlite

Last synced: about 3 hours ago
JSON representation

D1 dialect for Kysely

• Host: GitHub
• URL: https://github.com/aidenwallis/kysely-d1
• Owner: aidenwallis
• License: mit
• Created: 2022-10-16T21:01:23.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-05-17T04:51:35.000Z (9 months ago)
• Last Synced: 2025-02-06T12:38:25.075Z (2 days ago)
• Topics: cloudflare, cloudflare-workers, d1, hacktoberfest, kysely, kysely-dialect, sqlite
• Language: TypeScript
• Homepage:
• Size: 142 KB
• Stars: 222
• Watchers: 3
• Forks: 13
• Open Issues: 11
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# kysely-d1

[![ci](https://github.com/aidenwallis/kysely-d1/actions/workflows/ci.yaml/badge.svg)](https://github.com/aidenwallis/kysely-d1/actions/workflows/ci.yaml)

[![npm](https://img.shields.io/npm/v/kysely-d1.svg)](https://www.npmjs.com/package/kysely-d1)

[Kysely](https://github.com/koskimas/kysely) adapter for [Cloudflare D1](https://developers.cloudflare.com/d1/).

```bash

npm i kysely-d1

```

This project was largely adapted from [kysely-planetscale](https://github.com/depot/kysely-planetscale).

## Usage

Pass your D1 binding into the dialect in order to configure the Kysely client. Follow [these docs](https://developers.cloudflare.com/d1/get-started/#4-bind-your-worker-to-your-d1-database) for instructions on how to do so.

```typescript

import { Kysely } from 'kysely';

import { D1Dialect } from 'kysely-d1';

export interface Env {

  DB: D1Database;

}

interface KvTable {

  key: string;

  value: string;

}

interface Database {

  kv: KvTable;

}

export default {

  async fetch(request: Request, env: Env): Promise {

    const { searchParams } = new URL(request.url);

    const key = searchParams.get('key');

    if (!key) {

      return new Response('No key defined.', { status: 400 });

    }

    // Create Kysely instance with kysely-d1

    const db = new Kysely({ dialect: new D1Dialect({ database: env.DB }) });

    

    // Read row from D1 table

    const result = await db.selectFrom('kv').selectAll().where('key', '=', key).executeTakeFirst();

    if (!result) {

      return new Response('No value found', { status: 404 });

    }

    return new Response(result.value);

  },

};

```

There is a working [example](example) also included, which implements a K/V style store using D1.