# @dreaminhex/hexdb 中文文档

规范地址：https://npmcn.com/package/%40dreaminhex/hexdb/

版本：2\.5\.1
npm 元数据更新时间：2026-11-13T02:38:20.289Z
中文译文更新时间：2026-11-12T22:22:55.675Z
软件包许可：Apache-2\.0

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

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

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

- 包体积（解压后）：47.6 kB，6 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=18
- 运行依赖：0 个
- 首次发布：2026-10-09T20:51:21.630Z
- 最新版本发布：2026-11-13T02:38:20.137Z
- 近 30 天下载量：3991（2026-10-13 至 2026-11-11，npm 官方下载统计）
- 已发布版本数：25（近 12 个月 25 个）

## 中文简介

HexDB 客户端 六边形文档数据库 .

## 安装

```sh
npm install @dreaminhex/hexdb
```

也可以使用：`pnpm add @dreaminhex/hexdb`、`yarn add @dreaminhex/hexdb`、`bun add @dreaminhex/hexdb`

## README

# @dreaminhex/高血压

JavaScript 和 TypeScript 客户端 [十六进制](https://github.com/dreaminhex/hexdb),一个带有 REST, GraphQL 和只读 SQL 的文档数据库,在休息时进行加密并使用自动失效复制.

它涵盖文档(插入,获取,替换,补丁,删除),有过滤器的查询,排序和呼呼,计数,汇总,上行,解密金库令牌,交易,一能键,更改种子,流,函数和GraphQL. 重试 `429` 财务报告和审定财务报表 `503` 对读取的答案,以及对带有一能键的写取的答案. 在Node.js 18+,Deno,Bun和浏览器中运行,没有依赖性.

```sh
npm install @dreaminhex/hexdb
```

```ts
import { HexDB } from "@dreaminhex/hexdb"

const db = new HexDB({ url: "http://127.0.0.1:7700", apiKey: process.env.HEXDB_API_KEY })
const orders = db.tessellation("orders")
await orders.insert({ customer: "ada", total: 12 })
const page = await orders.query({ filter: { total: { $gt: 10 } }, sort: "-total" })
```

在管理 UI 账户页面上创建 API 密钥 。 连接 URI 也有效, 与其他 HexDB 驱动程序相同 :

```ts
const db = new HexDB(process.env.HEXDB_URI!)              // e.g. hexdbs://db.example.com?apiKey=hxk_...
const db2 = await HexDB.connect("hexdbs://ada:pw@db.example.com")  // signs in now; new HexDB(uri) signs in on first use
```

`parseConnectionUri` 财务报告和审定财务报表 `redactConnectionUri` 用于存储 URI 的工具。 这个 [司机文档](https://github.com/dreaminhex/hexdb/tree/main/drivers) 编辑 [手动](https://github.com/dreaminhex/hexdb/blob/main/MANUAL.md) 掩护其他的 根据Apache许可证2.0获得许可.

## 常见问题

### @dreaminhex/hexdb 是什么？

HexDB 客户端 六边形文档数据库 \.

### 如何安装 @dreaminhex/hexdb？

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

### @dreaminhex/hexdb 支持 TypeScript 吗？

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

### @dreaminhex/hexdb 支持 ESM 还是 CommonJS？

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

### @dreaminhex/hexdb 需要什么版本的 Node\.js？

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

### @dreaminhex/hexdb 可以商用吗？

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

### @dreaminhex/hexdb 的下载量有多少？

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

### @dreaminhex/hexdb 还在维护吗？

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