ora.yml 配置文件指南

ora.yml文件概述

ora.yml 是 OraAI 项目的主配置文件，用于定义数据源连接和语义模型位置。

配置结构

采用 projects 列表结构，支持多项目配置。

核心字段说明

字段	必填	说明
projects	是	项目配置列表
projects[].path	否	语义模型文件根目录。相对于ora.yml所在目录，.表示根目录。
projects[].data_source_name	是	OraAI平台中数据源名称，必须是英文名。
projects[].schema	是	数据库模式
projects[].database	否	数据库
projects[].model_paths	是	SQL文件目录路径列表，相对路径。
projects[].semantic_model_paths	是	语义模型文件目录路径列表，相对路径。

配置示例

多项目配置示例

projects:
  - path: ./marketing
    data_source_name: starrocks_marketing   # 营销数据源
    schema: marketing_analytics
    database: marketing_data
    model_paths:
      - sqls                                # SQL文件目录
    semantic_model_paths:
      - models                              # 语义模型文件目录
  
  - path: ./finance
    data_source_name: postgres_finance      # 财务数据源
    schema: finance
    database: financial_data
    model_paths:                            # SQL文件目录
      - sqls/
    semantic_model_paths:                   # 语义模型文件目录
      - models/
      - legacy_models/

单项目精简配置

projects:
  - path: .                                 # 当前目录
    data_source_name: starrocks_prod
    schema: analytics
    database: business_data
    model_paths:
      - sqls
    semantic_model_paths:
      - models

最佳实践

1. 路径规范

• 使用相对路径时以/结尾
• 根目录配置使用 . 表示

2. 多环境管理

# 开发环境
projects:
  - path: .
    data_source_name: starrocks_dev
    schema: analytics_dev

3. 目录组织建议

orai-project-ec/
├── ora.yml                     # 项目配置文件
├── models/                     # 语义模型文件目录
│   └── fct_order_main.yml      # yml文件
└── sqls/                       # SQL文件目录
    └── fct_order_main.sql      # sql文件

4. 版本控制

• 将ora.yml纳入版本控制
• 敏感信息（如密码）应通过环境变量配置

该配置文件作为OraAI项目的核心枢纽，合理配置可确保数据源连接和模型定位的准确性。

---