# @queria-io/fdl-js 中文文档

规范地址：https://npmcn.com/package/%40queria-io/fdl-js/

版本：0\.1\.0
npm 元数据更新时间：2026-11-02T06:15:34.880Z
中文译文更新时间：2026-11-02T06:37:51.517Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：67.8 kB，23 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=20
- 运行依赖：2 个
- 首次发布：2026-11-02T06:12:26.242Z
- 最新版本发布：2026-11-02T06:15:34.722Z
- 已发布版本数：2（近 12 个月 2 个）

## 中文简介

读取作为FDL存储库发布的DuckLake表，没有DuckDB: resolve refs，列出一个版本的文件并按范围读取Parquet

## 安装

```sh
npm install @queria-io/fdl-js
```

也可以使用：`pnpm add @queria-io/fdl-js`、`yarn add @queria-io/fdl-js`、`bun add @queria-io/fdl-js`

## README

# fdl-js

阅读发布的DuckLake表 [FDL](https://fdl.flo8s.com/) 没有DuckDB的JavaScript存储库：解析一个ref到一个版本，列出它的表的数据文件 `files.json`，并按范围读取Parquet文件 [hyparquet](https://github.com/hyparam/hyparquet)． 它运行在Cloudflare Workers、浏览器和Node中。

它读取;它不会写字。它只读取文件可以按原样读取的表：拒绝删除行或重命名列的表，因为在没有编目的情况下读取其Parquet文件将返回已删除的行或遗漏的列。请使用DuckDB阅读。

## 安装

```bash
npm install @queria-io/fdl-js
```

它是一个具有类型定义的ES模块，适用于Node 20或更高版本以及任何捆绑器。

## 使用

```ts
import { httpStore, open, openParquet, readWhere, tableFiles } from "@queria-io/fdl-js";

const store = httpStore("https://data.example.org/towns/");
const version = await open(store); // HEAD, or open(store, "2025-final"), or a version ID
const [file] = tableFiles(version, "main.town") ?? [];
const parquet = await openParquet(store, file);
const rows = await readWhere(parquet, "lg_code", "131016", ["name"]);
```

`readWhere` 仅读取min/max可以保存该值的行组，因此它从按该列排序的文件中读取的内容很少。

## 商店

存储是存储库的根所在的位置。键是布局的路径(`fdl.json`， `refs/heads/main`， `versions/<ID>/files.json`， `data/...`）。

| 商店 | 读取从 |
| --- | --- |
| `httpStore(root, { fetch, headers })` | URL，带 `Range` 请求 |
| `r2Store(bucket, prefix)` | worker中的R2绑定 |
| `fileStore(dir)` 从 `@queria-io/fdl-js/node` | 本地文件夹 |

每个请求都会重试一次失败的请求。一个仓库有三个功能(`text`， `size`， `range`)，所以另一个是几行。

## 缓存

-   参移动。 `refreshing(() => open(store), 5 * 60_000)` 保留五分钟的版本，并保留最后一个版本，当一个ref不能读取一会儿
-   数据文件永远不会改变，所以它们的页脚可以永远保存：pass `{ cache: cacheApiFooterCache(caches.default) }` (工人)或 `memoryFooterCache()` 来 `openParquet`． 与 `footer_bytes` 在 `files.json`，一个未缓存页脚是一个读取

## 接下来是什么

[阅读](https://fdl.flo8s.com/spec/reading) 在规范中： `HEAD` 裁判紧随其后， `version.json` 必须命名自己的ID和已知的 `fdl` 主版本，有版本 `expired.json` 被拒绝，文件路径从 `files.json` 如下所示 `data_dir`． 没有的版本 `files.json` 这个库无法读取。

## 开发

```bash
pnpm install
pnpm test
pnpm typecheck
pnpm check
pnpm build       # dist/
```

要释放，请设置 `version` 在 `package.json` 在pull请求中，合并它，并推送标签 `v<version>`． 发布工作流将它发布到npm。

`test/fixture/repo` 小仓库是由 `fdl` 命令: `FDL=fdl test/make-fixture.sh` 重塑。

## 常见问题

### @queria-io/fdl-js 是什么？

读取作为FDL存储库发布的DuckLake表，没有DuckDB: resolve refs，列出一个版本的文件并按范围读取Parquet

### 如何安装 @queria-io/fdl-js？

在项目目录运行 npm install @queria-io/fdl-js，或使用 pnpm add / yarn add / bun add。

### @queria-io/fdl-js 支持 TypeScript 吗？

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

### @queria-io/fdl-js 支持 ESM 还是 CommonJS？

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

### @queria-io/fdl-js 需要什么版本的 Node\.js？

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

### @queria-io/fdl-js 可以商用吗？

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

### @queria-io/fdl-js 还在维护吗？

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