@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;只有从范围导出 过滤出来.
/// @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
可用于不改变软件包类型。 解析器不验证字段类型是否
适合提示。 消费者应忽略或警告未知的暗示,而不是失败
整个查询.
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 }. 解析只是合成: 应用程序,
模型,而字段不需要存在于当前寄存器中。 从未推断过交叉应用加盟
当此标签不存在时.
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")
}
标记可以合并在一个字段上,也可以与普通文字相混合:
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 是普通文本。 如果标记不止一次出现在字段上, 第一个
有效发生胜出。 嵌入在句子中间的标记字符串不是标记;移动到
开始 /// 文档行.