@notsplol/kysely-d1

Kysely dialect for Cloudflare D1.

npm i @notsplol/kysely-d1

This is an actively maintained fork of the original kysely-d1 by Aiden Wallis, which is no longer maintained. It targets the current Kysely and Cloudflare Workers APIs.

Requirements

• kysely >= 0.27.0
• Cloudflare Workers or Pages environment with a D1 binding

Usage

Pass your D1 binding into the dialect to configure the Kysely client. Follow these docs for instructions on how to bind D1 to your Worker.

import { Kysely } from 'kysely';
import { D1Dialect } from '@notsplol/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<Response> {
    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<Database>({ 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 also included, which implements a simple K/V store using D1.