用户手册
本手册说明 Data Source Explorer (DSE) 的完整操作流程。
当你需要一份覆盖以下内容的详细参考时,请使用本手册:
- 探索与发现
- 连接检查与连接测试
- 对象浏览
- Schema Catalog 与 Data Catalog 工作流
- 输出目标(targets)编排
- deployables 生成
- 运行结果、图形化 schema 与导出
- 工作区与作业配置保存
1. 应用程序的用途
DSE 是一个面向操作人员的桌面应用,用于发现数据源、检查其结构、准备抽取或映射定义,并生成可重复使用的输出工件。
常见工作流如下:
- 选择目标并执行 Discover
- 检查已发现的数据源树
- 查看或修改连接信息
- 测试连接
- 加载表 / 集合 / bucket / 其他对象
- 检查对象结构和数据预览
- 构建真正需要的 Schema Catalog / Data Catalog
- 当需要目标端对象映射时配置 output targets
- 为一个或多个运行时目标生成 deployables
- 检查生成的文件,并在需要时生成图形化 schema
2. 主窗口布局
顶部命令区
可用于:
- 选择语言
- 使用 Workspace 菜单
- 打开 Plugins、Logs 和 Help
- 切换主题
- 选择发现目标并点击 Discover
左侧导航树
左侧显示已发现的环境。根据上下文,你可能会看到:
- 数据库
- 表
- 视图
- 集合
- bucket
- 文件/对象存储
- 云或 SaaS 节点
- 与 mainframe 相关的节点
右侧工作区
右侧显示:
- 当前选中源的摘要
- 该源可执行的操作
- 对象列表
- 详情标签页,例如 table info、preview、row details、catalog schema、data catalog 和 output data
3. 开始一次会话
- 启动应用。
- 如有需要,选择界面语言。
- 在目标框中输入要检查的机器、主机、环境或发现路径。
- 如果应用提供多个发现模式,请选择目标类型。
- 点击 Discover。
建议做法
- 先从较小范围开始。
- 在编辑连接或生成输出前,确认当前环境正确。
- 当发现过程得到有价值的状态后,及时保存 workspace。
4. 发现并浏览数据源
发现完成后,请认真查看左侧树。
重点关注:
- 数据源类型图标
- 数据源名称
- host / endpoint 提示
- reachable、offline、local only、configured 等状态
- 子节点,例如数据库、表、集合、bucket、服务等
推荐操作顺序
- 按层级逐步展开树
- 选择感兴趣的数据源
- 查看右侧摘要卡片
- 决定是打开详情、编辑连接、移除 scope,还是继续加载对象
5. 查看详情并编辑连接信息
对于选中的数据源,DSE 可能提供以下操作:
- Open details
- Edit connection
- Remove scope
- Test connection
- Load tables
- Run sample query
- Generate deployables
- Compose targets
Open details
用于只读查看当前节点或连接的技术摘要。
Edit connection
以下情况应使用该操作:
- 数据源已发现,但仍需要凭据
- 需要修正 host、port、database、service 或 path
- 需要覆盖 connection string 或 endpoint
推荐顺序:
- 只修改必要字段
- 保存连接更改
- 立即执行 Test connection
- 连接确认无误后,再继续加载对象或生成 deployables
6. 测试连接
在执行任何重要操作前,都应先使用 Test connection。
一次有效的连接测试应确认:
- endpoint 可访问
- 认证可用
- database / service / bucket 路径有效
- 插件/提供程序能够与数据源通信
如果测试失败:
- 检查 host、port 和 instance/service 名称
- 检查凭据
- 检查网络、防火墙和本地限制
- 检查所需 driver/plugin 是否已安装并启用
- 打开 Logs 查看详细信息
7. 加载对象并检查结构
连接成功后,点击 Load tables 或对应的数据加载命令。
根据源类型,可能加载:
- 关系型表和视图
- 文档集合
- bucket 和 measurements
- 其他对象分组
如何检查对象
- 在对象列表中选择一个对象
- 查看 Table info 或等效标签页
- 打开 Preview 查看示例行或文档
- 使用 Row details 深入查看某条记录
- 查看 Catalog Schema 和 Data Catalog,将结构整理为可复用定义
8. 构建 Schema Catalog 和 Data Catalog
Schema Catalog
用于定义对抽取或后续部署真正重要的源对象结构视图。
Data Catalog
用于从更偏用户与复用的角度,补充或检查已选择的字段和对象。
建议做法
- 保持 catalog 聚焦
- 不要随意加入实验性对象,除非它们必须进入最终输出
- 进入 target 配置前,先确认对象名称
9. 直接生成 Output Data
当你希望从当前 catalog 直接生成数据工件时,请使用 Output Data。
适用于:
- 验证性运行
- 抽样输出
- 操作检查
- 确认映射和数据访问是否符合预期
常见输出类型:
- CSV
- Excel (
.xlsx) - 汇总 JSON 或日志类文件
在大规模运行前,请确认:
- 已选择正确对象
- 已选择正确输出格式
- 行数限制设置正确
- 输出文件夹正确
10. 编排输出目标
当你需要面向目标端的映射,而不是仅仅浏览源端数据时,请使用 Compose targets。
在 target composer 中,通常会处理三层内容:
- 左侧可用源行/字段
- 中间一个或多个目标 target
- 右侧目标对象和字段映射
典型流程
- 创建一个目标 target
- 选择目标系统 preset 或类型
- 创建一个或多个目标对象
- 选择源行/字段
- 将它们加入当前选中的目标对象
- 检查 mappings 网格
- 修复验证警告
- 保存 target 定义
验证建议
保存前请修复:
- 缺失的 target 名称
- 重复名称
- 对当前目标技术无效的字段名
- 缺失的 mappings
11. 生成 deployables
使用 Generate deployables,可以基于 catalog 和/或已保存 targets 生成 portable runner 或相关部署工件。
输入模式
DSE 支持两种常见模式:
- 直接使用当前 catalog 选择
- 使用一个或多个 saved output targets
启用已保存 targets 后,你可以从下拉框反复添加 targets,形成 multi-target 集合,在 target chips 之间切换,并从当前作业中移除 targets。
Destination instance 区域
该区域用于配置 deployable 将如何连接到目标系统,或如何解释 target definition。
请检查字段,例如:
- target category
- instance/site name
- host/IP
- port
- database/service/path
- user name
- password
- 可选 connection string override
平台与运行时
选择一个或多个部署平台,再选择一个或多个兼容的 runtime identifiers。
Output options
选择 runner 要输出的文件类型,例如:
- CSV
- Excel
同时检查:
- 每个对象的最大行数
- 输出文件夹
- 是否要在生成的 schema 中包含 connection strings
Readiness 面板
生成前,请阅读 readiness / preflight 区域。
它会提示是否仍缺少:
- 平台
- runtimes
- 输出格式
- 输出文件夹
- 有效输入定义
Generate
当配置准备完成后:
- 检查所选 targets 和 chips
- 检查 destination values
- 检查平台、runtimes、格式和文件夹
- 点击 Generate
12. 作业配置保存
离开 Generate deployables 页面时,应用可能会询问是否保留当前作业配置。
如果选择保留
下次打开页面时,DSE 可以恢复:
- 已选择的 saved targets
- 当前活动 chip
- destination instance 字段值
- 平台和 RID 选择
- 输出选项
- 输出文件夹
- 行数限制
- 其他相关生成设置
如果选择不保留
临时作业配置会被清除。
13. 查看已生成的 deployables
生成完成后,DSE 会显示 deployables 汇总区域。
可在此:
- 检查生成条目
- 打开输出文件夹
- 查看结果
- 在存在直接启动路径时立即运行 runner
14. 查看运行结果
结果窗口是运行后的主要验证界面。
它通常提供:
- 生成文件列表
- 文件类型和大小
- 打开文件操作
- CSV/Excel 的分页预览
- JSON/log/text 的文本预览
- 汇总 chips,用于显示文件数量、类型数量、是否可预览以及 schema graph 状态
推荐检查顺序
- 打开结果窗口
- 至少选择一次每个文件
- 检查工作表标签或文本内容
- 核对行数和列名
- 当需要外部验证时,直接打开物理文件
15. 生成图形化 schema
在结果窗口中,使用 Generate schema 来构建本次运行的可视化图。
图中可连接:
- Data Source Explorer
- 已发现的数据源
- 已选对象,例如 tables、collections、buckets
- 已配置 targets
- 已生成的输出文件
此功能适用于:
- 文档化
- 操作复核
- 设计验证
- 向其他人员解释一次运行过程
构建过程中,进度指示器应显示正在执行。
Save graph
使用 Save graph 可将图导出为支持的格式,例如:
- SVG
- PNG
- BMP
- draw.io
- PlantUML / UML text
- HTML preview
16. 工作区(Workspace)
使用 Workspace 菜单管理可复用会话。
常见操作包括:
- 打开新 workspace
- 打开已有 workspace
- 最近使用的 workspace
- 保存当前 workspace
- 另存为
- 导入/导出 XML
- 保存并退出
建议
- 成功发现后立即保存
- catalog 工作完成后再次保存
- target 编排完成后,如映射重要,再保存一次
- 在进行较大实验前使用 Save As
17. Plugins、Logs 与 Help
Plugins
打开 Plugins 可查看应用中可用的 provider/extension。如果某种源类型缺失或行为异常,先检查 plugin 状态。
Logs
当你需要 discovery、connection、generation 或 runtime 问题的技术细节时,请打开 Logs。
Help
打开 Help 进入可搜索文档中心。按 F1 可打开上下文帮助。
18. 推荐的标准操作顺序
- 打开或创建 workspace
- 对目标范围执行 discovery
- 选择某个数据源并查看详情
- 如有需要,修改连接信息
- 执行 test connection
- 加载对象
- 检查 preview 和结构
- 构建 catalog
- 若运行需要显式目标映射,则配置 targets
- 打开 generate deployables
- 选择 saved targets 或 catalog 输入
- 复核 destination settings、platforms、runtimes、formats 和 folder
- 执行生成
- 打开 summary,再打开 results
- 检查文件和预览
- 如需文档化,生成并保存图形化 schema
- 保存 workspace
19. 故障排查清单
Discovery 结果过多或过少
- 缩小范围
- 检查 target type
- 确认当前环境是否正确
Test connection 失败
- 检查 endpoint
- 检查凭据
- 检查 database/service/path
- 检查网络和防火墙
- 查看 Logs
加载后看不到对象
- 先确认 test connection 已成功
- 检查源端权限
- 修正连接后重新加载
Deployable 生成被阻止
- 检查 readiness 面板
- 确保至少选择了一个平台和一个 runtime
- 确保已定义输出格式和输出文件夹
- 确保输入定义有效
结果看起来不完整
- 检查行数限制
- 检查是否使用了正确的 targets/objects 选择
- 直接从磁盘打开生成文件进行比对
- 查看汇总 JSON/log 文件了解更多运行信息
20. 最终建议
为了获得更可靠的使用体验:
- 按环境或项目组织 workspaces
- 在加载或生成前先验证连接
- 保持 target 定义整洁且命名清晰
- 在分享前检查生成文件
- 使用图形化 schema 导出做追踪和文档记录