# @cloudhal/storage 中文文档

规范地址：https://npmcn.com/package/%40cloudhal/storage/

版本：0\.6\.5
npm 元数据更新时间：2026-11-08T22:21:35.312Z
中文译文更新时间：2026-11-10T03:29:01.728Z
软件包许可：Apache-2\.0

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

原始 npm 页面：https://www.npmjs.com/package/%40cloudhal/storage
原文对照：https://npmcn.com/package/%40cloudhal/storage/?lang=original
项目主页：https://cloudhal.dev/
源码仓库：https://github.com/cloudhal-dev/cloudhal

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

- 包体积（解压后）：174 kB，93 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=24
- 运行依赖：1 个
- peer 依赖：vitest \>=3\.0\.0，miniflare \*，better-sqlite3 ^13\.0\.0
- 首次发布：2026-10-20T10:49:49.228Z
- 最新版本发布：2026-11-08T22:21:34.979Z
- 近 30 天下载量：5352（2026-10-10 至 2026-11-08，npm 官方下载统计）
- 已发布版本数：26（近 12 个月 26 个）

## 中文简介

有 Cloudflare D1/R2/ Dubable Object SQLite 和本地的 SQLite/文件系统适配器的 Cloudhal 存储接口( SQL 驱动程序, blob store)

## 安装

```sh
npm install @cloudhal/storage
```

也可以使用：`pnpm add @cloudhal/storage`、`yarn add @cloudhal/storage`、`bun add @cloudhal/storage`

## README

# @ cloudhal/ 储存

Cloudhal的存储接口和适配器. 界面由最受限后端Cloudflare D1所塑造: **无交互式交易**原子 `batch()` 只有,并且每个适配器执行D1的绑定/大小限制,所以本地行为与生产相符(ADR-0002).

| 导出 | 什麽 |
| --- | --- |
| `@cloudhal/storage` | `SqlDriver`, (中文(简体) ), `BlobStore`,限制, `migrate()`, (中文(简体) ), `migrations`, (中文(简体) ), `MemoryBlobStore`, (中文(简体) ), `SqlBlobStore` (被封入SQL表格中的块), `LayeredBlobStore` (可写上上方的只读基), `FetcherBlobStore` (只读,超过一个工人) `ASSETS` 绑定) |
| `@cloudhal/storage/sqlite` | `BetterSqlite3Driver` - 本地文件或 `:memory:` |
| `@cloudhal/storage/d1` | `D1Driver` - Cloudflare D1 装订 |
| `@cloudhal/storage/do-sqlite` | `DoSqliteDriver` - 一个SQLite支持的持久对象 `ctx.storage` (RFC-0036号); `batch` 运行在 `transactionSync` |
| `@cloudhal/storage/fs` | `FsBlobStore` 磁盘上的目录 |
| `@cloudhal/storage/r2` | `R2BlobStore` - Cloudflare R2 装订 |
| `@cloudhal/storage/testing` | 配套套房 + 小型辅助工(`createMiniflareD1`, (中文(简体) ), `createMiniflareR2`, (中文(简体) ), `createMiniflareDoSqlite`; 需要vitest 3或以后, 以及帮助者( 可选择的同伴) 的小型纸张 |

```ts
import { migrate, migrations } from "@cloudhal/storage";
import { BetterSqlite3Driver } from "@cloudhal/storage/sqlite";

const sql = await BetterSqlite3Driver.open("cloudhal.db");
await migrate(sql, migrations);
await sql.batch([
  { sql: "UPDATE nodes SET rev = rev + 1, body = ? WHERE id = ? AND rev = ?", params: [body, id, rev] },
]);
```

迁移为 TypeScript 模块 `migrations/` (Plain SQL strings) 所以他们捆绑工人 没有文件系统访问。 每次迁移都是作为一批原子进行的.

每个适配器都必须通过 `describeSqlDriverConformance` 编号 : `describeBlobStoreConformance`; D1, R2 和持久对象套件对 Miniflare( 正在工作) 运行, 因此不需要 Cloudflare 账户 . `createMiniflareDoSqlite()` 运行 `DoSqliteDriver` 在只测试的持久对象和手内 节点一个司机,每个电话都是一个请求, 超乎常存的连接,所以任何 `SqlDriver` 套件(包含分数)运行于持久对象 SQLite.

整个场地为一个持久对象(操场形状):

```ts
import { FetcherBlobStore, LayeredBlobStore, migrate, migrations, SqlBlobStore } from "@cloudhal/storage";
import { DoSqliteDriver } from "@cloudhal/storage/do-sqlite";

const sql = new DoSqliteDriver(ctx.storage);
await migrate(sql, migrations);
const blobs = new LayeredBlobStore(
  new FetcherBlobStore(env.ASSETS, "demo/"),             // read-only demo media
  new SqlBlobStore(sql, { maxBytes: 8 * 1024 * 1024 }), // the session's own blobs
);
```

## 常见问题

### @cloudhal/storage 是什么？

有 Cloudflare D1/R2/ Dubable Object SQLite 和本地的 SQLite/文件系统适配器的 Cloudhal 存储接口\( SQL 驱动程序, blob store\)

### 如何安装 @cloudhal/storage？

在项目目录运行 npm install @cloudhal/storage，或使用 pnpm add / yarn add / bun add。

### @cloudhal/storage 支持 TypeScript 吗？

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

### @cloudhal/storage 支持 ESM 还是 CommonJS？

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

### @cloudhal/storage 需要什么版本的 Node\.js？

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

### @cloudhal/storage 可以商用吗？

@cloudhal/storage 使用 Apache-2\.0 许可。宽松许可：允许商业使用、修改和再分发，并附带明确的专利授权；分发时需保留许可与 NOTICE 文件，修改过的文件要注明改动。以上为概括，不构成法律意见，请以许可原文为准。

### @cloudhal/storage 的下载量有多少？

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

### @cloudhal/storage 还在维护吗？

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