Cloudflare D1

新数据库

了解 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

步骤 1 - 安装所需包

npm

yarn

pnpm

bun

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

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

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

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

步骤 2 - 设置 wrangler.toml

您需要为 D1 数据库准备一个 wrangler.toml 文件，它看起来会像这样

name = "YOUR PROJECT NAME"
main = "src/index.ts"
compatibility_date = "2022-11-07"
node_compat = true

[[ d1_databases ]]
binding = "DB"
database_name = "YOUR DB NAME"
database_id = "YOUR DB ID"
migrations_dir = "drizzle"

第 3 步 - 将 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>);
  },
};

第 4 步 - 创建表

在 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(),
});

第 5 步 - 设置 Drizzle 配置文件

Drizzle config - 由 Drizzle Kit 使用的配置文件，包含有关你的数据库连接、迁移文件夹和 schema 文件的所有信息。

在项目的根目录中创建 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 获取环境变量

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

您可以使用 drizzle-kit push 命令直接将更改应用到您的数据库。这是在本地开发环境中快速测试新 schema 设计或修改的便捷方法，无需管理迁移文件即可进行快速迭代。

npx drizzle-kit push

在文档中阅读更多关于 push 命令的信息。

提示

或者，你可以使用 drizzle-kit generate 命令生成迁移，然后使用 drizzle-kit migrate 命令应用它们

生成迁移

npx drizzle-kit generate

应用迁移

npx drizzle-kit migrate

在文档中阅读更多关于迁移过程的信息。

第 7 步 - 填充和查询数据库

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);
  },
};

第 8 步 - 运行 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

bun tsx src/index.ts

提示

我们建议使用 bun 来运行 TypeScript 文件。使用 bun，此类脚本可以无问题地执行，无需额外设置，无论您的项目是配置为 CommonJS (CJS)、ECMAScript Modules (ESM) 还是任何其他模块格式。要使用 bun 运行脚本，请使用以下命令

bun src/index.ts

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