Cloudflare D1

New database

Meet Drizzle

开始使用 Drizzle 和 D1

本指南假定您已熟悉：

dotenv - 管理环境变量的包 - 查看这里
tsx - 运行 TypeScript 文件的包 - 查看这里
Cloudflare D1 - 用于从您的 Workers 和 Pages 项目中查询的无服务器 SQL 数据库 - 查看这里
wrangler - Cloudflare 开发者平台命令行界面 - 查看这里

基本文件结构

这是项目的基本文件结构。在 src/db 目录中，我们在 schema.ts 中有表定义。在 drizzle 文件夹中，有 SQL 迁移文件和快照。

📦 <project root>
 ├ 📂 drizzle
 ├ 📂 src
 │   ├ 📂 db
 │   │  └ 📜 schema.ts
 │   └ 📜 index.ts
 ├ 📜 .env
 ├ 📜 drizzle.config.ts
 ├ 📜 package.json
 └ 📜 tsconfig.json

第一步 - 安装所需的包

npm

yarn

pnpm

bun

npm i drizzle-orm wrangler dotenv
npm i -D drizzle-kit tsx

yarn add drizzle-orm wrangler dotenv
yarn add -D drizzle-kit tsx

pnpm add drizzle-orm wrangler dotenv
pnpm add -D drizzle-kit tsx

bun add drizzle-orm wrangler dotenv
bun add -D drizzle-kit tsx

第二步 - 设置 wrangler.toml

您需要一个 wrangler.toml 文件用于 D1 数据库，其内容大致如下：

name = "您的项目名称"
main = "src/index.ts"
compatibility_date = "2022-11-07"
node_compat = true

[[ d1_databases ]]
binding = "DB"
database_name = "您的数据库名称"
database_id = "您的数据库 ID"
migrations_dir = "drizzle"

第三步 - 将 Drizzle ORM 连接到数据库

import { drizzle } from 'drizzle-orm/d1';

export interface Env {
  <BINDING_NAME>: D1Database;
}
export default {
  async fetch(request: Request, env: Env) {
    const db = drizzle(env.<BINDING_NAME>);
  },
};

第四步 - 生成 wrangler 类型定义

npm

yarn

pnpm

bun

npx wrangler types

yarn wrangler types

pnpm wrangler types

bunx wrangler types

该命令的输出将是一个 worker-configuration.d.ts 文件。

第五步 - 创建一个表

在 src/db 目录下创建一个 schema.ts 文件，并声明你的数据表：

import { int, sqliteTable, text } from "drizzle-orm/sqlite-core";

export const usersTable = sqliteTable("users_table", {
  id: int().primaryKey({ autoIncrement: true }),
  name: text().notNull(),
  age: int().notNull(),
  email: text().notNull().unique(),
});

第六步 - 设置 Drizzle 配置文件

Drizzle 配置 - 一个供 Drizzle Kit 使用的配置文件，包含有关您的数据库连接、迁移文件夹和模式文件的所有信息。

在项目根目录创建一个 drizzle.config.ts 文件，并添加以下内容：

import 'dotenv/config';
import { defineConfig } from 'drizzle-kit';

export default defineConfig({
  out: './drizzle',
  schema: './src/db/schema.ts',
  dialect: 'sqlite',
  driver: 'd1-http',
  dbCredentials: {
    accountId: process.env.CLOUDFLARE_ACCOUNT_ID!,
    databaseId: process.env.CLOUDFLARE_DATABASE_ID!,
    token: process.env.CLOUDFLARE_D1_TOKEN!,
  },
});

提示

您可以查看我们的教程，了解如何从 CloudFlare 获取环境变量

第七步 - 将更改应用于数据库

您可以使用 drizzle-kit push 命令直接将更改应用到数据库中。这是一种方便的方法，适合在本地开发环境中快速测试新的架构设计或修改，允许快速迭代而无需管理迁移文件：

npx drizzle-kit push

在文档中了解更多关于 push 命令的信息。

小贴士

或者，您可以使用 drizzle-kit generate 命令生成迁移文件，然后使用 drizzle-kit migrate 命令应用这些迁移：

生成迁移：

npx drizzle-kit generate

应用迁移：

npx drizzle-kit migrate

在文档中了解更多关于迁移流程的信息。

第八步 - 初始化并查询数据库

import { drizzle } from 'drizzle-orm/d1';

export interface Env {
  <BINDING_NAME>: D1Database;
}
export default {
  async fetch(request: Request, env: Env) {
    const db = drizzle(env.<BINDING_NAME>);
    const result = await db.select().from(users).all()
    return Response.json(result);
  },
};

第九步 - 运行 index.ts 文件

要运行任何 TypeScript 文件，你有几种选择，但我们这里先专注于一种：使用 tsx

你已经安装了 tsx，所以现在可以运行我们的查询了

运行 index.ts 脚本

npm

yarn

pnpm

bun

npx tsx src/index.ts

yarn tsx src/index.ts

pnpm tsx src/index.ts

bunx tsx src/index.ts

提示

我们建议使用 bun 来运行 TypeScript 文件。使用 bun，无论你的项目是配置为 CommonJS（CJS）、ECMAScript 模块（ESM）还是其他模块格式，这类脚本都可以顺利运行，无需额外设置或调整。
使用 bun 运行脚本，执行以下命令：

bun src/index.ts

如果你还没有安装 bun，请查看 Bun 安装文档