# @antelopejs/interface-database 中文文档

规范地址：https://npmcn.com/package/%40antelopejs/interface-database/

版本：0\.3\.0
npm 元数据更新时间：2026-11-04T15:48:20.642Z
中文译文更新时间：2026-11-06T06:26:02.491Z
软件包许可：Apache-2\.0

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

原始 npm 页面：https://www.npmjs.com/package/%40antelopejs/interface-database
原文对照：https://npmcn.com/package/%40antelopejs/interface-database/?lang=original
项目主页：https://interfaces.antelopejs.com/docs/database
源码仓库：https://github.com/AntelopeJS/interface-database

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

- 包体积（解压后）：670 kB，193 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- 运行依赖：0 个
- peer 依赖：@antelopejs/interface-core \>=0\.2\.4 \<1\.0\.0
- 首次发布：2026-03-22T16:11:36.382Z
- 最新版本发布：2026-11-04T15:48:20.031Z
- 近 30 天下载量：15261（2026-10-06 至 2026-11-04，npm 官方下载统计）
- 已发布版本数：17（近 12 个月 17 个）

## 中文简介

AQL 羚羊JS 数据库不可知查询构建器: schemas, CRUD, 加入, 聚合和更改种子

## 安装

```sh
npm install @antelopejs/interface-database
```

也可以使用：`pnpm add @antelopejs/interface-database`、`yarn add @antelopejs/interface-database`、`bun add @antelopejs/interface-database`

## README

# `@antelopejs/interface-database`

[![npm](https://img.shields.io/npm/v/@antelopejs/interface-database?style=for-the-badge&labelColor=000000&color=000000)](https://www.npmjs.com/package/@antelopejs/interface-database) [![License](https://img.shields.io/npm/l/@antelopejs/interface-database?style=for-the-badge&labelColor=000000&color=000000)](https://npmcn.com/package/%40antelopejs/interface-database/LICENSE) [![Discord](https://img.shields.io/badge/Discord-18181B?logo=discord&style=for-the-badge&color=000000)](https://discord.gg/g4pFt6eXqu) [![Docs](https://img.shields.io/badge/Docs-18181B?style=for-the-badge&color=000000)](https://interfaces.antelopejs.com/docs/database)

AQL (Antelope Query Language)是"羚羊JS"的数据库-不可知的查询构建者. 您只写过一次可连锁、可键入的查询, 而任何执行接口的数据库模块都会运行它 .

## 它提供的东西

-   `Schema` 声明表格、字段和索引。 每个计划可以举办几个孤立的事件.
-   `Table`, (中文(简体) ), `Selection` 财务报告和审定财务报表 `SingleSelection` 插入、读取、更新和删除文档.
-   `Stream` 过滤器,地图,加入,组和集合. `ValueProxy` 构建其中的表达式.
-   `changes()` 串流发生时插入、更新和删除.
-   问道懒去. 在你走之前什么也没有 `await` 查询、呼叫 `.run()` 或竖起它.

## 执行情况

| 模块 | 页:1 |
| --- | --- |
| [`@antelopejs/mongodb`](https://github.com/AntelopeJS/mongodb) | 蒙哥发. 还执行 `@antelopejs/interface-mongodb`。 。 。 . |
| [`@antelopejs/rethinkdb`](https://github.com/AntelopeJS/rethinkdb) | 重新思考DB. 还执行 `@antelopejs/interface-rethinkdb`。 。 。 . |

## 安装

向运行查询的模块添加接口 :

```bash
pnpm add @antelopejs/interface-database
```

然后在项目中添加一个执行:

```bash
ajs project modules add @antelopejs/mongodb
```

## 快开始

```ts
import { Schema } from "@antelopejs/interface-database";

interface Novel {
  _id?: string;
  title: string;
  pageCount: number;
}

const schema = new Schema<{ novels: Novel }>("library", {
  novels: {
    fields: { title: "string", pageCount: "number" },
    indexes: { pageCount: {} },
  },
});

const novels = schema.instance().table("novels");

export async function addNovel(title: string, pageCount: number) {
  return await novels.insert({ title, pageCount });
}

export async function listLongNovels() {
  return await novels
    .filter((novel) => novel.key("pageCount").ge(300))
    .orderBy("pageCount", "desc");
}
```

类似 `filter` 上文所列收入a `ValueProxy`,不是文档。 回调一次,当查询构建时,查询只记录 `ValueProxy` 给它打电话.

## 文档

-   [概览和导入路径](https://npmcn.com/package/%40antelopejs/interface-database/docs/index.md)
-   [查询类型](https://npmcn.com/package/%40antelopejs/interface-database/docs/1.query_types/1.index.md)
-   [业务](https://npmcn.com/package/%40antelopejs/interface-database/docs/2.operations/1.index.md)
-   [原子变异](https://npmcn.com/package/%40antelopejs/interface-database/docs/2.operations/8.atomic_mutations.md)
-   [结果](https://npmcn.com/package/%40antelopejs/interface-database/docs/3.results/1.index.md)

## 兼容性

此软件包已声明 `@antelopejs/*` 对等依赖 :

| 软件包 | 支助 | 测试过 |
| --- | --- | --- |
| `@antelopejs/interface-core` | `>=0.2.4 <1.0.0` | `0.2.4` |

## 捐款

读取 [捐款额](https://npmcn.com/package/%40antelopejs/interface-database/CONTRIBUTING.md) 在你打开拉动请求之前。 当地检查为:

```bash
pnpm install
pnpm lint
pnpm test
```

## 许可证

[阿帕奇 - 2.0](https://npmcn.com/package/%40antelopejs/interface-database/LICENSE)

## 常见问题

### @antelopejs/interface-database 是什么？

AQL 羚羊JS 数据库不可知查询构建器: schemas, CRUD, 加入, 聚合和更改种子

### 如何安装 @antelopejs/interface-database？

在项目目录运行 npm install @antelopejs/interface-database，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：@antelopejs/interface-core（\>=0\.2\.4 \<1\.0\.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @antelopejs/interface-database 支持 TypeScript 吗？

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

### @antelopejs/interface-database 支持 ESM 还是 CommonJS？

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

### @antelopejs/interface-database 可以商用吗？

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

### @antelopejs/interface-database 的下载量有多少？

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

### @antelopejs/interface-database 还在维护吗？

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