# @antelopejs/interface-database-decorators 中文文档

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

版本：0\.2\.0
npm 元数据更新时间：2026-11-04T19:55:01.117Z
中文译文更新时间：2026-11-06T06:26:32.846Z
软件包许可：Apache-2\.0

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

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

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

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

## 中文简介

用于数据库表格和打出的数据模型的羚羊JS装饰器,带有加密、散列和本地化字段

## 安装

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

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

## README

# `@antelopejs/interface-database-decorators`

[![npm](https://img.shields.io/npm/v/@antelopejs/interface-database-decorators?style=for-the-badge&labelColor=000000&color=000000)](https://www.npmjs.com/package/@antelopejs/interface-database-decorators) [![License](https://img.shields.io/npm/l/@antelopejs/interface-database-decorators?style=for-the-badge&labelColor=000000&color=000000)](https://npmcn.com/package/%40antelopejs/interface-database-decorators/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-decorators)

作为 TypeScript 类的数据库表格和数据模型, 在顶端 [`@antelopejs/interface-database`](https://github.com/AntelopeJS/interface-database)。用装饰器宣布字段和索引,然后通过打入的模型读取并写入行.

部分 [羚羊JS](https://github.com/AntelopeJS/antelopejs)用于 [羚羊JS 隐形物](https://github.com/AntelopeJS/dms),用于您的 PostgreSQL 、 MongoDB 或 RethinkDB 数据库的开源后台.

## 它提供的东西

-   `Table`, (中文(简体) ), `@RegisterTable`, (中文(简体) ), `@Field`, (中文(简体) ), `@Index` 财务报告和审定财务报表 `@Fixture` 声明表格、索引和种子行; `RegisterSchema` 提供它们.
-   `BasicDataModel` 财务报告和审定财务报表 `GetModel` 给出每个表格键入的 CRUD 方法,并附带可选的验证.
-   `@Encrypted`, (中文(简体) ), `@Hashed`, (中文(简体) ), `@Localized`, (中文(简体) ), `@CreationTime` 财务报告和审定财务报表 `@UpdateTime` 转换写和读取的字段值.
-   `@Model` 将模型注入到 [`@antelopejs/interface-api`](https://github.com/AntelopeJS/interface-api) 控制器。 控制器.

## 执行情况

软件包在您的模块中运行,没有自己的执行模块. 该项目需要一个模块来执行 `@antelopejs/interface-database`数字 :

| 模块 | 页:1 |
| --- | --- |
| [`@antelopejs/mongodb`](https://github.com/AntelopeJS/mongodb) | 蒙戈DB |
| [`@antelopejs/rethinkdb`](https://github.com/AntelopeJS/rethinkdb) | 反思DB |

## 安装

将软件包添加到宣布表格的模块中 :

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

然后在项目中添加一个数据库模块:

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

## 快开始

```ts
import {
  BasicDataModel,
  Field,
  GetModel,
  Index,
  RegisterSchema,
  RegisterTable,
  Table,
} from "@antelopejs/interface-database-decorators";

@RegisterTable("recipes", "cookbook")
class Recipe extends Table {
  @Index()
  @Field("string")
  declare slug: string;

  @Field("string")
  declare tagline: string;
}

class RecipeModel extends BasicDataModel(Recipe) {}

export async function construct() {
  await RegisterSchema("cookbook");
}

export async function start() {
  const recipes = GetModel(RecipeModel);
  await recipes.insert({ slug: "grilled-halloumi", tagline: "Smoky skewers" });
  const [recipe] = await recipes.getBy("slug", "grilled-halloumi");
  await recipes.update(recipe._id, { tagline: "Smoky halloumi skewers" });
}
```

`RegisterSchema` 创建用于设置的每个表格,并插入其固定装置。 调用一次,在宣布表格的模块中.

## 文档

-   [导言](https://npmcn.com/package/%40antelopejs/interface-database-decorators/docs/1.introduction.md)
-   [表格定义](https://npmcn.com/package/%40antelopejs/interface-database-decorators/docs/2.table-definitions.md)
-   [表格修改符](https://npmcn.com/package/%40antelopejs/interface-database-decorators/docs/3.table-modifiers.md)
-   [数据模型](https://npmcn.com/package/%40antelopejs/interface-database-decorators/docs/4.data-models.md)
-   [参数装饰](https://npmcn.com/package/%40antelopejs/interface-database-decorators/docs/5.parameter-decoration.md)

## 兼容性

软件包宣布这些 `@antelopejs/*` 相邻依赖性 :

| 软件包 | 支助 | 测试过 |
| --- | --- | --- |
| `@antelopejs/interface-api` | `>=0.0.15 <1.0.0` | `0.0.15` |
| `@antelopejs/interface-core` | `>=0.2.4 <1.0.0` | `0.4.0` |
| `@antelopejs/interface-database` | `>=0.1.11 <1.0.0` | `0.3.0` |

## 捐款

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

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

## 许可证

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

## 常见问题

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

用于数据库表格和打出的数据模型的羚羊JS装饰器,带有加密、散列和本地化字段

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

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

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

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

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

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

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

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

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

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

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

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