Kysely

Integrate DB0 with Kysely query builder

Usage

Install kysely dependency:

npx nypm add kysely

Create a db0 database and wrap it with Kysely:

database.ts

import { createDatabase } from "db0";
import sqlite from "db0/connectors/better-sqlite3";
import { kysely } from "db0/integrations/kysely";

// Define your database types
interface UsersTable {
  id: number;
  name: string;
  email: string;
}

interface Database {
  users: UsersTable;
}

// Initialize DB instance
const db = createDatabase(sqlite({ name: "database.sqlite" }));

// Create Kysely instance (dialect is auto-detected from db0)
export const ky = kysely<Database>(db);

Then use Kysely's type-safe query builder:

queries.ts

import { ky } from "./database";

// Insert a new user
const insertedUser = await ky
  .insertInto("users")
  .values({ name: "John Doe", email: "[email protected]" })
  .returning(["id", "name", "email"])
  .executeTakeFirst();

// Select all users
const allUsers = await ky.selectFrom("users").selectAll().execute();

// Query with conditions
const john = await ky
  .selectFrom("users")
  .selectAll()
  .where("email", "=", "[email protected]")
  .executeTakeFirst();

// Update
await ky
  .updateTable("users")
  .set({ name: "Jane Doe" })
  .where("id", "=", 1)
  .execute();

// Delete
await ky.deleteFrom("users").where("id", "=", 1).execute();

Transactions

Kysely's transaction API works out of the box:

await ky.transaction().execute(async (trx) => {
  await trx.insertInto("users").values({ name: "Alice", email: "[email protected]" }).execute();
  await trx.insertInto("users").values({ name: "Bob", email: "[email protected]" }).execute();
});

Dialect Detection

The integration automatically selects the correct Kysely dialect based on the db0 connector:

db0 dialect	Kysely dialect
`sqlite`	SQLite
`libsql`	SQLite
`postgresql`	PostgreSQL
`mysql`	MySQL

This means you can switch connectors without changing your Kysely code.

Limitations

numAffectedRows: For mutations without a RETURNING clause, the affected row count is not available (undefined). Use RETURNING if you need to know how many rows were affected.
Streaming queries: Not supported by the db0 integration.

Drizzle

Integrate DB0 with Drizzle ORM

Prisma

Integrate DB0 with Prisma ORM