Drizzle ORM 与 Neon 数据库迁移配置指南

在使用 Drizzle ORM 进行数据库迁移时，特别是与 Neon 数据库配合使用时，开发者可能会遇到一些特殊配置问题。本文将详细介绍如何正确配置 Drizzle ORM 以支持 Neon 数据库的迁移操作。

问题背景

当开发者尝试使用 drizzle-kit migrate 命令对 Neon 数据库执行迁移时，可能会遇到 PostgresError: connection is insecure (try using sslmode=require) 错误。这表明当前连接配置存在安全性问题，需要启用 SSL 加密。

解决方案

基础配置

在 drizzle.config.ts 文件中，最基本的解决方案是确保启用了 SSL 连接。可以通过两种方式实现：

1. 在数据库连接字符串中添加 ?sslmode=require 参数
2. 在 dbCredentials 配置中明确设置 ssl: true

import { defineConfig } from 'drizzle-kit'

export default defineConfig({
  schema: './src/tables',
  out: './drizzle',
  dialect: 'postgresql',
  dbCredentials: {
    url: 'your_database_url?sslmode=require',
    // 或者
    ssl: true
  }
})

针对 Neon 的特殊配置

Neon 数据库支持两种连接方式：直接连接和池化连接。对于迁移操作，建议使用直接连接而非池化连接，以避免潜在的兼容性问题。

推荐的最佳实践是：

1. 在迁移配置中使用直接连接
2. 在应用代码中使用池化连接

配置示例：

// drizzle.config.ts (用于迁移)
import { defineConfig } from 'drizzle-kit'

export default defineConfig({
  schema: './lib/db/schema.ts',
  out: './drizzle',
  dialect: 'postgresql',
  dbCredentials: {
    host: process.env.POSTGRES_HOST!,
    user: process.env.POSTGRES_USER!,
    password: process.env.POSTGRES_PASSWORD!,
    database: process.env.POSTGRES_DATABASE!,
    ssl: true
  }
})

// 应用代码中的数据库连接
import { drizzle } from 'drizzle-orm/neon-http'
import { neon } from '@neondatabase/serverless'
import * as schema from './schema'

const sql = neon(process.env.DATABASE_URL!)
export const db = drizzle(sql, { schema })

注意事项

1. 迁移完成后，可能需要等待几分钟时间让模式变更同步到整个连接池
2. 如果立即执行查询或插入操作，可能会遇到"relation"错误，这是正常的同步延迟
3. 确保环境变量中的数据库连接信息正确无误

通过以上配置，开发者可以顺利地在 Neon 数据库上使用 Drizzle ORM 的迁移功能，同时保持应用代码中的高性能池化连接。