返回 Skill 列表
extension
分类: 数据与分析需要 API Key

data-ops-cli

当用户提及 data-ops平台、data-ops-cli、数据操作、数据源管理、数据集查询、指标时使用此技能。

person作者: user_1618a396hubcommunity

data-ops-cli 技能

DataOps CLI 是一个同时提供命令行工具Python SDK的工具,用于管理数据源、表格、数据集、工作流、文档、指标等元数据。

安装

# CLI(自动拉 dataops_sdk[runner])
pip install "data-ops-cli>=0.3.6"
# 或
uv run data-ops-cli

# 仅 SDK(无 DB 驱动)
pip install dataops_sdk

# SDK + DB 驱动(与 CLI 等价)
pip install "dataops_sdk[runner]>=0.3.6"

快速开始

CLI 方式

# 1. 登录
# 1.1. 状态查询
data-ops-cli auth status
# 1.2. 查询可访问应用并让用户选择一个登录
data-ops-cli auth application list
# 1.2. 设置应用
data-ops-cli auth application set <应用编码>

# 2. 常用命令
data-ops-cli datasource list                # 列出数据源
data-ops-cli table list <数据源>             # 搜索表
data-ops-cli table detail <编码>            # 查询表 DDL
data-ops-cli table detail <数据源> <表名>    # 查询表 DDL
data-ops-cli table data <数据源> <表名>      # 查询表数据
data-ops-cli table data <编码>              # 查询表数据
data-ops-cli dataset data <编码>            # 查询数据集数据
data-ops-cli dataset count <编码>           # 统计数据集数据量
data-ops-cli workflow list etl              # 搜索工作流
data-ops-cli metrics detail <编码>          # 指标详情

命令树(CLI)

data-ops-cli
├── auth          # 认证
│   ├── status    # 登录+应用状态
│   ├── login     # 登录
│   ├── logout    # 登出
│   └── application # 应用管理
│       ├── list  # 列出应用
│       ├── set   # 设置当前应用
│       └── info  # 当前应用信息
├── api           # API 接口
│   ├── list      # 列出 API 接口
│   └── detail    # API 接口详情
├── datasource    # 数据源
│   ├── list      # 查询数据源
│   ├── detail    # 数据源详情
│   ├── config    # 查看数据源配置
│   ├── create    # 创建数据源
│   └── update    # 更新数据源
├── table         # 表格
│   ├── list      # 查询表
│   ├── data      # 查询数据
│   ├── detail    # 获取表 DDL
│   ├── count     # 数据数量
│   ├── exec      # 执行 SQL
│   └── update    # 列配置变更
│       └── column
│           ├── base    # 基础配置
│           ├── dict    # 字典关系配置
│           └── relation # 关联关系配置
├── dict          # 字典
│   ├── list      # 查询字典
│   └── detail    # 字典详情
├── dataset       # 数据集
│   ├── list      # 查询数据集
│   ├── detail    # 获取数据集 DDL
│   ├── data      # 查询数据集数据
│   └── count     # 统计数据集数据量
├── data_table    # 多维表格
│   ├── list      # 查询多维表格
│   ├── detail    # 表格详情
│   └── data      # 查询表格数据
├── widget        # 卡片
│   ├── list      # 查询卡片
│   ├── detail    # 卡片详情
│   ├── data      # 查询卡片数据
│   └── count     # 数据数量
├── ref           # 引用关系
│   ├── forward   # 正向引用(引用了谁)
│   └── backward  # 反向引用(谁引用了我)
├── workflow      # 工作流
│   ├── list      # 列出工作流
│   ├── detail    # 工作流详情
│   ├── template  # 代码模板
│   ├── run       # 同步启动
│   └── run-async # 异步启动
├── report        # 文档
│   ├── list      # 列出文档
│   └── detail    # 读取文档详情
├── skill         # 技能
│   ├── list              # 列出技能
│   ├── detail            # 技能/子文件详情
│   ├── upload            # 上传 / 导入 ZIP 包
│   ├── delete            # 删除技能
│   ├── call              # 调用 skill 执行
│   └── file              # 技能子文件
│       ├── list          # 列出子文件
│       ├── upload        # 上传子文件
│       └── delete        # 删除子文件
└── metrics       # 指标
    ├── list      # 列出指标
    └── detail    # 指标详情

