Drizzle ORM 使用 node-postgres Client 进行数据库迁移的注意事项

在使用 Drizzle ORM 进行数据库迁移时，开发者可能会遇到一个常见但容易被忽视的问题：当使用 node-postgres 的 Client 而非 Pool 时，迁移操作无法正常执行。本文将详细解析这一问题的原因及解决方案。

问题现象

开发者在使用 Drizzle ORM 进行数据库迁移时，如果采用以下配置：

import { Client } from 'pg'
import { drizzle } from 'drizzle-orm/node-postgres'
import { migrate } from 'drizzle-orm/node-postgres/migrator'

const client = new Client({ connectionString: process.env.DATABASE_URL })
const db = drizzle(client, { schema })

await migrate(db, { migrationsFolder: './db/migrations' })
await client.end()

会发现迁移操作仅执行了"CREATE SCHEMA IF NOT EXISTS"语句后就停止了，而预期的表结构迁移并未发生。然而，当改用 Pool 替代 Client 时，迁移却能正常执行。

问题根源

这个问题的根本原因在于开发者没有显式地建立数据库连接。与 Pool 不同，node-postgres 的 Client 需要手动调用 connect() 方法建立连接后才能执行查询操作。

解决方案

要解决这个问题，只需在迁移前显式建立数据库连接：

import { Client } from 'pg'
import { drizzle } from 'drizzle-orm/node-postgres'
import { migrate } from 'drizzle-orm/node-postgres/migrator'

const client = new Client({ connectionString: process.env.DATABASE_URL })
await client.connect() // 关键步骤：显式建立连接

const db = drizzle(client, { schema })
await migrate(db, { migrationsFolder: './db/migrations' })
await client.end()

最佳实践建议

1. 连接管理：无论使用 Client 还是 Pool，都应确保在执行任何操作前已建立有效连接。

2. 错误处理：建议在连接建立和迁移操作周围添加适当的错误处理逻辑。

3. 资源释放：操作完成后，确保正确关闭连接或释放连接池资源。

4. 环境检查：在开发和生产环境中，建议使用不同的连接策略。Pool 更适合生产环境，而 Client 可能更适合简单的脚本或测试场景。

总结

Drizzle ORM 是一个功能强大的 TypeScript ORM 工具，但在使用时需要注意底层数据库驱动的特性差异。通过理解 node-postgres 中 Client 和 Pool 的行为差异，开发者可以避免这类连接相关的问题，确保数据库迁移和其他操作能够顺利执行。