# @best/api-db 中文文档

规范地址：https://npmcn.com/package/%40best/api-db/

版本：18\.0\.1
npm 元数据更新时间：2026-10-22T22:00:59.872Z
中文译文更新时间：2026-11-07T23:33:01.917Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40best/api-db
原文对照：https://npmcn.com/package/%40best/api-db/?lang=original

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

- 包体积（解压后）：35.6 kB，19 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- Node.js 要求：\>=22\.13\.0
- 运行依赖：2 个
- 首次发布：2019-07-26T16:13:23.592Z
- 最新版本发布：2026-10-22T22:00:59.615Z
- 近 30 天下载量：3708（2026-10-08 至 2026-11-06，npm 官方下载统计）
- 已发布版本数：67（近 12 个月 4 个）

## 中文简介

最佳 Api 数据库

## 安装

```sh
npm install @best/api-db
```

也可以使用：`pnpm add @best/api-db`、`yarn add @best/api-db`、`bun add @best/api-db`

## README

# API 数据库

这是前端用于显示结果的数据库适配器. 每当基准运行时,结果都会被存储.

下面可以找到使用 Postgres 或 SQLite 的指令 。 默认情况下, Best 使用本地 SQLite 文件, 但是我们建议使用 Postgres, 如果您运行在本地机器以外的任何设备上 .

## SQL 点

SQLite 是默认配置的, 但是如果您想要提供自定义路径, 您可以使用以下配置 .

### 配置

在你体内 `best.config.js` 您需要具备下列条件:

```
{
    apiDatabase: {
        adapter: 'sql/sqlite',
        uri: 'PATH_TO_SQLITE_DB'
    }
}
```

您不需要创建自己的 sqlite 文件, 适配器会为你处理 .

适配器使用节点内置 [`node:sqlite`](https://nodejs.org/api/sqlite.html) 模块,因此它需要Node.js 22.13或更新的,并且没有本土的依赖性来编译.

## 邮资

### 配置

在你体内 `best.config.js` 您需要具备下列条件:

```
{
    apiDatabase: {
        adapter: 'sql/postgres',
        uri: 'postgresql://dbuser:secretpassword@database.server.com:3211/mydb
    }
}
```

对于 Postgres , 您需要提供和管理自己的数据库 .

## 常见问题

### @best/api-db 是什么？

最佳 Api 数据库

### 如何安装 @best/api-db？

在项目目录运行 npm install @best/api-db，或使用 pnpm add / yarn add / bun add。

### @best/api-db 支持 TypeScript 吗？

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

### @best/api-db 支持 ESM 还是 CommonJS？

以 CommonJS 形式发布，可以直接 require\(\)；在 ES Module 项目中也可以用 import 引入（Node\.js 会把 module\.exports 作为默认导出）。

### @best/api-db 需要什么版本的 Node\.js？

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

### @best/api-db 可以商用吗？

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

### @best/api-db 的下载量有多少？

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

### @best/api-db 还在维护吗？

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