本教程中，我们将使用 database-js 驱动对 PlanetScale 数据库进行 HTTP 调用。如果您需要通过 TCP 连接到 PlanetScale，可以参考我们的 MySQL 入门 页面。
Drizzle 与 PlanetScale 入门
本指南假定您熟悉
重要提示
基本文件结构
这是项目的基本文件结构。在 src/db 目录中，我们在 schema.ts 中定义了表。在 drizzle 文件夹中，包含 SQL 迁移文件和快照。
📦 <project root>
├ 📂 drizzle
├ 📂 src
│ ├ 📂 db
│ │ └ 📜 schema.ts
│ └ 📜 index.ts
├ 📜 .env
├ 📜 drizzle.config.ts
├ 📜 package.json
└ 📜 tsconfig.json第一步 - 安装 @planetscale/database 包
npm
yarn
pnpm
bun
npm i drizzle-orm @planetscale/database dotenv
npm i -D drizzle-kit tsx步骤 2 - 设置连接变量
在项目的根目录中创建 .env 文件，并添加你的数据库连接变量
DATABASE_HOST=
DATABASE_USERNAME=
DATABASE_PASSWORD=提示
要获取通过 database-js 驱动连接所需的所有环境变量，您可以查看 PlanetScale 文档。
第 3 步 - 将 Drizzle ORM 连接到数据库
在 src/db 目录下创建 index.ts 文件并初始化连接
import { drizzle } from "drizzle-orm/planetscale-serverless";
const db = drizzle({ connection: {
host: process.env.DATABASE_HOST!,
username: process.env.DATABASE_USERNAME!,
password: process.env.DATABASE_PASSWORD!,
}});如果您需要提供现有驱动程序
import { drizzle } from "drizzle-orm/planetscale-serverless";
import { Client } from "@planetscale/database";
const client = new Client({
host: process.env.DATABASE_HOST!,
username: process.env.DATABASE_USERNAME!,
password: process.env.DATABASE_PASSWORD!,
});
const db = drizzle({ client: client });第 4 步 - 创建表
在 src/db 目录中创建 schema.ts 文件并声明你的表
import { int, mysqlTable, serial, varchar } from 'drizzle-orm/mysql-core';
export const usersTable = mysqlTable('users_table', {
id: serial().primaryKey(),
name: varchar({ length: 255 }).notNull(),
age: int().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: 'mysql',
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 文件，添加创建、读取、更新和删除用户的查询
import 'dotenv/config';
import { eq } from 'drizzle-orm';
import { drizzle } from 'drizzle-orm/planetscale-serverless';
import { usersTable } from './db/schema';
const db = drizzle({ connection: {
host: process.env.DATABASE_HOST!,
username: process.env.DATABASE_USERNAME!,
password: process.env.DATABASE_PASSWORD!,
}});
async function main() {
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 Modules (ESM) 还是任何其他模块格式。要使用 bun 运行脚本，请使用以下命令：
bun src/index.ts如果你没有安装 bun，请查看 Bun 安装文档