通过 Bun 使用 Drizzle ORM 连接 Neon Postgres

在 GitHub 上编辑

Neon 是一个完全托管的无服务器 Postgres，它分离了计算和存储，从而提供诸如自动缩放、分支和无限存储等功能。 Neon 可以直接通过 Bun 使用 @neondatabase/serverless 驱动程序或通过像 Drizzle 这样的 ORM 来使用。

Drizzle ORM 同时支持类似 SQL 的“查询构建器” API 和类似 ORM 的 Queries API。首先创建一个项目目录，使用 bun init 初始化目录，并安装 Drizzle 和 Neon 无服务器驱动程序。

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 连接字符串添加到其中。

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

我们将使用 Neon 无服务器驱动程序连接到 Neon 数据库，该驱动程序封装在 Drizzle 数据库实例中。

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

// Bun automatically loads the DATABASE_URL from .env.local
// Refer to: https://bun.net.cn/docs/runtime/env for more information
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。

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(),
  name: 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("Migration completed");
  } catch (error) {
    console.error("Error during migration:", error);
    process.exit(1);
  }
};

main();

我们可以使用 bun 运行此脚本来执行迁移。

bun run migrate.ts
Migration completed

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

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

async function seed() {
  await db.insert(schema.authors).values([
    {
      name: "J.R.R. Tolkien",
      bio: "The creator of Middle-earth and author of The Lord of the Rings.",
    },
    {
      name: "George R.R. Martin",
      bio: "The author of the epic fantasy series A Song of Ice and Fire.",
    },
    {
      name: "J.K. Rowling",
      bio: "The creator of the Harry Potter series.",
    },
  ]);
}

async function main() {
  try {
    await seed();
    console.log("Seeding completed");
  } catch (error) {
    console.error("Error during seeding:", error);
    process.exit(1);
  }
}

main();

然后运行此文件。

bun run seed.ts
Seeding completed

我们现在有了一个带有模式和示例数据的数据库。我们可以使用 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);

然后运行该文件。您应该看到我们插入的三个作者。

bun run index.ts
[
  {
    id: 1,
    name: "J.R.R. Tolkien",
    bio: "The creator of Middle-earth and author of The Lord of the Rings.",
    createdAt: 2024-05-11T10:28:46.029Z,
  }, {
    id: 2,
    name: "George R.R. Martin",
    bio: "The author of the epic fantasy series A Song of Ice and Fire.",
    createdAt: 2024-05-11T10:28:46.029Z,
  }, {
    id: 3,
    name: "J.K. Rowling",
    bio: "The creator of the Harry Potter series.",
    createdAt: 2024-05-11T10:28:46.029Z,
  }
]

此示例使用了 Neon 无服务器驱动程序的 SQL-over-HTTP 功能。 Neon 的无服务器驱动程序还公开了 Client 和 Pool 构造函数，以启用会话、交互式事务和 node-postgres 兼容性。有关完整概述，请参阅 Neon 的文档。

有关使用 Drizzle ORM 的更多文档，请参阅 Drizzle 网站。