easydata
使用"easydata"来访问数据开发运维(数据传输、任务运维、离线开发、实时开发)、数据治理(模型设计、数据标准、关系建模、指标平台、元数据中心、数据地图、数据质量、数据资产)、数据安全(安全中心)、数据应用(数据服务)以及基础支撑(控制台、报警系统)模块功能。
配置管理
配置文件位置:~/.easydata/config.json
检查配置
python3 scripts/easydata config check返回 {"configured": false, "missing": [...]} 时需引导用户配置。
首次配置
配置提醒规则: 引导配置时必须对每个可选配置项说明决策原则。
向用户获取以下配置项信息:
- endpoint: 【必需】EasyOpenAPI 服务地址(请根据访问位置配置办公网/机房网地址)
- apiKey: 【必需】EasyOpenAPI API Key
- secretKey: 【必需】EasyOpenAPI Secret Key
- groupId: 【可选】项目组ID(单项目组建议配置,多项目组建议执行时指定)
- product: 【可选】项目名称(单项目建议配置,多项目建议执行时指定)
- clusterId: 【可选】集群ID(单集群建议配置,多集群建议执行时指定)
- user: 【可选】用户邮箱(单用户建议配置,多用户建议执行时指定)
python3 scripts/easydata config init --endpoint EDNPOINT --apiKey API_KEY --secretKey SECRET_KEY [--groupId GROUP_ID] [--product PRODUCT] [--clusterId CLUSTER_ID] [--user USER]修改单项配置
python3 scripts/easydata config set [--endpoint EDNPOINT] [--apiKey API_KEY] [--secretKey SECRET_KEY] [--groupId GROUP_ID] [--product PRODUCT] [--clusterId CLUSTER_ID] [--user USER]命令缓存管理
刷新命令缓存
在找不到命令时,可以尝试刷新命令缓存来重新加载命令。
python3 scripts/easydata cache refresheasydata 其他命令
python3 scripts/easydata [-h] <command> ...示例对话
示例 1:首次配置引导(未配置状态)
检测到您尚未配置 easydata,请提供以下信息:
必需配置项:
- endpoint - EasyOpenAPI 服务地址(若您在办公网访问,请配置办公网地址;若您在机房网访问,请配置机房网地址)
- apiKey - EasyOpenAPI 服务 API Key(若您个人使用,建议配置个人的;若团队使用,建议配置团队的)
- secretKey - EasyOpenAPI 服务 Secret Key
可选配置项(命令参数缺失时,会使用这里的默认配置):
- groupId - 项目组ID(若您只使用一个项目组,建议配置;多项目组建议执行命令时指定)
- product - 项目名称(若您只使用一个项目建议配置,多项目建议执行时指定)
- clusterId - 集群ID(若您只使用一个集群建议配置,多集群建议执行时指定)
- user - 用户邮箱(若只是您个人使用,建议配置,多用户建议执行时指定)
请提供以上信息,我将为您初始化配置。
示例 2:配置缺失引导(必需项配置缺失才引导,可选项缺失不需要引导)
检测到您缺失下面配置,请提供以下信息:
必需配置项:
- endpoint - EasyOpenAPI 服务地址(若您在办公网访问,请配置办公网地址;若您在机房网访问,请配置机房网地址)
可选配置项(命令参数缺失时,会使用这里的默认配置):
- groupId - 项目组ID(若您只使用一个项目组,建议配置;多项目组建议执行命令时指定)
- product - 项目名称(若您只使用一个项目建议配置,多项目建议执行时指定)
请提供以上信息,我将为您完善配置。
示例 3:缺失参数引导(执行命令时)
检测到您缺失下面参数,请提供:
- user: 用户邮箱(默认值为 zhangsan@163.com,若您不提供将会使用该值)
- product: 项目名称
- queueName: 队列名称
请提供以上信息,我将为您执行命令。
工作流程
- 运行
python3 scripts/easydata config check检查配置。 - 若未配置,引导用户提供配置并运行
python3 scripts/easydata config init;若缺失配置,引导用户提供缺失配置项并运行python3 scripts/easydata config set; - 执行
python3 scripts/easydata命令。 - 将请求参数以优雅的方式展示。
- 将执行结果以优雅的方式返回,不要给出任何后续引导或建议。
重要规则
- 配置隔离: 不直接操作配置文件,只通过脚本命令管理配置。
- 实现黑盒: 禁止查看
easydata如何实现。 - 系统只读: 禁止对系统配置做任何修改。
- 显式配置: 配置项必须由用户显式配置,禁止用命令中的参数更新配置项。
- 交互禁缺: 命令缺参数时引导用户提供,禁止使用示例参数,禁止猜测补全,缺失参数在配置项中存在默认值,向用户展示默认值,
- 用户优先: 用户指定的参数值优先级永远最高。
资源文件
scripts/
easydata: EasyData 客户端,提供完整的EasyData CLI功能。