Appearance
orai-cli parse 命令
命令概述
orai-cli parse 命令用于验证语义模型 YAML 定义文件，确保其格式正确且包含所有必填字段。这是将模型部署到 OraAI平台前的必要步骤。
使用用法
parse命令不需要认证，直接执行即可。
shell
$ orai-cli parse
🚀 开始 OraAI 模型解析...
......
🎉 所有指定的模型文件解析成功!基本流程
- 在指定路径或配置中搜索语义模型YAML文件
- 解析每个文件验证其语法和结构
- 确认所有必填字段完整
- 检查需要替换的描述占位符
- 解析模型配置与orai.yml默认值的合并结果
- 报告所有遇到的错误和警告
验证内容
| 检查类型 | 具体内容 |
|---|---|
| 语法验证 | 确保YAML格式正确 |
| 模式验证 | 验证模型符合OraAI语义模型规范 |
| 字段验证 | 检查必填字段(name, data_source_name, schema等)是否齐全 |
| 描述验证 | 识别需要替换的描述占位符(如"<需要填写>") |
| 引用验证 | 确保关系引用指向有效的模型和维度 |
使用示例
验证orai.yml中所有模型
shell$ orai-cli parse 🚀 开始 OraAI 模型解析... ...... 🎉 所有指定的模型文件解析成功!验证单个目录中所有模型
shell$ orai-cli parse --path models/ 🚀 开始 OraAI 模型解析... ...... 🎉 所有指定的模型文件解析成功!验证单个文件
shell$ orai-cli parse --path models/orders.yml 🚀 开始 OraAI 模型解析... ...... 🎉 所有指定的模型文件解析成功!
常见错误
| 错误类型 | 说明 |
|---|---|
| 缺少必填字段 | 如name、data_source_name或schema等关键字段缺失 |
| 无效格式 | YAML语法错误 |
| 占位描述文本 | 描述中包含未替换的占位文本(如"<需要填写>") |
| 名称重复 | 多个模型或维度使用相同名称 |
| 配置解析失败 | 无法与orai.yml默认配置合并 |
最佳实践
- 部署前必验证：始终在部署前运行parse命令及早发现问题
- 处理所有警告：替换占位描述等警告内容以提高可用性
- 版本控制：仅提交通过验证的模型文件到代码库
- 持续集成：将parse命令加入CI流程自动捕获问题