# @boxdb/drizzle-adapter 中文文档

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

版本：0\.7\.0
npm 元数据更新时间：2026-10-30T20:52:15.664Z
中文译文更新时间：2026-11-09T20:22:25.757Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40boxdb/drizzle-adapter
原文对照：https://npmcn.com/package/%40boxdb/drizzle-adapter/?lang=original
项目主页：https://lebedev-nikita.github.io/boxdb/
源码仓库：https://github.com/lebedev-nikita/boxdb

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

- 包体积（解压后）：25.9 kB，7 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=22\.18\.0
- 运行依赖：0 个
- peer 依赖：drizzle-orm ^0\.45\.4，@boxdb/client ^0\.7\.0
- 首次发布：2026-10-15T08:04:18.945Z
- 最新版本发布：2026-10-30T20:52:15.328Z
- 近 30 天下载量：1750（2026-10-09 至 2026-11-07，npm 官方下载统计）
- 已发布版本数：15（近 12 个月 15 个）

## 中文简介

BoxDB 同步 Drizzle ORM 适配器

## 安装

```sh
npm install @boxdb/drizzle-adapter
```

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

## README

# 用于 Drizzle 的 BoxDB 适配器

Drizzle 0.45.x的同步 SQLite驱动程序. 安装 `@boxdb/client`, (中文(简体) ), `@boxdb/drizzle-adapter`,以及 `drizzle-orm`。 。 。 .

```sh
npm install @boxdb/client @boxdb/drizzle-adapter drizzle-orm
```

```ts
import { BoxDB } from "@boxdb/client";
import { createDrizzleDatabase, migrate } from "@boxdb/drizzle-adapter";
import { integer, sqliteTable, text } from "drizzle-orm/sqlite-core";

const users = sqliteTable("users", {
  id: integer().primaryKey({ autoIncrement: true }).$type<bigint>(),
  name: text().notNull(),
});
await using client = await BoxDB.open("data.db");
const db = createDrizzleDatabase(client, { schema: { users } });
await migrate(db, { migrationsFolder: "./drizzle" });
const rows = await db.insert(users).values({ name: "Ada" }).returning();
```

驱动程序支持关系查询,加入,准备 Drizzle查询, `RETURNING`原子 `batch`Drizzle 交易回调使用 BoxDB 内部交易处理; 嵌入式调用符。 你也可以这样 将已有的 BoxDB 交易传递给 `createDrizzleDatabase`。 。 。 .

写入元数据和整数单元格仍为大写. 使用 `integer().$type<bigint>()` 用于 Drizzle 整数列。 布尔列映射到布尔和时间戳 列映射到 Date,而不转换不相关的整数单元格。 移徙 使用 INTEGER 日记,并在一次交易中应用 SQL 和日记项.

适配器借钱 `$client`; 关闭自己或使用 `await using`。 。 。 . 对于跨 Drizzle 工作的取消, 打开 BoxDB 交易, 并带有信号 并用手柄创建 Drizzle 数据库。 基本客户所有权规则 混合 Drizzle 和直接 SQL 时适用.

## 框数据库列

使用适配器的列构建器声明扩展类型 :

```ts
import { decimal, instant, json, uuid } from "@boxdb/drizzle-adapter";

const invoices = sqliteTable("invoices", {
  id: uuid().primaryKey(),
  amount: decimal({ precision: 20, scale: 2 }).notNull(),
  createdAt: instant("created_at").notNull(),
  details: json().$type<{ reference: string }>(),
});
```

`decimal`, (中文(简体) ), `uuid`, (中文(简体) ), `instant`, (中文(简体) ), `date`, (中文(简体) ), `time`, (中文(简体) ), `dateTime` 财务报告和审定财务报表 `interval` 使用字符串 参数和结果。 BoxDB 验证并规范所声明的值 SQL 列; 精确的小数和时间微秒存活不转换 改为 JavaScript 编号或日期。 构建者披露本地 SQL 声明 出谋划策. `time("opens")` 使用诸如 `"09:30:00.000000"` 没有日期或区域。 通过 BoxDB 迁移创建匹配列 .

`json` 序列化和剖析客户端中的完整文档. `$type<T>()` 描述应用程序类型;它不会在运行时验证该形状. SQL NULL 遗存 `null`. JSON/JSONB SQL检查和编辑没有支持.

## 常见问题

### @boxdb/drizzle-adapter 是什么？

BoxDB 同步 Drizzle ORM 适配器

### 如何安装 @boxdb/drizzle-adapter？

在项目目录运行 npm install @boxdb/drizzle-adapter，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：drizzle-orm（^0\.45\.4）、@boxdb/client（^0\.7\.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @boxdb/drizzle-adapter 支持 TypeScript 吗？

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

### @boxdb/drizzle-adapter 支持 ESM 还是 CommonJS？

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

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

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

### @boxdb/drizzle-adapter 可以商用吗？

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

### @boxdb/drizzle-adapter 的下载量有多少？

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

### @boxdb/drizzle-adapter 还在维护吗？

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