drizzle-kit 是 Drizzle ORM 的命令行工具,用于管理数据库 schema、迁移和数据库操作。以下内容依据其命令与说明整理。
用途 主要用于在 Drizzle ORM 项目中处理 schema 与数据库之间的同步:生成迁移文件、执行迁移、直接推送 schema、反解析数据库结构,以及提供图形化数据库浏览界面。
安装与配置 可全局安装:npm i -g drizzle-kit;也可作为开发依赖安装:npm i -D drizzle-kit,并通过 npx drizzle-kit 调用。安装后可用 drizzle-kit --version 验证。使用前需要项目根目录存在 drizzle.config.ts 配置文件。
迁移相关命令
- drizzle-kit generate:根据 schema 变更生成 SQL 迁移文件。
- drizzle-kit generate --name init:生成带名称的迁移。
- drizzle-kit migrate:应用待执行的迁移。
- drizzle-kit drop:删除此前生成的某个迁移。
- drizzle-kit up:把此前生成的迁移升级为新格式。
- drizzle-kit check:检查 schema 与迁移文件之间的一致性。
数据库操作
- drizzle-kit push:不生成迁移文件,直接把 schema 变更推送到数据库。
- drizzle-kit pull:反解析(introspect)数据库并生成 schema 文件。
Studio drizzle-kit studio 打开 Drizzle Studio 图形界面用于浏览数据库;drizzle-kit studio --port 3001 可指定端口打开。
全局参数
- --config <path>:指定 drizzle 配置文件的路径。
- --dialect <dialect>:数据库方言(postgresql、mysql、sqlite)。
- --verbose:输出详细信息。
适用场景 适合使用 Drizzle ORM 的项目进行迁移生成与应用、schema 同步、从现有数据库生成 schema,以及通过图形界面查看数据库内容。
限制 现有资料仅说明需要 drizzle.config.ts 配置文件,以及支持 postgresql、mysql、sqlite 三种方言;关于具体配置写法、版本要求、各命令的详细参数和错误处理等,暂未提供。