通过 Drizzle ORM 使用 Neon Postgres

Neon 是一个完全托管的无服务器 Postgres，将计算和存储分离，提供自动扩缩、分支和无底存储等功能。你可以通过 @neondatabase/serverless 驱动程序直接从 Bun 使用 Neon，也可以通过像 Drizzle 这样的 ORM 使用。 Drizzle ORM 支持类似 SQL 的”查询构建器”API 和类似 ORM 的查询 API。首先创建一个项目目录，用 bun init 初始化，然后安装 Drizzle 和 Neon 无服务器驱动。

terminal

mkdir bun-drizzle-neon
cd bun-drizzle-neon
bun init -y
bun add drizzle-orm @neondatabase/serverless
bun add -D drizzle-kit

创建一个 .env.local 文件，并将你的 Neon Postgres 连接字符串添加到其中。

.env.local

DATABASE_URL=postgresql://usertitle:password@ep-adj-noun-guid.us-east-1.aws.neon.tech/neondb?sslmode=require

在 db.ts 中，使用 Neon 无服务器驱动连接到 Neon 数据库，封装在 Drizzle 数据库实例中。

db.ts

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

// Bun 会自动从 .env.local 加载 DATABASE_URL
// 参考：https://bun.com/docs/runtime/environment-variables 了解更多信息
const sql = neon(process.env.DATABASE_URL！);

export const db = drizzle(sql);

要查看数据库的实际运行效果，将以下内容添加到 index.ts。

index.ts

import { db } from "./db";
import { sql } from "drizzle-orm";

const query = sql`select 'hello world' as text`;
const result = await db.execute(query);
console.log(result.rows);

然后使用 Bun 运行 index.ts。

terminal

bun run index.ts

[
  {
    text: "hello world",
  }
]

使用 Drizzle ORM 原语为数据库定义模式。创建一个 schema.ts 文件并添加以下代码。

schema.ts

import { pgTable, integer, serial, text, timestamp } from "drizzle-orm/pg-core";

export const authors = pgTable("authors", {
  id: serial("id").primaryKey(),
  title: text("name").notNull(),
  bio: text("bio"),
  createdAt: timestamp("created_at").notNull().defaultNow(),
});

然后使用 drizzle-kit CLI 生成初始 SQL 迁移。

bunx drizzle-kit generate --dialect postgresql --schema ./schema.ts --out ./drizzle

该命令会创建一个 drizzle 目录，其中包含一个 .sql 迁移文件和一个 meta 目录。

文件树

drizzle
├── 0000_aspiring_post.sql
└── meta
    ├── 0000_snapshot.json
    └── _journal.json

使用 migrate.ts 脚本执行这些迁移。该脚本打开一个新的 Neon 数据库连接，并执行 drizzle 目录中所有未执行的迁移。

migrate.ts

import { db } from "./db";
import { migrate } from "drizzle-orm/neon-http/migrator";

const main = async () => {
  try {
    await migrate(db, { migrationsFolder: "drizzle" });
    console.log("迁移完成");
  } catch (error) {
    console.error("迁移期间出错：", error);
    process.exit(1);
  }
};

main();

使用 bun 运行该脚本。

terminal

bun run migrate.ts

迁移完成

现在向数据库添加一些数据。创建一个包含以下内容的 seed.ts 文件。

seed.ts

import { db } from "./db";
import * as schema from "./schema";

async function seed() {
  await db.insert(schema.authors).values([
    {
      title: "J.R.R. Tolkien",
      bio: "中土世界的创造者、《魔戒》的作者。",
    },
    {
      title: "George R.R. Martin",
      bio: "史诗奇幻系列《冰与火之歌》的作者。",
    },
    {
      title: "J.K. Rowling",
      bio: "《哈利·波特》系列的创作者。",
    },
  ]);
}

async function main() {
  try {
    await seed();
    console.log("种子数据完成");
  } catch (error) {
    console.error("种子数据期间出错：", error);
    process.exit(1);
  }
}

main();

然后运行此文件。

terminal

bun run seed.ts

种子数据完成

数据库现在有了模式和示例数据。用 Drizzle 查询它，将 index.ts 的内容替换为以下内容。

index.ts

import * as schema from "./schema";
import { db } from "./db";

const result = await db.select().from(schema.authors);
console.log(result);

然后运行该文件。它会打印你插入的三位作者。

terminal

bun run index.ts

[
  {
    id: 1,
    title: "J.R.R. Tolkien",
    bio: "中土世界的创造者、《魔戒》的作者。",
    createdAt: 2024-05-11T10:28:46.029Z,
  }, {
    id: 2,
    title: "George R.R. Martin",
    bio: "史诗奇幻系列《冰与火之歌》的作者。",
    createdAt: 2024-05-11T10:28:46.029Z,
  }, {
    id: 3,
    title: "J.K. Rowling",
    bio: "《哈利·波特》系列的创作者。",
    createdAt: 2024-05-11T10:28:46.029Z,
  }
]

本示例使用了 Neon 无服务器驱动的 SQL-over-HTTP 功能。Neon 的无服务器驱动还暴露了 Client 和 Pool 构造函数，以支持会话、交互式事务和 node-postgres 兼容性。请参考 Neon 文档了解完整概述。请参考 Drizzle 网站查看完整文档。

使用 Mongoose 和 Bun 读写 MongoDB 数据

使用 Neon 的无服务器 Postgres 与 Bun

⌘I

概览

部署

运行时与调试

实用工具

生态系统与框架

HTTP 与网络

WebSocket

进程与系统

包管理器

测试运行器

运行时与调试

模块系统

文件系统

实用工具

HTML 处理

二进制数据

流

通过 Drizzle ORM 使用 Neon Postgres