drizzle-kit check
本指南假定您已熟悉:
drizzle-kit check 命令可让你检查已生成的 SQL migrations 历史记录的一致性。
当你有多个开发者在项目中协作,并且在不同分支上修改数据库 schema 时,这个功能非常有用 - 了解更多关于 团队 migrations。
drizzle-kit check 命令要求你同时指定 dialect 和数据库连接凭据,
你可以通过 drizzle.config.ts 配置文件或 CLI 选项提供它们
使用配置文件
作为 CLI 选项
// drizzle.config.ts
import { defineConfig } from "drizzle-kit";
export default defineConfig({
dialect: "singlestore",
});npx drizzle-kit check一个项目中的多个配置文件
当你有多个数据库阶段或同一个项目中有多个数据库时,你可以在项目中使用多个配置文件,这非常有用:
npm
yarn
pnpm
bun
npx drizzle-kit check --config=drizzle-dev.config.ts
npx drizzle-kit check --config=drizzle-prod.config.ts
📦 <项目根目录>
├ 📂 drizzle
├ 📂 src
├ 📜 .env
├ 📜 drizzle-dev.config.ts
├ 📜 drizzle-prod.config.ts
├ 📜 package.json
└ 📜 tsconfig.json扩展配置列表
我们建议通过 drizzle.config.ts 文件来配置 drizzle-kit,
不过在必要时你也可以通过 CLI 提供所有配置选项,例如在 CI/CD 流水线等场景中。
dialect | required | 你正在使用的数据库方言。可以是 postgresql、mysql、sqlite 或 singlestore |
out | migrations 文件夹,默认=./drizzle | |
config | 配置文件路径,默认=drizzle.config.ts |
npm
yarn
pnpm
bun
npx drizzle-kit check --dialect=singlestore
npx drizzle-kit check --dialect=singlestore --out=./migrations-folder