数据魔方 ETL VSCode 插件 - 功能说明文档
数据魔方 ETL VSCode 插件 - 功能说明文档
📖 版本: v1.1.0 🎯 定位: 专业的数据魔方平台开发工具，提供 AI 智能编程和完整的 ETL 项目管理体验
🌟 核心特色
🤖 AI 智能编程支持
- 完美兼容 GitHub Copilot 和 Cursor 之类的 ai 编辑器 - 智能代码生成和建议
- 智能代码补全 - 原生实现的 SQL 关键字、表名、字段名自动补全
- 上下文感知 - 基于语法位置的精准补全建议
🛠️ 专业 IDE 体验
- SQL 语法高亮 - PostgreSQL 语法高亮支持
- 实时错误检测 - 智能 SQL 语法检查
- 快捷键操作 - 类 IDE 的快捷键支持
- 代码格式化 - 保持代码风格一致性
数据目录结合
- 在编辑器中预览数据目录，并快速和 sql 编辑结合使用。
- 快速预览数据表的信息，搜索表等。
核心功能截图
整体预览
表联想
字段联想
右键操作
执行结果
配置魔方域名和 access token
插件中可以执行 etl 相关的管理功能
📊 主要功能模块
1. ETL 项目管理
🌳 树状结构管理
- 分层组织: 文件夹 → 项目 → 节点的三级管理结构
- 可视化操作: 通过树视图直观管理所有 ETL 资源
- 实时同步: 本地操作与服务器端实时双向同步
📁 文件夹管理
📁 数据处理
📁 基础数据清洗
📁 业务指标计算
📁 报表数据生成
支持操作:
- ➕ 创建子文件夹 - 无限层级嵌套
- ✏️ 重命名文件夹 - 批量重命名支持
- 🗑️ 删除文件夹 - 安全删除确认
📊 项目管理
每个项目可包含多个数据处理节点：
支持操作:
- ➕ 在文件夹下创建新项目
- ✏️ 重命名项目
- 🗑️ 删除项目（包含所有节点）
- 📋 项目信息查看
🗄️ 节点管理
支持多种节点类型：
- SQL 节点: 数据查询和转换逻辑
- Python 节点: 复杂数据处理脚本
- 其他类型节点: 扩展支持
节点操作:
- ➕ 创建新节点
- ✏️ 双击编辑节点内容
- 🔄 实时保存到服务器
- 🚀 一键执行节点代码
2. 智能代码补全系统 ✨
🎯 三层补全优先级
- 字段补全 (最高优先级)
- 表名补全 (中等优先级)
- 关键字补全 (基础优先级)
🔍 智能触发条件
| 场景 |
触发条件 |
示例 |
| 字段补全 |
输入 表名. |
user_info. → 显示该表所有字段 |
| 表名补全 |
SQL 关键字 + 空格 + 表名片段 |
FROM user → 搜索包含"user"的表 |
| 关键字补全 |
输入任意字母 |
sel → 提示"SELECT" |
🎨 补全信息展示
字段补全:
- 显示:
字段名(中文别名)
- 详情: 字段类型、描述信息
- 排序: 按相关度排序
表名补全:
- 显示: 表的显示名称
- 详情: 所有者、表类型
- 排序: 按匹配度排序
关键字补全:
- 200+ PostgreSQL 关键字
- 包含函数名、数据类型、操作符
3. 数据目录功能
🗂️ 目录浏览
- 私有表视图: 查看个人创建的数据表
- 公共表视图: 浏览团队共享的数据表
- 分层结构: 支持文件夹展开/收起
- 类型识别: 不同数据源显示不同图标
🗂️ 私有表
📁 业务数据
🗄️ 用户信息表 (DATABASE)
📊 销售数据表 (EXCEL)
📁 分析结果
🌐 API数据表 (API)
🔍 强大搜索功能
- 全量搜索: 跨所有私有表和公共表搜索
- 模糊匹配: 支持表名关键词匹配
- 即时结果: 实时显示搜索结果
- 结果统计: 显示找到的表数量
搜索操作:
- 点击搜索按钮 🔍
- 输入表名关键词
- 查看搜索结果和统计信息
- 点击清空按钮 🗑️ 退出搜索
⚡ 快速操作
- 一键插入: 直接点击表名插入到编辑器光标位置
- 多格式选择: 表名、原始表名、完整表名(含数据源前缀)
- 复制到剪贴板: 快速复制表名
- 查看详情: 显示表的完整元数据信息
4. SQL 编辑器功能
📝 编辑体验
- 语法高亮: PostgreSQL 语法高亮支持
- 智能缩进: 自动代码格式化
- 错误检测: 实时语法错误提示
- 代码折叠: 支持代码块折叠
🔐 编辑权限管理
- 锁定机制: 防止多人同时编辑冲突
- 抢锁功能: 强制获取编辑权限
- 状态提示: 实时显示编辑权限状态
- 自动保存: 实时保存到服务器
⚡ 执行功能
- SQL 执行: 直接在编辑器中执行 SQL 代码
- 选中执行: 支持执行选中的代码片段
- 参数化查询: 支持动态参数输入
- 结果展示: 表格形式展示查询结果
5. 快捷键支持
| 快捷键 |
功能 |
适用范围 |
Ctrl+S / Cmd+S |
保存当前节点 |
ETL SQL 文件 |
F5 |
执行 SQL 代码 |
ETL SQL 文件 |
Ctrl+Enter / Cmd+Enter |
执行 SQL 代码 |
ETL SQL 文件 |
Ctrl+Shift+L / Cmd+Shift+L |
抢锁编辑权限 |
ETL SQL 文件 |
6. 配置管理
⚙️ 连接配置
{
"etl.host": "https://your-domain.com",
"etl.accessToken": "your-personal-access-token"
}
🔧 自动化设置
- 自动同步: 代码变更自动保存到服务器
- 同步间隔: 可配置的同步频率
- 连接状态: 实时监控连接状态
- 错误重试: 自动重试失败的操作
🚀 使用流程
快速开始
- 安装配置
# 安装插件
code --install-extension yuce-etl-vscode-extension.vsix
连接服务器
- 点击"连接到数据魔方"
- 输入服务器地址和访问令牌
- 测试连接成功
创建项目
开发 SQL
- 右键项目 → 创建节点 → 选择 SQL 类型 → 开始编码
典型开发流程
项目组织
- 创建业务模块文件夹
- 在文件夹下创建具体项目
- 为项目添加数据处理节点
代码编写
- 双击节点打开编辑器
- 利用智能补全编写 SQL
- 使用数据目录快速引用表名
测试执行
- 按 F5 执行 SQL 代码
- 查看执行结果和日志
- 调试和优化查询性能
保存部署
- Ctrl+S 保存到服务器
- 代码自动同步到数据魔方平台
- 在平台上进一步配置和调度
🎯 最佳实践
AI 编程建议
使用 GitHub Copilot
使用 Cursor AI
- 选中复杂查询按 Ctrl+K 优化性能
- 使用 AI 重构长 SQL 为多个 CTE
- 让 AI 添加必要的索引建议
🔧 故障排除
常见问题
智能补全不工作
- 检查文件扩展名是否为
.etlsql
- 确认已连接到数据魔方服务器
- 查看控制台是否有错误信息
无法连接服务器
- 检查网络连接状态
- 验证服务器地址和访问令牌
- 查看企业防火墙设置
代码保存失败
- 检查编辑权限状态
- 使用抢锁功能获取编辑权限
- 刷新节点重新加载
🔮 路线图
已计划功能
- [ ] 表结构预览面板
- [ ] 数据预览功能
- [ ] SQL 执行历史记录
📞 技术支持
- 文档: 查看项目
README.md
- 问题反馈: 通过企业内部渠道反馈
- 功能建议: 提交功能需求到产品团队
💡 提示: 充分利用 AI 编程助手(GitHub Copilot, Cursor AI)能显著提升开发效率，建议在编写复杂 SQL 时多使用注释描述业务逻辑。
| |
