DSEDataSourceExplorer
DSE 1.0.1

用户手册

本手册说明 Data Source Explorer (DSE) 的完整操作流程。

当你需要一份覆盖以下内容的详细参考时,请使用本手册:

1. 应用程序的用途

DSE 是一个面向操作人员的桌面应用,用于发现数据源、检查其结构、准备抽取或映射定义,并生成可重复使用的输出工件。

常见工作流如下:

  1. 选择目标并执行 Discover
  2. 检查已发现的数据源树
  3. 查看或修改连接信息
  4. 测试连接
  5. 加载表 / 集合 / bucket / 其他对象
  6. 检查对象结构和数据预览
  7. 构建真正需要的 Schema Catalog / Data Catalog
  8. 当需要目标端对象映射时配置 output targets
  9. 为一个或多个运行时目标生成 deployables
  10. 检查生成的文件,并在需要时生成图形化 schema

2. 主窗口布局

顶部命令区

可用于:

左侧导航树

左侧显示已发现的环境。根据上下文,你可能会看到:

右侧工作区

右侧显示:

3. 开始一次会话

  1. 启动应用。
  2. 如有需要,选择界面语言。
  3. 在目标框中输入要检查的机器、主机、环境或发现路径。
  4. 如果应用提供多个发现模式,请选择目标类型。
  5. 点击 Discover。

建议做法

4. 发现并浏览数据源

发现完成后,请认真查看左侧树。

重点关注:

推荐操作顺序

  1. 按层级逐步展开树
  2. 选择感兴趣的数据源
  3. 查看右侧摘要卡片
  4. 决定是打开详情、编辑连接、移除 scope,还是继续加载对象

5. 查看详情并编辑连接信息

对于选中的数据源,DSE 可能提供以下操作:

Open details

用于只读查看当前节点或连接的技术摘要。

Edit connection

以下情况应使用该操作:

推荐顺序:

  1. 只修改必要字段
  2. 保存连接更改
  3. 立即执行 Test connection
  4. 连接确认无误后,再继续加载对象或生成 deployables

6. 测试连接

在执行任何重要操作前,都应先使用 Test connection。

一次有效的连接测试应确认:

如果测试失败:

7. 加载对象并检查结构

连接成功后,点击 Load tables 或对应的数据加载命令。

根据源类型,可能加载:

如何检查对象

  1. 在对象列表中选择一个对象
  2. 查看 Table info 或等效标签页
  3. 打开 Preview 查看示例行或文档
  4. 使用 Row details 深入查看某条记录
  5. 查看 Catalog Schema 和 Data Catalog,将结构整理为可复用定义

8. 构建 Schema Catalog 和 Data Catalog

Schema Catalog

用于定义对抽取或后续部署真正重要的源对象结构视图。

Data Catalog

用于从更偏用户与复用的角度,补充或检查已选择的字段和对象。

建议做法

9. 直接生成 Output Data

当你希望从当前 catalog 直接生成数据工件时,请使用 Output Data。

适用于:

常见输出类型:

在大规模运行前,请确认:

10. 编排输出目标

当你需要面向目标端的映射,而不是仅仅浏览源端数据时,请使用 Compose targets。

在 target composer 中,通常会处理三层内容:

  1. 左侧可用源行/字段
  2. 中间一个或多个目标 target
  3. 右侧目标对象和字段映射

典型流程

  1. 创建一个目标 target
  2. 选择目标系统 preset 或类型
  3. 创建一个或多个目标对象
  4. 选择源行/字段
  5. 将它们加入当前选中的目标对象
  6. 检查 mappings 网格
  7. 修复验证警告
  8. 保存 target 定义

验证建议

保存前请修复:

11. 生成 deployables

使用 Generate deployables,可以基于 catalog 和/或已保存 targets 生成 portable runner 或相关部署工件。

输入模式

DSE 支持两种常见模式:

启用已保存 targets 后,你可以从下拉框反复添加 targets,形成 multi-target 集合,在 target chips 之间切换,并从当前作业中移除 targets。

Destination instance 区域

该区域用于配置 deployable 将如何连接到目标系统,或如何解释 target definition。

请检查字段,例如:

平台与运行时

选择一个或多个部署平台,再选择一个或多个兼容的 runtime identifiers。

Output options

选择 runner 要输出的文件类型,例如:

同时检查:

Readiness 面板

生成前,请阅读 readiness / preflight 区域。

它会提示是否仍缺少:

Generate

当配置准备完成后:

  1. 检查所选 targets 和 chips
  2. 检查 destination values
  3. 检查平台、runtimes、格式和文件夹
  4. 点击 Generate

12. 作业配置保存

离开 Generate deployables 页面时,应用可能会询问是否保留当前作业配置。

如果选择保留

下次打开页面时,DSE 可以恢复:

如果选择不保留

临时作业配置会被清除。

13. 查看已生成的 deployables

生成完成后,DSE 会显示 deployables 汇总区域。

可在此:

14. 查看运行结果

结果窗口是运行后的主要验证界面。

它通常提供:

推荐检查顺序

  1. 打开结果窗口
  2. 至少选择一次每个文件
  3. 检查工作表标签或文本内容
  4. 核对行数和列名
  5. 当需要外部验证时,直接打开物理文件

15. 生成图形化 schema

在结果窗口中,使用 Generate schema 来构建本次运行的可视化图。

图中可连接:

此功能适用于:

构建过程中,进度指示器应显示正在执行。

Save graph

使用 Save graph 可将图导出为支持的格式,例如:

16. 工作区(Workspace)

使用 Workspace 菜单管理可复用会话。

常见操作包括:

建议

17. Plugins、Logs 与 Help

Plugins

打开 Plugins 可查看应用中可用的 provider/extension。如果某种源类型缺失或行为异常,先检查 plugin 状态。

Logs

当你需要 discovery、connection、generation 或 runtime 问题的技术细节时,请打开 Logs。

Help

打开 Help 进入可搜索文档中心。按 F1 可打开上下文帮助。

18. 推荐的标准操作顺序

  1. 打开或创建 workspace
  2. 对目标范围执行 discovery
  3. 选择某个数据源并查看详情
  4. 如有需要,修改连接信息
  5. 执行 test connection
  6. 加载对象
  7. 检查 preview 和结构
  8. 构建 catalog
  9. 若运行需要显式目标映射,则配置 targets
  10. 打开 generate deployables
  11. 选择 saved targets 或 catalog 输入
  12. 复核 destination settings、platforms、runtimes、formats 和 folder
  13. 执行生成
  14. 打开 summary,再打开 results
  15. 检查文件和预览
  16. 如需文档化,生成并保存图形化 schema
  17. 保存 workspace

19. 故障排查清单

Discovery 结果过多或过少

Test connection 失败

加载后看不到对象

Deployable 生成被阻止

结果看起来不完整

20. 最终建议

为了获得更可靠的使用体验: