v1.0
94%
Benchmarks
Extension
Studio
Studio Package
Gateway
Drizzle Run
Our goodies!
Lokalise
Replit
Sentry
Sevalla
GibsonAI
Clerk
Warp
Vercel
Turso
🚀 Drizzle is giving you 10% off Turso Scaler and Pro for 1 Year 🚀
Payload
Xata
Neon
Nuxt
SQLite Cloud
Upstash
Sponsor
Meet Drizzle
Get started

开始使用 Drizzle 和 Supabase

本指南假定您已熟悉：

基本文件结构

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

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

第一步 - 安装 postgres 包

npm
yarn
pnpm
bun 
npm i drizzle-orm postgres dotenv
npm i -D drizzle-kit tsx

第二步 - 设置连接变量

在你的项目根目录下创建一个 .env 文件，并添加你的数据库连接变量：

DATABASE_URL=

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

在 src 目录下创建一个 index.ts 文件并初始化连接：

index.ts
import { drizzle } from 'drizzle-orm'

async function main() {
    const db = drizzle('postgres-js', process.env.DATABASE_URL);
}

main();

如果需要同步连接，可以使用我们的额外连接 API， 在其中指定驱动连接并传入 Drizzle 实例。

index.ts
import { drizzle } from 'drizzle-orm/postgres-js'
import postgres from 'postgres'

async function main() {
    const client = postgres(process.env.DATABASE_URL)
    const db = drizzle({ client });
}

main();
提示

如果你决定通过 Supabase 使用连接池（详见 这里），且启用了“Transaction”池模式，请确保关闭 prepare，因为预处理语句不被支持。

index.ts
import { drizzle } from 'drizzle-orm/postgres-js'
import postgres from 'postgres'

async function main() {
    // 由于“Transaction”池模式不支持，需禁用 prepare
    const client = postgres(process.env.DATABASE_URL, { prepare: false })
    const db = drizzle({ client });
}

main();

第四步 - 创建一个表

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

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 文件，并添加以下内容：

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 文件，添加用于创建、读取、更新和删除用户的查询。

src/index.ts
import 'dotenv/config';
import { drizzle } from 'drizzle-orm/postgres-js';
import { eq } from 'drizzle-orm';
import { usersTable } from './db/schema';
  
const db = drizzle(process.env.DATABASE_URL!);

async function main() {
  const user: typeof usersTable.$inferInsert = {
    name: 'John',
    age: 30,
    email: 'john@example.com',
  };

  await db.insert(usersTable).values(user);
  console.log('New user created!')

  const users = await db.select().from(usersTable);
  console.log('Getting all users from the database: ', users)
  /*
  const users: {
    id: number;
    name: string;
    age: number;
    email: string;
  }[]
  */

  await db
    .update(usersTable)
    .set({
      age: 31,
    })
    .where(eq(usersTable.email, user.email));
  console.log('User info updated!')

  await db.delete(usersTable).where(eq(usersTable.email, user.email));
  console.log('User deleted!')
}

main();

第八步 - 运行 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 安装文档