kysely-neon

!A Kysely-branded yellow duck playing with bricks together with a Neon-branded elephant

!GitHub contributors

###### 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

$3

``bash
npm install kysely-neon @neondatabase/serverless kysely
`

`bash
pnpm add kysely-neon @neondatabase/serverless kysely
`

`bash
yarn add kysely-neon @neondatabase/serverless kysely
`

$3

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

`bash
bun add kysely-neon @neondatabase/serverless kysely
`

Usage

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

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

const db = new Kysely({
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: