Package detail

Join the discussion ⠀⠀⠀⠀⠀⠀⠀

kysely-neon offers a Kysely dialect for Neon's serverless driver over HTTP.

For WebSockets usage, you don't need this package. Use Neon's Pool instance with Kysely's core PostgreSQL dialect.

Installation

Node.js

npm install kysely-neon @neondatabase/serverless kysely

pnpm add kysely-neon @neondatabase/serverless kysely

yarn add kysely-neon @neondatabase/serverless kysely

Other runtimes

deno add npm:kysely-neon npm:@neondatabase/serverless npm:kysely

bun add kysely-neon @neondatabase/serverless kysely

Usage

import { neon } from "@neondatabase/serverless";
import { type GeneratedAlways, Kysely } from "kysely";
import { NeonDialect } from "kysely-neon";

interface Database {
    person: {
        id: GeneratedAlways<number>;
        first_name: string | null;
        last_name: string | null;
        age: number;
    };
}

const db = new Kysely<Database>({
    dialect: new NeonDialect({
        neon: neon(process.env.CONNECTION_STRING!),
    }),
});

const people = await db.selectFrom("person").selectAll().execute();

Acknowledgements

seveibar who created and maintained this library. :heart: