# @backloghq/termlog 中文文档

规范地址：https://npmcn.com/package/%40backloghq/termlog/

版本：0\.2\.0
npm 元数据更新时间：2026-05-30T12:30:51.696Z
中文译文更新时间：2026-11-07T23:43:13.199Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：288 kB，56 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=22
- 运行依赖：0 个
- 首次发布：2026-05-05T07:06:14.302Z
- 最新版本发布：2026-05-30T12:30:51.554Z
- 近 30 天下载量：2002（2026-10-08 至 2026-11-06，npm 官方下载统计）
- 已发布版本数：4（近 12 个月 4 个）

## 中文简介

日志结构的全文搜索索引——以LSM收缩为分块的发布列表,BM25排名,零原生依赖.

## 安装

```sh
npm install @backloghq/termlog
```

也可以使用：`pnpm add @backloghq/termlog`、`yarn add @backloghq/termlog`、`bun add @backloghq/termlog`

## README

# @ backloghq/ termlog (英语)

日志结构的全文搜索索引——以LSM收缩为分块的发布列表,BM25排名,零原生依赖.

## 安装

```
npm install @backloghq/termlog
```

## 使用量

```ts
import { TermLog } from "@backloghq/termlog";

const index = await TermLog.open({ dir: "./my-index" });

await index.add("doc-1", "the quick brown fox");
await index.add("doc-2", "the lazy dog");
await index.flush();

const results = await index.search("fox", { limit: 10 });
// [{ docId: "doc-1", score: 0.655... }]  (BM25 — exact value depends on corpus)

await index.remove("doc-1");
await index.close();
```

## 为什么

现有的FTS引擎(Lucene,Tantivy)需要本土的道具或JVM. 大多数纯-JS替代品将索引序列化为单个的内膜blob——对小蝎子来说是罚款的,但它们在上万个文件中击中了每个文件大小的悬崖. Termlog使用不可改变的盘子上有LSM收缩的片段,所以没有这些上限的活体表.

## 建筑

-   **张贴名单** —— 说 `term → [docId, tf]`,用 VByte / delta 编码压缩. (预留后出
-   **术语词典** ——在磁盘上排序;二进制搜索查找.
-   **部分** ——自成一体的不可移动文件(term dict + positions). 新写入创建了新段 。 收缩将N段合并为 1.
-   **查询执行** 布尔(AND/OR),通过张贴标注符(zigzag 为 和,为 OR 进行联合扫描),BM25在上方打分.
-   **存储** ——抽象通过 `StorageBackend`; 默认的本地 FS, S3 通过 [@ backloghq/ termlog- s3](https://github.com/backloghq/termlog-s3)。 。 。 .

## S3 后端

S3支助由配套软件包提供 [@ backloghq/ termlog- s3](https://github.com/backloghq/termlog-s3)数字 :

```bash
npm install @backloghq/termlog @backloghq/termlog-s3
```

```ts
import { TermLog } from "@backloghq/termlog";
import { S3Backend } from "@backloghq/termlog-s3";
import { S3Client } from "@aws-sdk/client-s3";

const index = await TermLog.open({
  dir: "my-index",
  backend: new S3Backend({
    client: new S3Client({ region: "us-east-1" }),
    bucket: "my-bucket",
    prefix: "my-index/",
  }),
});
```

见 [术语- s3 读取器](https://github.com/backloghq/termlog-s3) 用于IAM权限、生命周期规则和MinIO/LocalStack的使用.

## 选项

| 选项 | 默认 | 说明 |
| --- | --- | --- |
| `fanout` | 页:1 | 触发合并的同级线段数( 大小级 LSM) |
| `flushThreshold` | 1 000个 | 自动擦拭前的写入缓冲器 |
| `k1` | 1.2 国家 | BM25 术语饱和度参数 |
| `b` | 0.75 (简体中文) | BM25 长度规范化参数 |

## 错误

| 类 | 扔的时候 |
| --- | --- |
| `ManifestCorruptionError` | 显示. json 包含无效的 JSON |
| `ManifestVersionError` | 显示版本不在所支持的范围之内 |
| `SegmentCorruptionError` | CRC32 错配或缺失段文件 (`.region` 告诉你什么 |
| `MappingCorruptionError` | docids.snap 或 docids.log 腐败 |
| `TokenizerMismatchError` | 重开使用不同标识符配置的索引 |
| `IndexLockedError` | 另一个过程是咨询 `.lock` 文件 |
| `WriteStreamError` | 流写失败的基础类( S3 多部分等) |

## 状态

| 方法 | 回返 | 说明 |
| --- | --- | --- |
| `docCount()` | `number` | 在所有冲出部分索引的文件 |
| `segmentCount()` | `number` | 活跃的磁盘片段数 |
| `estimatedBytes()` | `number` | 近似记忆内足迹(贴出缓冲器+侧车阵列+地图);内存预算调用器的下限估计 |

## 多写/ S3 安全

术语日志是 **每个索引目录的单写器**关于当地金融服务的咨询 `.lock` 文件防止在同一进程组中同时打开。 在S3(或任何共享存储)上,没有分布式锁定——您必须确保每个索引路径最多有一个写入器.

## 许可证

麻省理工学院

## 常见问题

### @backloghq/termlog 是什么？

日志结构的全文搜索索引——以LSM收缩为分块的发布列表,BM25排名,零原生依赖\.

### 如何安装 @backloghq/termlog？

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

### @backloghq/termlog 支持 TypeScript 吗？

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

### @backloghq/termlog 支持 ESM 还是 CommonJS？

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

### @backloghq/termlog 需要什么版本的 Node\.js？

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

### @backloghq/termlog 可以商用吗？

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

### @backloghq/termlog 的下载量有多少？

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

### @backloghq/termlog 还在维护吗？

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