# @atscript/moost-db 中文文档

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

版本：0\.1\.174
npm 元数据更新时间：2026-11-06T20:28:39.049Z
中文译文更新时间：2026-11-07T03:59:00.798Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40atscript/moost-db
原文对照：https://npmcn.com/package/%40atscript/moost-db/?lang=original
项目主页：https://github.com/moostjs/atscript-db/tree/main/packages/moost-db#readme
源码仓库：https://github.com/moostjs/atscript-db

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

- 包体积（解压后）：1.3 MB，14 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：2 个
- peer 依赖：moost ^0\.7\.4，@uniqu/core ^0\.2\.1，@atscript/db ^0\.1\.174，@wooksjs/http-body ^0\.8\.1，@moostjs/event-http ^0\.7\.4，@wooksjs/event-core ^0\.8\.1，@atscript/typescript ^0\.2\.9
- 首次发布：2026-03-05T00:46:07.965Z
- 最新版本发布：2026-11-06T20:28:38.864Z
- 近 30 天下载量：3923（2026-10-07 至 2026-11-05，npm 官方下载统计）
- 已发布版本数：143（近 12 个月 143 个）

## 中文简介

带有 Atscript 的 Moost 通用数据库控制器 .

## 安装

```sh
npm install @atscript/moost-db
```

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

## README

![Atscript](https://db.atscript.dev/logo.svg)

# @ atscript/ moost-db (英语)

**一次定义模型** ——从单个获取 TypeScript 类型、运行时间验证和 DB 元数据 `.as` 型号.

[文档](https://db.atscript.dev/) • 妇女 [HTTP API 指南](https://db.atscript.dev/http/)

* * *

通用数据库控制器 [摩斯特语Name](https://moost.org/) 框架。 曝光 Atscript 定义的数据库表格和视图为零锅炉板的 RESTful HTTP 端点. 与任何 `@atscript/db` 适配器(SQLite, PostgreSQL, MongoDB, MySQL).

## 安装

```bash
pnpm add @atscript/moost-db
```

同伴依赖性 : `moost`, (中文(简体) ), `@moostjs/event-http`, (中文(简体) ), `@wooksjs/http-body`, (中文(简体) ), `@atscript/db`, (中文(简体) ), `@atscript/typescript`。 。 。 .

`@wooksjs/http-body` 需要满足 `@DbActionID` 编号 : `@DbActionIDs` 参数解析器(被动作层所使用)来读取解析的JSON请求正文.

## 快速启动

```ts
import { AsDbController, TableController } from "@atscript/moost-db";
import { User } from "./models/user.as";

@TableController(usersTable)
export class UsersController extends AsDbController<typeof User> {}
```

这给你: `GET /query`, (中文(简体) ), `GET /pages`, (中文(简体) ), `GET /one/:id`, (中文(简体) ), `POST /`, (中文(简体) ), `PUT /`, (中文(简体) ), `PATCH /`, (中文(简体) ), `DELETE /:id`, (中文(简体) ), `GET /meta`。 。 。 .

## 特征

-   **完整 CRUD** 通过 `AsDbController` - 插入、替换、更新、删除(单一和批次)
-   **只读** 通过 `AsDbReadableController` ——查询,平分,取出取景
-   **URL 查询语法** ——通过查询字符串过滤,排序,页码,字段选择
-   **关联加载** 与 `$with` ——急于加载相关数据
-   **文本搜索** (单位:千美元)`$search`和 **向量搜索** (单位:千美元)`$vector`有可插件的 `computeEmbedding()` 钩子
-   **合计** 与 `$groupBy`
-   **可逾越钩** —— 说 `onWrite`, (中文(简体) ), `onRemove`, (中文(简体) ), `transformFilter`, (中文(简体) ), `computeEmbedding`
-   装饰快捷键 : `@TableController`, (中文(简体) ), `@ReadableController`, (中文(简体) ), `@ViewController`

## 文档

-   [HTTP API 指南](https://db.atscript.dev/http/)
-   [完整文档](https://db.atscript.dev/)

## 许可证

麻省理工学院

## 常见问题

### @atscript/moost-db 是什么？

带有 Atscript 的 Moost 通用数据库控制器 \.

### 如何安装 @atscript/moost-db？

在项目目录运行 npm install @atscript/moost-db，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：moost（^0\.7\.4）、@uniqu/core（^0\.2\.1）、@atscript/db（^0\.1\.174）、@wooksjs/http-body（^0\.8\.1）、@moostjs/event-http（^0\.7\.4）、@wooksjs/event-core（^0\.8\.1）、@atscript/typescript（^0\.2\.9）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @atscript/moost-db 支持 TypeScript 吗？

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

### @atscript/moost-db 支持 ESM 还是 CommonJS？

同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。

### @atscript/moost-db 可以商用吗？

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

### @atscript/moost-db 的下载量有多少？

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

### @atscript/moost-db 还在维护吗？

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