语义层配置(Semantic Layer)¶
语义适配器统一配置在 agent.services.semantic_layer 下。如果不配置或配置为空,Datus 使用内置默认语义适配器 dosi。Dosi 同时支持语义创作和查询;MetricFlow 与 OSI 只有在显式配置时启用,用于兼容已有资产的查询。
语义层选择是项目级全局设置。旧配置里 node 级的语义格式字段会被忽略;需要显式 pin 时,只改这里。
配置结构¶
agent:
services:
semantic_layer:
dosi:
default: true # 可选;Dosi 同时也是内置默认
# 使用原生 Dosi 执行。仅当数据源目录中有多个 OSI 文件时,
# 才需要显式配置 semantic_model_path。
metricflow: # 仅查询兼容
timeout: 300
config_path: ./conf/agent.yml # 可选的高级覆盖项
osi: # 仅查询兼容
# execution_backend 默认是 metricflow,通常不需要配置。
选择规则¶
AgentConfig.resolve_semantic_adapter 解析活动语义适配器的顺序与 BI Dashboard / Scheduler 完全一致:
- 服务管理类调用处显式传入的
adapter_type。 ./.datus/config.yml中的项目级 pin ——semantic:字段。- YAML 全局
default: true标志:services.semantic_layer中至多一条可标 default,多于一条会在加载阶段直接报错。 - 单条快捷:仅有一条 semantic adapter 时,自动使用它。
- section 为空时使用内置默认。
如果配置了多条 semantic adapter 但没有 default: true,Datus 会认为配置有歧义并报错。
services.semantic_layer 下的 key 必须等于 adapter type(例如 metricflow)。如果同时写了 type: 字段,其值必须与 key 一致,否则 Datus 会在启动时抛出配置错误。比较时会先 lowercase + trim,因此 MetricFlow、metricflow 都会被视为与 metricflow 匹配。
MetricFlow 说明¶
- Datus 不会默认选择或安装 MetricFlow;只有查询已有 MetricFlow 项目时才显式配置
metricflow。 - MetricFlow 在 Datus 中仅保留查询能力;新的语义创作使用 Dosi。
config_path是可选项。- Datus 默认会基于当前
services.datasources中选中的数据源和项目语义模型目录自动构建运行时配置。 - MetricFlow 验证会直接读取配置中的项目语义模型目录,包括位于 gitignore 项目路径下的生成 YAML。
- 仅当你需要 MetricFlow 直接读取某个指定的
agent.yml时才需要设置config_path。
OSI 说明¶
- OSI 是显式配置的仅查询兼容适配器,用于读取已有 strict OSI core YAML。
- 当前 OSI 执行后端默认是 MetricFlow,通常不需要设置
execution_backend。 - 使用
pip install "datus-semantic-osi[metricflow]"安装;CLI 也会使用相同的 extra,确保查询后端可用。 - 配置
services.semantic_layer.osi并标记default: true,可在同时配置其他 adapter 时全局选择 OSI。空的osi: {}只有在它是唯一 semantic adapter,或当前项目 pin 到semantic: osi时才会被选中。
Dosi 说明¶
- Dosi 复用相同的 OSI authoring 格式和 DATUS
custom_extensions流程。 datus-semantic-dosi直接通过原生 engine 执行,不设置execution_backend: metricflow。- 每个 adapter 实例加载一个 OSI 文档。如果数据源语义模型目录包含多个文件,需要显式配置
semantic_model_path。 pip install datus-semantic-dosi会同时安装 adapter 和dosi-engine。- 交互式启动且没有语义层配置时,Datus 会自动安装并选择 Dosi;无人值守环境需要显式安装选中的 adapter。
通过 CLI 配置(/services)¶
在 Datus REPL 中运行 /services semantic(或者从其他 tab 按 Tab 切过来)会进入配置 TUI 的 Semantic tab。该 tab 支持:
- 在尾部的
+ Add new semantic行按Enter新增一个语义层。选择 adapter type,例如metricflow、osi或dosi。如果适配器包尚未安装,CLI 会安装对应包;OSI 会安装datus-semantic-osi[metricflow],Dosi 会安装datus-semantic-dosi。 - 用
x删除条目;用t触发一次注册探测。 d切换全局default: true:按d把光标项设为默认,并自动清掉其他条目的 default。p设置项目级 default:值写入./.datus/config.yml的semantic: <name>,只对当前项目生效,优先级高于全局标记。在已 pin 的行上再按一次p清除。- 对没有可编辑字段的 adapter,此 tab 不显示
e edit。
新建条目会写入 ~/.datus/conf/agent.yml,形态为 services.semantic_layer.<type>: {type: <type>}。
首次进入交互式 REPL 时,Datus 会跑一遍 bootstrap:若尚无项目级 pin,而 YAML 中能解析出明确的默认值(单条快捷或唯一标 default: true),Datus 会自动写入项目级 pin。若多条都未标 default,启动时会弹出一个轻量选择器。CI / Docker 等无人值守环境可设置 DATUS_DISABLE_SERVICE_BOOTSTRAP=1 关闭。