Drizzle <> Neon Postgres

This guide assumes familiarity with:

Database connection basics with Drizzle
Neon serverless database - website
Neon serverless driver - docs & GitHub
Drizzle PostgreSQL drivers - docs

Drizzle has native support for Neon connections with the neon-http and neon-websockets drivers. These use the neon-serverless driver under the hood.

With the neon-http and neon-websockets drivers, you can access a Neon database from serverless environments over HTTP or WebSockets instead of TCP.
Querying over HTTP is faster for single, non-interactive transactions.

If you need session or interactive transaction support, or a fully compatible drop-in replacement for the pg driver, you can use the WebSocket-based neon-serverless driver.
You can connect to a Neon database directly using Postgres

For an example of using Drizzle ORM with the Neon Serverless driver in a Cloudflare Worker, see here.
To use Neon from a serverful environment, you can use the PostgresJS driver, as described in Neon’s official Node.js docs — see docs.

Step 1 - Install packages

npm

yarn

pnpm

bun

npm i drizzle-orm @neondatabase/serverless
npm i -D drizzle-kit

yarn add drizzle-orm @neondatabase/serverless
yarn add -D drizzle-kit

pnpm add drizzle-orm @neondatabase/serverless
pnpm add -D drizzle-kit

bun add drizzle-orm @neondatabase/serverless
bun add -D drizzle-kit

Step 2 - Initialize the driver and make a query

Neon HTTP

Neon Websockets

node-postgres

postgres.js

import { drizzle } from 'drizzle-orm/connect';

const db = await drizzle("neon-http", process.env.DATABASE_URL);

const result = await db.execute('select 1');

import { drizzle } from 'drizzle-orm/connect';

const db = await drizzle("neon-websockets", process.env.DATABASE_URL);

const result = await db.execute('select 1');

// For Node.js - make sure to install the 'ws' and 'bufferutil' packages
import { drizzle } from 'drizzle-orm/connect';
import ws from 'ws';

const db = await drizzle("neon-websockets", {
  connection: process.env.DATABASE_URL,
  ws: ws,
});

const result = await db.execute('select 1');

IMPORTANT

Additional configuration is required to use WebSockets in environments where the WebSocket global is not defined, such as Node.js. Add the ws and bufferutil packages to your project’s dependencies, and set ws in the Drizzle config.

// Make sure to install the 'pg' package 
import { drizzle } from 'drizzle-orm/connect';

const db = await drizzle("node-postgres", process.env.DATABASE_URL);
 
const result = await db.execute('select 1');

// Make sure to install the 'postgres' package
import { drizzle } from 'drizzle-orm/connect';

const db = await drizzle("postgres-js", process.env.DATABASE_URL);

const result = await db.execute('select 1');

If you need a synchronous connection, you can use our additional connection API, where you specify a driver connection and pass it to the Drizzle instance.

Neon HTTP

Neon Websockets

node-postgres

postgres.js

import { neon } from '@neondatabase/serverless';
import { drizzle } from 'drizzle-orm/neon-http';

const sql = neon(process.env.DATABASE_URL!);
const db = drizzle(sql);

const result = await db.execute('select 1');

import { Pool } from '@neondatabase/serverless';
import { drizzle } from 'drizzle-orm/neon-serverless';

const pool = new Pool({ connectionString: process.env.DATABASE_URL });
const db = drizzle(pool)

const result = await db.execute('select 1');

// For Node.js - make sure to install the 'ws' and 'bufferutil' packages
import { Pool, neonConfig } from '@neondatabase/serverless';
import { drizzle } from 'drizzle-orm/neon-serverless';

neonConfig.webSocketConstructor = ws;

const pool = new Pool({ connectionString: process.env.DATABASE_URL });
const db = drizzle(pool)

const result = await db.execute('select 1');

IMPORTANT

// Make sure to install the 'pg' package 
import { pgTable, serial, text, varchar } from "drizzle-orm/pg-core";
import { drizzle } from "drizzle-orm/node-postgres";
import { Pool } from "pg";

const pool = new Pool({
  connectionString: process.env.DATABASE_URL,
});
const db = drizzle(pool);
 
const result = await db.execute('select 1');

// Make sure to install the 'postgres' package
import { drizzle } from 'drizzle-orm/postgres-js';
import postgres from 'postgres';

const queryClient = postgres(process.env.DATABASE_URL);
const db = drizzle(queryClient);

const result = await db.execute('select 1');

What’s next?

Manage schema

Drizzle Schema PostgreSQL data types Indexes and Constraints Database Views Database Schemas Sequences Extensions

Query data

Relational Queries Select Insert Update Delete Filters Joins sql`` operator