# @drizzle-lab/api 中文文档

规范地址：https://npmcn.com/package/%40drizzle-lab/api/

版本：0\.30\.2
npm 元数据更新时间：2025-01-25T17:19:43.397Z
中文译文更新时间：2026-11-13T04:27:16.758Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40drizzle-lab/api
原文对照：https://npmcn.com/package/%40drizzle-lab/api/?lang=original
项目主页：https://github.com/rphlmr/drizzle-lab#readme
源码仓库：https://github.com/rphlmr/drizzle-lab

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：1.7 MB，81 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- Node.js 要求：\>=20\.0\.0
- 运行依赖：5 个
- peer 依赖：@electric-sql/pglite \>=0\.2\.0，@libsql/client-wasm \>=0\.9\.0，drizzle-kit \>=0\.26，drizzle-orm \>=0\.36，mysql2 \>=3\.0\.0
- 首次发布：2024-11-17T13:58:48.091Z
- 最新版本发布：2025-01-25T17:19:43.205Z
- 近 30 天下载量：2322（2026-10-13 至 2026-11-11，npm 官方下载统计）
- 已发布版本数：8（近 12 个月 0 个）

## 中文简介

Drizzle Lab API - Drizzle Kit API的叉子

## 安装

```sh
npm install @drizzle-lab/api
```

也可以使用：`pnpm add @drizzle-lab/api`、`yarn add @drizzle-lab/api`、`bun add @drizzle-lab/api`

## README

# @ rizzle- lab/ api

Drizzle Kit API叉 -- -- 增强功能,用于图案记录和可视化.

> \[大 这个包是一个基于Drizzle Kit的社区项目.
> 
> 我建议使用 [滴滴图案](https://github.com/drizzle-team/drizzle-kit) 尽可能多.

## 安装

```bash
npm install @drizzle-lab/api
```

## 特征

-   从文件或数据库导入计划
-   用类似 JSDoc 的语法记录您的计划
-   从 Drizzle 对象生成快照
-   QQL 从计划生成
-   QQ 从方案生成类型脚本
-   对 PostgreSQL 、 MySQL 和 SQLite 的支持

## API 参考

### 扩展

记录您的计划 `explain` 函数.

工作桌和观点.

```typescript
import { explain } from "@drizzle-lab/api/extensions";
import { pgTable, text, jsonb } from "drizzle-orm/pg-core";

export const users = pgTable("users", {
  id: text("id").primaryKey(),
  name: text("name").notNull(),
  metadata: jsonb("metadata").$type<{ role: string }>(),
});

explain(users, {
  description: "Users table storing core user information",
  columns: {
    id: "Unique identifier for the user",
    name: "User's full name",
    metadata: "Additional user metadata stored as JSON",
  },
  jsonShapes: {
    metadata: {
      role: "string",
    },
  },
});
```

### 邮递SQL API

导入并转换 PostgreSQL 计划 :

```typescript
import { importDrizzleConfig } from "@drizzle-lab/api/config/node";
import { importFromFiles } from "@drizzle-lab/api/pg/node";
import { 
  importFromDatabase, 
  schemaToSql, 
  snapshotToTypeScript,
  drizzleObjectsToSnapshot
} from "@drizzle-lab/api/pg";

// Import schema from config
const config = await importDrizzleConfig();
const drizzleObjects = await importFromFiles(config.schema);

// Import schema from database
const snapshot = drizzleObjectsToSnapshot(drizzleObjects, config);

// Generate SQL
const sql = schemaToSql(schema);

// Generate TypeScript
const ts = snapshotToTypeScript(snapshot, "preserve");
```

### MySQL API 数据

导入并转换 MySQL 计划 :

```typescript
import { importDrizzleConfig } from "@drizzle-lab/api/config/node";
import { importFromFiles } from "@drizzle-lab/api/mysql/node";
import { 
  importFromDatabase, 
  schemaToSql, 
  snapshotToTypeScript,
  drizzleObjectsToSnapshot
} from "@drizzle-lab/api/mysql";

// Import schema from config
const config = await importDrizzleConfig();
const drizzleObjects = await importFromFiles(config.schema);

// Generate snapshot
const snapshot = drizzleObjectsToSnapshot(drizzleObjects, config);
    
// Generate SQL
const sql = schemaToSql(schema);

// Generate TypeScript
const ts = snapshotToTypeScript(snapshot, "preserve");
```

### SQLite API 数据

导入并转换 SQLite 计划 :

```typescript
import { importDrizzleConfig } from "@drizzle-lab/api/config/node";
import { importFromFiles } from "@drizzle-lab/api/sqlite/node";
import { 
  importFromDatabase, 
  schemaToSql, 
  snapshotToTypeScript,
  drizzleObjectsToSnapshot
} from "@drizzle-lab/api/sqlite";

// Import schema from config
const config = await importDrizzleConfig();
const drizzleObjects = await importFromFiles(config.schema);

// Generate snapshot
const snapshot = drizzleObjectsToSnapshot(drizzleObjects, config);

// Generate SQL
const sql = schemaToSql(schema);

// Generate TypeScript
const ts = snapshotToTypeScript(snapshot, "preserve");
```

### (可选)扩展配置

```typescript
export default defineConfig({
  // ...
  lab: {
    projectId: "drizzle-lab", // optional, defaults to "drizzle-lab". Used to identify the project in json output
  },
});
```

## 环境变量

这些都是可选的.

| 变量 | 说明 | 默认 |
| --- | --- | --- |
| `DRIZZLE_LAB_DEBUG` | 启用调试日志 | `false` |
| `DRIZZLE_LAB_CWD` | 工作目录 | `""` |
| `DRIZZLE_LAB_CONFIG_PATH` | 配置文件的路径 | `drizzle.config.ts` |
| `DRIZZLE_LAB_SAVE_DIR` | 要保存输出的目录 | `./drizzle` |
| `DRIZZLE_LAB_PROJECT_ID` | 在 json 输出中识别项目的项目 ID | `drizzle-lab` |
| `TS_CONFIG_PATH` | Tsconfig.json 路径 | `./tsconfig.json` |
| `DRIZZLE_LAB_ENV_FILE_PATH` | Env 文件路径 | `undefined` |

## 许可证

麻省理工学院

## 常见问题

### @drizzle-lab/api 是什么？

Drizzle Lab API - Drizzle Kit API的叉子

### 如何安装 @drizzle-lab/api？

在项目目录运行 npm install @drizzle-lab/api，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：@electric-sql/pglite（\>=0\.2\.0）、@libsql/client-wasm（\>=0\.9\.0）、drizzle-kit（\>=0\.26）、drizzle-orm（\>=0\.36）、mysql2（\>=3\.0\.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @drizzle-lab/api 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @drizzle-lab/api 支持 ESM 还是 CommonJS？

同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。

### @drizzle-lab/api 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js \>=20\.0\.0。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @drizzle-lab/api 可以商用吗？

@drizzle-lab/api 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @drizzle-lab/api 的下载量有多少？

根据 npm 官方下载统计，@drizzle-lab/api 在 2026/10/13 – 2026/11/11 这 30 天内被下载 2,322 次，日均约 77 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @drizzle-lab/api 还在维护吗？

最新版本 0\.30\.2 发布于 2025/01/26（1\.8 年前）；至今共发布 8 个版本，其中过去 12 个月发布了 0 个；首次发布于 2024/11/17。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。