# @antelopejs/dms-database 中文文档

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

版本：0\.4\.2
npm 元数据更新时间：2026-11-06T13:18:49.304Z
中文译文更新时间：2026-11-06T22:04:37.066Z
软件包许可：Apache-2\.0

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

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

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

- 包体积（解压后）：1.1 MB，276 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- 运行依赖：6 个
- 首次发布：2026-09-16T22:59:29.589Z
- 最新版本发布：2026-11-06T13:18:48.977Z
- 近 30 天下载量：2280（2026-10-06 至 2026-11-04，npm 官方下载统计）
- 已发布版本数：26（近 12 个月 26 个）

## 中文简介

羚羊JS DMS的数据库控制台: schemas,关系图,一个数据浏览器和一个AQL查询控制台.

## 安装

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

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

## README

# @antelopejs/dms-数据库

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

数据库控制台 [羚羊JS 隐形物](https://github.com/AntelopeJS/dms): 计划,图,行和查询.

![The Database diagram: the tables and relations of a shop schema](https://npmcn.com/package/%40antelopejs/dms-database/docs/images/diagram-shop.png)

## 它会做什么

-   检查连接及其间歇性,每个注册的图案和最大的表格各一张卡.
-   列出每个表格,包括已装入的模块登记册、其列、索引、关系和样本行.
-   绘制一个图案的表格和关系,其布局和笔记由整个团队共享.
-   浏览并修正任何情况下的行: 编辑被舞台化,审查,保存,并且可以被撤消十秒.
-   运行 AQL 查询, 包含完成和历史, 并在任何要写入的查询前进行干运行 .

保存的行显示到位; 当保存可能移动行时, 页面会被再次读取( 排序或过滤的字段, 或搜索) .

页面和模块的API只回答平台所有者.

## 安装

从已加载的工程根端运行 AtelopeJS CLI `@antelopejs/dms`数字 :

```bash
ajs project modules add @antelopejs/dms-database
```

## 快开始

该模块在工作时没有配置. 要在“概览”上显示数据库名称并标签您的计划,请添加一个 `config` 块 :

```ts
// antelope.config.ts
"dms-database": {
  source: { type: "package", package: "@antelopejs/dms-database", version: ">=0.2.0 <1.0.0" },
  config: {
    driverLabel: "MongoDB 8.0",
    schemaLabels: {
      "app-*": { label: "Application", color: "info" },
    },
  },
},
```

重新启动后端,然后是前端,作为平台所有者签名并打开 **模块-数据库** (单位:千美元)`/modules/database/overview`) (中文(简体) ).

## 兼容性

| 软件包 | 支助 | 测试过 |
| --- | --- | --- |
| `@antelopejs/interface-api` | `>=0.3.0 <1.0.0` | `0.3.0` |
| `@antelopejs/interface-api-util` | `>=0.3.0 <1.0.0` | `0.3.0` |
| `@antelopejs/interface-core` | `>=0.4.0 <1.0.0` | `0.4.0` |
| `@antelopejs/interface-database` | `>=0.3.1 <1.0.0` | `0.3.1` |
| `@antelopejs/interface-database-decorators` | `>=0.2.1 <1.0.0` | `0.2.1` |
| `@antelopejs/interface-dms` | `>=0.12.0 <1.0.0` | `0.12.0` |
| `@antelopejs/interface-dms-automation` | `>=0.6.1 <1.0.0` | `0.6.1` |

模块还需要一个执行 `@antelopejs/interface-dms` 区域及 `@antelopejs/dms-frontend` 区域中的渲染器,其前端模块宣布在 `engines["@antelopejs/dms-frontend"]` 联 合 国 `frontend-vue/package.json`; 数据 `ajs dms` CLI拒绝用这个范围以外的渲染器建造,并且 `@antelopejs/interface-database` 执行,例如: `@antelopejs/mongodb`。 。 。 .

## 文档

-   [导言](https://dms.antelopejs.com/docs/modules/database/introduction)
-   [安装](https://dms.antelopejs.com/docs/modules/database/installation)
-   [配置](https://dms.antelopejs.com/docs/modules/database/configuration)
-   [使用量](https://dms.antelopejs.com/docs/modules/database/usage/overview)
-   [扩展](https://dms.antelopejs.com/docs/modules/database/extending)
-   [财务问题](https://dms.antelopejs.com/docs/modules/database/faq)

警犬导师住在 [`docs/`](https://npmcn.com/package/%40antelopejs/dms-database/docs),包括 [支持扩展边界](https://npmcn.com/package/%40antelopejs/dms-database/docs/5.extending.md#supported-extension-boundary)。没有单独的DMS数据库接口软件包。 包裹还装了 `dms-database` Claude代码技巧 [`skills/`](https://npmcn.com/package/%40antelopejs/dms-database/skills),在 `antelopeJs.skills`。 。 。 .

## 捐款

读取 [捐款额](https://npmcn.com/package/%40antelopejs/dms-database/CONTRIBUTING.md) 在打开拉出请求之前。 游乐场登记 a `demo` 计划 `shop` 计划 `eu` 财务报告和审定财务报表 `us` 实例,在初始启动时播种。 它默认运行于 MongoDB; set `PLAYGROUND_DATABASE=postgres` 在 PostgreSQL 上运行 `@antelopejs/postgres`,与 `POSTGRES_URL` 命名数据库( 默认) `postgres://postgres@localhost:5432/playground_dms_database`,必须存在).

一个root安装包括后端并被运出Vue模块,保留了各自独立的锁文件. 游乐场保持独立:运行 `pnpm --dir playground install --ignore-workspace --frozen-lockfile` 开始之前 使用下面的根脚本而不是递归脚本: 前端 `build` 财务报告和审定财务报表 `typecheck` 需要操场或生成的 Inertia 工作空间, root lint 已经检查了 Vue 模块 .

```bash
pnpm install
pnpm dev            # playground backend
pnpm frontend:dev   # dashboard, in a second terminal
pnpm lint
pnpm typecheck
pnpm test
```

仓库说明

-   模块通过 Vue 3 前端注册 `frontend-vue/dms.frontend.ts`,在 `DmsDatabase` 组件前缀 : `app/components/DataBrowser.vue` 这是 `DmsDatabaseDataBrowser` 后端页面名称。 页面公布于 `src/pages`,作为 DMS 块加上模块本身的组件。 所有东西都放在下面 `frontend-vue/app/build` 是层的私密和路径导入的.
-   运行 `pnpm test:layer` 前端测试和 `pnpm test:frontend` 以构建和打印生成的 Inertia 应用程序。 设定 `DMS_FRONTEND_WORKSPACE` 到运行前生成的 Inertia 工作空间 `pnpm --dir frontend-vue typecheck`。 。 。 .
-   `DMS_SOURCE=/absolute/path/to/dms pnpm test` 使用一次性 MongoDB 和文件系统存储测试本地的 DS 运行时间。 只有测试带能装入运行时间; 类型来自 `@antelopejs/interface-dms`。 。 。 .
-   `docs/design/redesign-v2-grill.md` 记录v2重新设计背后的决定.

## 许可证

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

## 常见问题

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

羚羊JS DMS的数据库控制台: schemas,关系图,一个数据浏览器和一个AQL查询控制台\.

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

在项目目录运行 npm install @antelopejs/dms-database，或使用 pnpm add / yarn add / bun add。

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

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

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

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

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

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

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

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

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

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