本教程演示了如何使用 Drizzle ORM 与 Neon Postgres 数据库。如果您尚未拥有 Neon 账户,请 在此处注册。
This guide assumes familiarity with:
设置 Neon 和 Drizzle ORM
创建新 Neon 项目
登录到 Neon 控制台 并导航到项目部分。选择一个项目或点击 新建项目
按钮以创建一个新项目。
您的 Neon 项目带有一个可即用的 Postgres 数据库,名为 neondb
。我们将在本教程中使用它。
设置连接字符串变量
导航到项目控制台中的 连接详细信息 部分以找到您的数据库连接字符串。它应该类似于以下内容:
将 DATABASE_URL
环境变量添加到您的 .env
或 .env.local
文件中,您将使用它连接到 Neon 数据库。
将 Drizzle ORM 连接到您的数据库
创建一个 db.ts
文件并设置您的数据库配置:
创建表
创建一个 schema.ts
文件并声明您的表:
设置 Drizzle 配置文件
Drizzle 配置 - 一个由 Drizzle Kit 使用的配置文件,包含有关您数据库连接、迁移文件夹和模式文件的所有信息。
在项目根目录中创建一个 drizzle.config.ts
文件并添加以下内容:
将更改应用到数据库
您可以使用 drizzle-kit generate
命令生成迁移,然后使用 drizzle-kit migrate
命令运行它们。
生成迁移:
这些迁移将存储在您 drizzle.config.ts
中指定的 drizzle/migrations
目录中。该目录将包含更新您的数据库模式所需的 SQL 文件,并包含一个 meta
文件夹,用于存储不同迁移阶段的模式快照。
生成的迁移示例:
运行迁移:
或者,您可以使用 Drizzle kit push 命令 直接将更改推送到数据库:
IMPORTANT
推送命令非常适合快速测试新模式设计或在本地开发环境中的更改,允许快速迭代而无需管理迁移文件的开销。
基本文件结构
这是项目的基本文件结构。在 src/db
目录中,我们有与数据库相关的文件,包括在 db.ts
中的连接,在 schema.ts
中的模式定义,以及在 migrate.ts
文件中的迁移脚本,该文件负责应用存储在 migrations
目录中的迁移。
查询示例
例如,我们可以创建 src/queries
文件夹,并为每个操作(插入、选择、更新、删除)创建单独的文件。
插入数据
有关插入查询的更多信息,请参阅 文档。
选择数据
有关选择查询的更多信息,请参阅 文档。
或者,您可以使用 关系查询语法。
更新数据
有关更新查询的更多信息,请参阅 文档。
删除数据
有关删除查询的更多信息,请参阅 文档。