常用 meta type 业务说明

平台把几乎所有实体统一存成 meta release 行,用一个 type 字段(即 meta-type)作判别符。列表/详情/引用关系走通用 /meta/release/* 接口,靠 type 区分;数据/执行类能力再走各实体专属控制器。理解 meta-type 能快速判断"某个东西该用哪个命令组"。

枚举定义见 SDK dataops_sdk.schemas.enums.MetaTypedatasource 另在 InnerMetaType)。

| meta-type | 业务含义 | 对应命令组 | |-----------|---------|-----------| | datasource | 数据源:已接入的物理数据库/数据服务连接(MySQL、PostgreSQL、Doris、Oracle、达梦、Neo4j 等),是 table / dataset 等一切数据能力的底座。 | datasource | | table | 数据库表:数据源下某张物理表的元数据(DDL、列定义、字典/关联配置),可查看 DDL 并读取表数据。 | table | | dataset | 数据集:在表/SQL 之上加工出的逻辑数据集(可含多表 join、过滤、计算字段),面向分析复用,可直接查数据与统计量。 | dataset | | data_table | 多维表格:类在线表格/低代码数据表,字段带语义标签(core/desc/extend/tech/redu),支持记录级读写与变更日志。 | data_table | | dict | 字典:枚举/码表,维护键值映射,供字段做值翻译、下拉选项与关联展示。 | dict | | widget | 卡片:可视化卡片/组件(chart、gis、metric、statistic、table、topology 等),是看板与图表的最小展示单元。 | widget | | metrics | 指标:业务指标定义(原子 / 复合 / 派生),带统计口径与指标域,用于统一的量化分析。 | metrics | | api | API 接口:把数据集/指标等封装成可调用的数据服务接口(RESTful / HttpInterface),供外部系统消费。 | api | | report | 文档:文档/报告载体(富文本 + 数据洞察 insights、本体 ontology、关联 skill),承载分析结论。 | report | | workflow | 工作流:ETL / 编排流程定义,含节点、模板与实例,可同步或异步启动运行。 | workflow | | template | 模板:代码/工作流模板,供工作流等生成或复用(在 CLI 中通过 workflow template 获取代码模板)。 | workflow template | | skill | 技能:平台技能包,可上传 ZIP、管理子文件(list/detail/upload/delete)并调用执行。 | skill |

注意alarm(告警)与 hazard(隐患)不是 meta-type,它们由 data-ops-guard 的专属控制器(/alarm/*/hazard/*)提供,不走 /meta/release/*ref(引用关系)也非独立 meta-type,而是任意 meta 之间的正向/反向引用查询。


环境变量

| 变量名 | 说明 | |--------|------| | DATA_OPS_USERNAME | DataOps 用户名 | | DATA_OPS_PASSWORD | DataOps 密码 | | DATA_OPS_BASE_URL | API 基础 URL(可选,默认 http://172.168.63.85/bgw/data-ops-service) |


详细文档

  • CLI 完整参考 — 所有 CLI 命令的详细用法
  • SDK 参考 — SDK 函数签名、参数说明、使用示例
  • 查询参数格式SqlQueryParam / PageParam 格式说明
  • 统一分析链路 — 如何组合命令逐层展开分析
  • Schema 参考MetaBase / Meta / MetaRef / MetaDataSourceDDL / MetaWorkflow / Application / UserInfo 字段说明(详见 schemas/
  • Runner 脚本data_ops_cli.runner 公共 API、安全约束、典型场景(数据修改需先确认)