Drizzle <> Neon Postgres

本指南假定您熟悉

Drizzle 数据库连接基础知识
Neon Serverless 数据库 - 网站
Neon Serverless 驱动 - 文档 & GitHub
Drizzle PostgreSQL 驱动 - 文档

Drizzle 原生支持使用 neon-http 和 neon-websockets 驱动连接 Neon。这些驱动在底层使用 neon-serverless 驱动。

通过 neon-http 和 neon-websockets 驱动，您可以在无服务器环境中通过 HTTP 或 WebSocket 而不是 TCP 访问 Neon 数据库。
对于单个非交互式事务，通过 HTTP 查询速度更快。

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

有关在 Cloudflare Worker 中使用 Drizzle ORM 和 Neon Serverless 驱动的示例，请参阅此处。
要在有服务器环境中（serverful environment）使用 Neon，您可以使用 PostgresJS 驱动，具体请参阅 Neon 官方的 Node.js 文档 — 请参阅文档。

步骤 1 - 安装包

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

步骤 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');

重要提示

在未定义 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');

重要提示

// 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');

接下来是什么？

管理 Schema

Drizzle Schema PostgreSQL 数据类型索引与约束数据库视图数据库 Schemas 序列扩展

查询数据

关系查询选择插入更新删除过滤器连接 sql`` 操作符