Drizzle <> Neon Postgres

This guide assumes familiarity with:

Drizzle 数据库连接基础
Neon 无服务器数据库 - website
Neon 无服务器驱动程序 - docs & GitHub
Drizzle PostgreSQL 驱动程序 - docs

Drizzle 原生支持与 neon-http 和 neon-websockets 驱动程序的 Neon 连接。这些操作在底层使用了 neon-serverless 驱动程序。

使用 neon-http 和 neon-websockets 驱动程序，你可以通过 HTTP 或 WebSockets（而非 TCP）从无服务器环境访问 Neon 数据库。对于单个非交互式事务，通过 HTTP 查询速度更快。

如果你需要会话或交互式事务支持，或者需要完全兼容 pg 驱动程序的嵌入式替代品，你可以使用基于 WebSocket 的 neon-serverless 驱动程序。你可以使用 Postgres 直接连接到 Neon 数据库

在 Cloudflare Worker 中使用 Drizzle ORM 和 Neon Serverless 驱动程序的示例，参见此处。。要在服务器环境中使用 Neon，你可以使用 PostgresJS 驱动程序，如 Neon 的 Node.js 官方文档中所述 - 请参阅 docs。

步骤 1 - 安装软件包

npm

yarn

pnpm

bun

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

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

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

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

步骤 2 - 初始化驱动程序并进行查询

Neon HTTP

Neon Websockets

node-postgres

postgres.js

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

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

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

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

const db = drizzle(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/neon-serverless';
import ws from 'ws';

const db = drizzle({
  connection: process.env.DATABASE_URL,
  ws: ws,
});

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

IMPORTANT

在未定义 WebSocket 全局变量的环境（例如 Node.js）中使用 WebSocket 需要进行额外配置。将 ws 和 bufferutil 包添加到项目的依赖中，并在 Drizzle 配置中设置 ws。

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

const db = drizzle(process.env.DATABASE_URL);
 
const result = await db.execute('select 1');

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

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

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

如果你需要提供现有的驱动程序：

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({ client: 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({ client: 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({ client: 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({ client: 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({ client: queryClient });

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

下一步是什么？

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