派生属性

读时计算，不存

上一节的值类型，约束的是一个值本身。这一节换一个方向：有些值根本不该存下来，而应该在读的时候沿关系算出来。

客户的订单数，订单的缺陷数，都可以人手维护成一列：每来一张订单加一。可没过几周，数字就和实际对不上了。派生属性（Derived Property）反过来：它不存数据，读的时候沿关系从相连的对象算出来，永远和实际一致。

派生属性是只读的，人和 Action 都不能写它。它有两种取值方式：

• 选择（selection）：取相连对象的某个属性。只有路径上每一步都是「一」时才能用，例如订单取所属客户的名字。
• 聚合（aggregation）：路径上只要有一步是「多」，就必须聚合，共七种：count、sum、avg、min、max、collectList、collectSet。collectList 保留重复，collectSet 去重，缺省各收 10 个，limit 最多给到 100。

什么时候该用它：值能从关系上直接算出来，又不必按它过滤、排序。如果一个值是人填的，或者要按它排序，就不该是派生属性。

把下面三个派生属性加进 salesOrder 的 columns。linkPath 写的是关系的名字，从当前类型出发，一步一步走：

[
  { "name": "customerName", "type": "string", "title": "Customer name",
    "derived": { "linkPath": ["customer"], "selection": "name" } },
  { "name": "goodQtyTotal", "type": "integer", "title": "Good quantity so far",
    "derived": { "linkPath": ["workOrders"], "aggregation": { "type": "sum", "property": "goodQty" } } },
  { "name": "defectCount", "type": "integer", "title": "Defects",
    "derived": { "linkPath": ["workOrders", "inspections", "defects"], "aggregation": { "type": "count" } } }
]

最多三跳

一跳就是沿一条关系走一步。关系有两端，从哪一端出发，「一」还是「多」不一样：从订单看客户是「一」，从客户看订单是「多」。这决定了该用 selection 还是聚合。

订单到缺陷正好三跳，在上限之内，所以 salesOrder.defectCount 能直接写成派生属性。客户的缺陷总数 customer.defectCount 要先走 orders，一共四跳，超出上限，写不了。

这种跨四张表的统计，去 SQL 里做：一对多的关系在 Semantic 数据库里就是直接 join，也不受三跳限制。别为了凑进三跳去改模型，只是偶尔看一眼的数字，让它待在 SQL 里就好。

aidc semantic sql 'SELECT c."customerId", count(d."defectId") AS defects
FROM customer c
JOIN "salesOrder" o ON o."customerId" = c."customerId"
JOIN "workOrder" w ON w."orderNo" = o."orderNo"
JOIN inspection i ON i."workOrderNo" = w."workOrderNo"
JOIN defect d ON d."inspectionId" = i."inspectionId"
GROUP BY 1'

限制清单，和绕开的办法

这些限制大多来自同一个原因：派生属性每次读时才算，不在存储里。过滤、排序和 SQL 的列，都要先有一个存下来的值。

• 只读：Action 不能写它，也不能标成只在语义层维护（writeback）。
• 不能做主键，不能必填，不能带值类型，也不能带格式：这些在定义时就会被拒绝。
• 不能用来过滤，也不能用来排序。
• 不进 Semantic 数据库：SQL 里没有这一列。
• 定义里只有路径、聚合和属性，没有筛选条件：想数「还没关闭的缺陷」，派生属性做不到。

遇到这些限制，有三种办法：

withProperties 的写法如下：临时沿 lines 数出每张订单的订单行数。

const client = semantic.ontology();
const withLines = client.objects("salesOrder").withProperties({
  lineCount: (b) => b.pivotTo("lines").aggregate("$count"),
});

派生属性每次读都要算一遍，路径越长、相连的对象越多，越慢。所以读的时候用 --select（SDK 里是 $select）点名要哪几个，没点名的就不会计算：

aidc semantic objects salesOrder --select orderNo,defectCount --page-size 5

下一节讲属性的行为：必填、只在语义层维护、值格式，以及哪些今天有、哪些目前还没有。