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 和 PlanetScale Postgres

本指南假定您已熟悉：
PlanetScale 同时支持 MySQL

在找 MySQL 吗？查看我们的PlanetScale MySQL 指南

PlanetScale 同时提供 MySQL（Vitess）和 PostgreSQL 数据库。本指南涵盖如何使用标准的 node-postgres 驱动连接 PlanetScale Postgres。

关于如何创建 PlanetScale Postgres 数据库和获取凭证的详细说明，请参阅PlanetScale 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 - 安装 node-postgres 包

npm
yarn
pnpm
bun 
npm i drizzle-orm pg dotenv
npm i -D drizzle-kit tsx @types/pg

步骤 2 - 配置连接变量

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

DATABASE_URL=postgresql://{username}:{password}@{host}:{port}/postgres?sslmode=verify-full
提示

你可以通过访问 PlanetScale 仪表板，进入你的数据库，点击 “Connect” 并创建 “Default role” 来获取连接凭证。详细步骤请参阅PlanetScale 连接指南。

步骤 3 - 连接 Drizzle ORM 到数据库

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

node-postgres
使用配置的 node-postgres
你的 node-postgres 驱动
import 'dotenv/config';
import { drizzle } from 'drizzle-orm/node-postgres';

const db = drizzle(process.env.DATABASE_URL!);
连接端口

PlanetScale Postgres 支持两个连接端口：

  • 端口 5432 — 直接连接到 PostgreSQL。总连接数受你的集群 max_connections 设置限制。
  • 端口 6432 — 通过 PgBouncer 进行连接池连接。当有大量并发连接时推荐使用。

步骤 4 - 创建数据表

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

步骤 5 - 配置 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!,
  },
});

步骤 6 - 应用数据库变更

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

npx drizzle-kit push

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

小贴士

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

生成迁移：

npx drizzle-kit generate

应用迁移：

npx drizzle-kit migrate

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

步骤 7 - 数据库种子和查询

让我们更新 src/index.ts 文件，添加用于创建、读取、更新和删除用户的查询。

src/index.ts
import 'dotenv/config';
import { drizzle } from 'drizzle-orm/node-postgres';
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();

步骤 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 安装文档