或者,你可以使用 drizzle-kit generate
命令生成迁移,然后使用 drizzle-kit migrate
命令应用它们
生成迁移
npx drizzle-kit generate
应用迁移
npx drizzle-kit migrate
在文档中阅读更多关于迁移过程的信息。
这是项目的基本文件结构。在 src/db
目录中,我们在 schema.ts
中定义了表。在 drizzle
文件夹中,包含 SQL 迁移文件和快照。
📦 <project root>
├ 📂 drizzle
├ 📂 src
│ ├ 📂 db
│ │ └ 📜 schema.ts
│ └ 📜 index.ts
├ 📜 .env
├ 📜 drizzle.config.ts
├ 📜 package.json
└ 📜 tsconfig.json
npm i drizzle-orm @xata.io/client dotenv
npm i -D drizzle-kit tsx
在项目的根目录中创建 .env
文件,并添加你的数据库连接变量
DATABASE_URL=
要生成 Xata 客户端,请参考 Xata 文档
在 src
目录中创建 index.ts
文件并初始化连接
import { drizzle } from 'drizzle-orm/xata-http';
import { getXataClient } from './xata'; // Generated client
async function main() {
const xata = getXataClient();
const db = drizzle(xata);
}
main();
在 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 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.DATABASE_URL!,
},
});
你可以直接使用 drizzle-kit push
命令将更改应用到数据库。这是一种便捷的方法,可在本地开发环境中快速测试新的 schema 设计或修改,从而实现快速迭代,而无需管理迁移文件。
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 { eq } from 'drizzle-orm';
import { drizzle } from 'drizzle-orm/xata-http';
import { getXataClient } from './xata';
import { usersTable } from './db/schema';
async function main() {
const xata = getXataClient();
const db = drizzle(xata);
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();
要运行任何 TypeScript 文件,你有多种选择,但我们只使用一种:使用 tsx
你已经安装了 tsx
,所以我们现在可以运行查询了
运行 index.ts
脚本
npx tsx src/index.ts
我们建议使用 bun
来运行 TypeScript 文件。使用 bun
,此类脚本可以毫无问题或额外设置地执行,无论你的项目是配置为 CommonJS (CJS)、ECMAScript Modules (ESM) 还是任何其他模块格式。要使用 bun
运行脚本,请使用以下命令
bun src/index.ts
如果你没有安装 bun,请查看 Bun 安装文档