Drizzle ORM 教程

1. 项目介绍

Drizzle ORM 是一个轻量级的 TypeScript ORM（对象关系映射），适用于 Node.js、Bun 和 Deno 环境。它以约 7.4KB 的压缩和 gzip 包大小运行，且零依赖。Drizzle 支持 PostgreSQL、MySQL 和 SQLite 数据库，包括它们的不同变体。它提供了一套工具，如 Drizzle Kit CLI 和 Drizzle Studio，用于简化数据库迁移和数据操作。作为一个现代化的 ORM，Drizzle 鼓励类型安全的编程方式，同时也便于扩展。

2. 项目快速启动

安装

首先确保已安装 Node.js 和 npm，然后通过以下命令全局安装 Drizzle:

npm install -g @drizzle-team/drizzle-cli

接着，在你的项目中安装 Drizzle ORM:

npm init -y
npm install --save @drizzle-team/drizzle-orm

基本使用

创建一个 .ts 文件并导入 Drizzle：

import { createConnection } from "@drizzle-team/drizzle-orm";

// 连接配置
const config = {
  host: "localhost",
  user: "yourUsername",
  password: "yourPassword",
  database: "yourDatabase",
  dialect: "mysql" // 可选值: 'mysql', 'postgres', 'sqlite'
};

(async () => {
  const connection = await createConnection(config);
  
  try {
    const result = await connection.query("SELECT * FROM yourTable");
    console.log(result.rows);
  } catch (error) {
    console.error(error);
  } finally {
    connection.close();
  }
})();

数据库迁移

你可以使用 Drizzle Kit CLI 创建和管理迁移文件：

npx drizzle kit migration:create add_users_table

这将在 migrations 目录下创建一个新的迁移文件，然后在文件内编写 SQL 来描述数据库变更。

3. 应用案例和最佳实践

• 类型安全: 使用 TypeScript 声明 SQL 模式，确保查询的安全性。
• 灵活查询: 结合 Drizzle 提供的查询构造器来构建复杂的 SQL 查询。
• 性能优化: 利用 ORM 的树形摇晃功能，仅打包实际使用的部分。
• 测试: 在单元测试中使用内存数据库（如 SQLite）进行快速测试。

4. 典型生态项目

Drizzle 生态系统包含了多个配套工具和库：

• Drizzle Kit CLI：用于数据库迁移和管理的命令行工具。
• Drizzle Studio：图形界面工具，方便浏览和操作数据库。
• Drizzle Typebox 和 Valibot：类型定义工具和验证工具，增强类型安全性。
• Drizzle Zod：基于 Zod 的类型安全序列化和反序列化工具。

此外，Drizzle 也支持与其他云服务和无服务器框架集成，如 Turso、Neon、Xata、PlanetScale、Cloudflare Workers、D1、Supabase 函数等。

---

本文档为您提供了一个对 Drizzle ORM 的基本理解以及如何开始使用它的步骤。继续探索其官方文档和示例项目，将有助于您更深入地利用 Drizzle 开发应用程序。