对于 Vercel Postgres，将变量命名为 `POSTGRES_URL` 非常重要。
在 Vercel Postgres 存储选项卡中，您可以找到 `.env.local` 选项卡并复制 `POSTGRES_URL` 变量。
Drizzle 与 Vercel Postgres 快速入门
本指南假定您熟悉
基本文件结构
这是项目的基本文件结构。在 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 @vercel/postgres dotenv
npm i -D drizzle-kit tsx步骤 2 - 设置连接变量
在项目的根目录中创建 .env 文件，并添加你的数据库连接变量
POSTGRES_URL=警告
第 3 步 - 将 Drizzle ORM 连接到数据库
在 src 目录中创建 index.ts 文件并初始化连接
import { drizzle } from 'drizzle-orm/vercel-postgres';
const db = drizzle();如果您需要提供现有驱动程序
import { sql } from '@vercel/postgres';
import { drizzle } from 'drizzle-orm/vercel-postgres';
const db = drizzle({ client: sql })第 4 步 - 创建表
在 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(),
});第 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: 'postgresql',
dbCredentials: {
url: process.env.POSTGRES_URL!,
},
});第 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 'dotenv/config';
import { eq } from 'drizzle-orm';
import { drizzle } from 'drizzle-orm/vercel-postgres';
import { usersTable } from './db/schema';
async function main() {
const db = drizzle();
const user: typeof usersTable.$inferInsert = {
name: 'John',
age: 30,
email: '[email protected]',
};
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();第 8 步 - 运行 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 安装文档