# @haneinfo/metadata-schema 中文文档

规范地址：https://npmcn.com/package/%40haneinfo/metadata-schema/

版本：1\.1\.36
npm 元数据更新时间：2026-11-17T15:40:16.907Z
中文译文更新时间：2026-11-17T17:48:21.130Z
软件包许可：UNLICENSED

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

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

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

- 包体积（解压后）：52 kB，42 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- 运行依赖：3 个
- peer 依赖：@nestjs/core ^11\.0\.0 \|\| ^12\.0\.0，@nestjs/common ^11\.0\.0 \|\| ^12\.0\.0，@prisma/client ^6\.19\.0 \|\| ^7\.10\.1，@haneinfo/plugin-host-nest ^2\.0\.0
- 首次发布：2026-10-02T05:26:09.705Z
- 最新版本发布：2026-11-17T15:40:16.678Z
- 近 30 天下载量：4691（2026-10-17 至 2026-11-15，npm 官方下载统计）
- 已发布版本数：36（近 12 个月 36 个）

## 中文简介

暂无中文简介

## 安装

```sh
npm install @haneinfo/metadata-schema
```

也可以使用：`pnpm add @haneinfo/metadata-schema`、`yarn add @haneinfo/metadata-schema`、`bun add @haneinfo/metadata-schema`

## README

# `@haneinfo/metadata-schema`

`@haneinfo/metadata-schema` 显示应用程序使用的 Prisma DMMF `GET /metadata/schema`。 。 。 . 答复包括scalar和enum字段、关系元数据、数据库列名和 从 Prisma 解析的结构化说明 `///` 文件评论.

## Prisma 文档标签

标记是区分大小写. `@cubeMeasure` 财务报告和审定财务报表 `@cubeRef` 面向行:仅承认 当它们开始一个文档行时,在可选的空白后. `@internal` 属于例外(参见 页:1 描述可以跟随同一行上的标记,或者出现在 单独 `///` 线条。 原画 `documentation` 保留元数据响应中的值 字节换字节; 解析添加结构属性而不去掉标签文本 .

### `@internal`

地点 `@internal` 在模型的文件中将模型排除在衍生物之外 `availableScopes` 列表; 软件包 Prisma 片段将其放入模型的第一个结尾 `///` 线条. 该模型及其元数据仍在 `models`;只有从范围导出 过滤出来.

```prisma
/// @internal
/// Framework bookkeeping; not part of the public data scopes.
model AuditLog {
  id String @id @default(cuid())
}
```

### `@cubeMeasure <hint>`

地点 `@cubeMeasure` 在 scalar 或 enum 字段中,并提供一个非白空间提示。 当前 建议词典是 `sum`, (中文(简体) ), `avg`, (中文(简体) ), `min`, (中文(简体) ), `max`,以及 `count`不过 `measureHint` 打开 `string` 因此,未来的立方体措施,例如: `countDistinct`, (中文(简体) ), `countDistinctApprox`,以及 `runningTotal` 可用于不改变软件包类型。 解析器不验证字段类型是否 适合提示。 消费者应忽略或警告未知的暗示,而不是失败 整个查询.

```prisma
model InvoiceLine {
  id     String  @id @default(cuid())
  /// @cubeMeasure sum Line amount in the invoice currency.
  amount Decimal
}
```

### `@cubeRef <app>.<Model>.<field>`

地点 `@cubeRef` 指另一个应用程序拥有的字段。 三个点分隔 部件返回为 `crossAppRef: { app, model, field }`. 解析只是合成: 应用程序, 模型,而字段不需要存在于当前寄存器中。 从未推断过交叉应用加盟 当此标签不存在时.

```prisma
model Shipment {
  id              String @id @default(cuid())
  /// @cubeRef sales.Order.id
  /// The order identifier is owned by the sales app.
  salesOrderId    String @map("sales_order_id")
}
```

标记可以合并在一个字段上,也可以与普通文字相混合:

```prisma
model Payment {
  id        String  @id @default(cuid())
  /// Payment amount in the settlement currency.
  /// @cubeMeasure sum
  /// @cubeRef billing.Invoice.total
  amount    Decimal @map("amount_value")
}
```

错误 `@cubeMeasure` 或者说 `@cubeRef` 线条被忽略并产生警告。 小写变体 例如 `@cubemeasure` 是普通文本。 如果标记不止一次出现在字段上, 第一个 有效发生胜出。 嵌入在句子中间的标记字符串不是标记;移动到 开始 `///` 文档行.

## 常见问题

### 如何安装 @haneinfo/metadata-schema？

在项目目录运行 npm install @haneinfo/metadata-schema，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：@nestjs/core（^11\.0\.0 \|\| ^12\.0\.0）、@nestjs/common（^11\.0\.0 \|\| ^12\.0\.0）、@prisma/client（^6\.19\.0 \|\| ^7\.10\.1）、@haneinfo/plugin-host-nest（^2\.0\.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @haneinfo/metadata-schema 支持 TypeScript 吗？

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

### @haneinfo/metadata-schema 支持 ESM 还是 CommonJS？

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

### @haneinfo/metadata-schema 可以商用吗？

@haneinfo/metadata-schema 使用 UNLICENSED 许可。作者声明为 UNLICENSED，即不授予公开使用许可（与公共领域的 Unlicense 不同）。使用前需获得作者授权。以上为概括，不构成法律意见，请以许可原文为准。

### @haneinfo/metadata-schema 的下载量有多少？

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

### @haneinfo/metadata-schema 还在维护吗？

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

