本页面解释了自 drizzle 版本 1.0.0-beta.13 及更高版本中可用的概念。
Effect 目前仅支持 PostgreSQL，其他方言支持即将实现。
关于升级的更多信息（详见这里）
使用 Drizzle 和 Effect PostgreSQL 快速开始
WARNING
本指南假定您已熟悉：
Drizzle 原生支持使用 @effect/sql-pg 驱动的 Effect PostgreSQL 连接。
基本文件结构
这是项目的基本文件结构。在 src/db 目录中，我们在 schema.ts 中有表定义。在 drizzle 文件夹中，有 SQL 迁移文件和快照。
📦 <project root>
├ 📂 drizzle
├ 📂 src
│ ├ 📂 db
│ │ └ 📜 schema.ts
│ └ 📜 index.ts
├ 📜 .env
├ 📜 drizzle.config.ts
├ 📜 package.json
└ 📜 tsconfig.json第一步 - 安装 node-postgres 包
npm
yarn
pnpm
bun
npm i drizzle-orm effect @effect/sql-pg pg dotenv
npm i -D drizzle-kit tsx @types/pg第二步 - 设置连接变量
在你的项目根目录下创建一个 .env 文件，并添加你的数据库连接变量：
DATABASE_URL=技巧
如果你还没有 PostgreSQL 数据库并且想创建一个用于测试，可以参考我们的 PostgreSQL Docker 安装指南。
PostgreSQL Docker 安装指南位于这里。按照指南完成设置，生成数据库 URL（指南中有详细说明），然后回来执行后续步骤。
第三步 - 连接 Drizzle ORM 到数据库
在 src 目录下创建一个 index.ts 文件并初始化连接：
import 'dotenv/config';
import * as PgDrizzle from 'drizzle-orm/effect-postgres';
import { PgClient } from '@effect/sql-pg';
import * as Effect from 'effect/Effect';
import * as Redacted from 'effect/Redacted';
import { types } from 'pg';
// 配置 PgClient 层及类型解析器
const PgClientLive = PgClient.layer({
url: Redacted.make(process.env.DATABASE_URL!),
types: {
getTypeParser: (typeId, format) => {
// 对日期/时间类型返回原始值，由 Drizzle 处理解析
if ([1184, 1114, 1082, 1186, 1231, 1115, 1185, 1187, 1182].includes(typeId)) {
return (val: any) => val;
}
return types.getTypeParser(typeId, format);
},
},
});
const program = Effect.gen(function*() {
// 使用默认服务创建数据库
const db = yield* PgDrizzle.makeWithDefaults();
// 这里编写你的查询...
});
// 使用 PgClient 层运行程序
Effect.runPromise(program.pipe(Effect.provide(PgClientLive)));第四步 - 创建表
在 src/db 目录下创建一个 schema.ts 文件，并声明你的数据表：
import { integer, pgTable, varchar } from "drizzle-orm/pg-core";
export const usersTable = pgTable("users", {
id: integer().primaryKey().generatedAlwaysAsIdentity(),
name: varchar({ length: 255 }).notNull(),
age: integer().notNull(),
email: varchar({ length: 255 }).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: 'postgresql',
dbCredentials: {
url: process.env.DATABASE_URL!,
},
});第六步 - 应用数据库变更
您可以使用 drizzle-kit push 命令直接将更改应用到数据库中。这是一种方便的方法，适合在本地开发环境中快速测试新的架构设计或修改，允许快速迭代而无需管理迁移文件：
npx drizzle-kit push在 文档 中了解更多关于 push 命令的信息。
小贴士
或者，您可以使用 drizzle-kit generate 命令生成迁移文件，然后使用 drizzle-kit migrate 命令应用这些迁移：
生成迁移：
npx drizzle-kit generate应用迁移：
npx drizzle-kit migrate在 文档 中了解更多关于迁移流程的信息。
第七步 - 填充并查询数据库
让我们更新 src/index.ts 文件，添加创建、读取、更新和删除用户的查询示例。
import 'dotenv/config';
import * as PgDrizzle from 'drizzle-orm/effect-postgres';
import { PgClient } from '@effect/sql-pg';
import * as Effect from 'effect/Effect';
import * as Redacted from 'effect/Redacted';
import { types } from 'pg';
import { eq } from 'drizzle-orm';
import { usersTable } from './db/schema';
const PgClientLive = PgClient.layer({
url: Redacted.make(process.env.DATABASE_URL!),
types: {
getTypeParser: (typeId, format) => {
if ([1184, 1114, 1082, 1186, 1231, 1115, 1185, 1187, 1182].includes(typeId)) {
return (val: any) => val;
}
return types.getTypeParser(typeId, format);
},
},
});
const program = Effect.gen(function*() {
const db = yield* PgDrizzle.makeWithDefaults();
const user: typeof usersTable.$inferInsert = {
name: 'John',
age: 30,
email: 'john@example.com',
};
yield* db.insert(usersTable).values(user);
console.log('用户已创建！')
const users = yield* db.select().from(usersTable);
console.log('从数据库获取到的所有用户: ', users)
/*
const users: {
id: number;
name: string;
age: number;
email: string;
}[]
*/
yield* db
.update(usersTable)
.set({
age: 31,
})
.where(eq(usersTable.email, user.email));
console.log('用户信息已更新！')
yield* db.delete(usersTable).where(eq(usersTable.email, user.email));
console.log('用户已删除！')
});
Effect.runPromise(program.pipe(Effect.provide(PgClientLive)));第八步 - 运行 index.ts 文件
要运行任何 TypeScript 文件，你有几种选择，但我们这里先专注于一种：使用 tsx
你已经安装了 tsx，所以现在可以运行我们的查询了
运行 index.ts 脚本
npm
yarn
pnpm
bun
npx tsx src/index.ts提示
我们建议使用 bun 来运行 TypeScript 文件。使用 bun，无论你的项目是配置为 CommonJS（CJS）、ECMAScript 模块（ESM）还是其他模块格式，这类脚本都可以顺利运行，无需额外设置或调整。
使用 bun 运行脚本，执行以下命令：
bun src/index.ts如果你还没有安装 bun，请查看 Bun 安装文档