智能开发助手是大数据研发治理套件 DataLeap 为数据开发、数据分析师以及其他将平台作为日常开发工具人员提供的智能辅助开发工具。 通过提供智能生成 SQL 代码、智能诊断、语句修复、代码优化以及智能问答能力,助力平台用户减少基础开发工作量、提升开发效率。
本文为您介绍如何使用 DataLeap 智能开发助手来实现智能数据开发、查询等操作。
1 使用场景
- 生成代码:描述需要处理的问题可以自动生成代码,例如:生成一段将字段A从 String 转换成 int 类型的 SQL,并进行时区转换、Case/When 生成等;
- 智能问答:根据您描述的问题进行答疑,例如忘记 Spark 函数怎么写,唤起智能开发助手,询问函数使用方式;
- 优化代码:SQL 编辑器中选中代码唤起智能开发助手,点击代码优化。比如优化历史任务代码,自动生成优化后的代码并展示 DIFF。
- 修复报错:通过 AI 诊断、AI 修复能力,详细解释报错原因,并给出建议修复方案。
- SQL 代码解释/注释/格式优化:SQL 编辑器中选中相关代码后,可唤起智能开发助手,通过 AI 能力进行 SQL 代码解释、代码注释及代码风格优化,提高 SQL 代码可读性。
2 使用限制
- 目前支持地区:华北地域
- 支持任务类型:LAS SQL、EMR HSQL、EMR Serverless StarRocks/Spark SQL、EMR StarRocks SQL 其他包含 SQL Editor 的任务类型。
- 目前 DataLeap 智能开发助手是白名单发布状态,您可通过提工单的方式,请联系 DataLeap 支持同学进行白名单开通使用。
3 操作指南
3.1 功能入口
智能开发助手中枢能力位于数据开发界面右下角,建议根据新手引导流程完成操作。其他入口主要位于 HSQL 任务、以及 Notebook 任务内部。
- 登录 DataLeap租户控制台 。
- 在概览界面,显示加入的项目中,单击数据开发进入对应项目。
- 可通过以下入口进入来唤起智能开发助手:
- 主入口:
在数据开发界面右下角,单击智能开发助手按钮,进入开发助手弹窗。
- SQL 任务
在 SQL Editor 界面,您可通过以下方式唤起智能开发助手:
a. 在编写完成 SQL 代码后,单击工具栏中的解析按钮,若编辑的 SQL 有异常时,则会提供 AI 诊断、AI 修复,为您提供 SQL 编写建议。
b\c. 您可通过快捷键或单击生成代码按钮的方式,呼唤出智能助手小窗,您可依据界面提示,进行选表,描述 SQL 处理逻辑等
3.2 智能开发助手界面说明
序号 | 功能项 | 说明 |
---|
1 | 适用场景 | 您可根据实际场景,进行智能助手适用场景的选择,支持您选择智能问答和 SQL 生成类型: - 智能问答:日常数据开发中报错答疑、产品功能咨询、函数用法等,智能问答可帮助您提升使用效率。
- SQL 生成:通过选表或使用关键字“#database.tablename”的方式指定读取或写入表,描述业务处理逻辑,来生成 SQL 代码。
|
2 | 选表 | 单击选表按钮,选择处理逻辑中需要使用到的输入/输出表名称信息,自然语言可通过选定的表来生成 SQL 处理逻辑。 |
3 | 提问模版 | 提问模版为您提供询问助手的提示词、指令等相关内容,您也可以在这里自定义配置提示词,配置完成后,您可在编辑框中输入“/”符号,来触发指令,快捷输入提示词,帮助您提升提问效率。 |
4 | 清除上下文 | 单击清除上下文按钮,您可将当前的提问内容和智能助手回复内容做清除,重新开始新一轮的会话。 |
5 | 编辑框 | 自然语言会话输入区,您可在这里描述您想询问助手的问题,包括产品功能、SQL 代码、SQL 报错异常等。 |
4 使用示例
4.1 SQL 生成方式示例
在您拿到数据开发相关需求后,需转换成数据模型以及表处理逻辑。您可通过智能开发助手选定表,并编写相应的提示词,来快速生成相关的逻辑 SQL.
以下为您演示不同入口的使用示例,您可根据使用习惯进行操作:
触发入口 | 操作动图 |
---|
右下角开发助手-选表 | - 数据开发界面右下角进入智能开发助手窗口。
- 切换至 SQL 生成页签。
- 在下方输入框中,描述相关 SQL 逻辑,您可通过上方“选表”按钮,或 “#表名”形式,进行选表。
- 编辑完描述信息并发送后,便可获取完整的 SQL 代码逻辑供您使用。
|
LAS SQL任务-编辑器界面-选表 | - 在 SQL 任务编辑界面,通过快捷键(Mac 按住 Command+i,Windows 按住 Ctrl+i)或单击界面“生成代码”按钮,进入智能助手编辑小窗。
- 在窗口上方单击“选表”按钮,在弹窗中选择输入/输出表名称信息,您可通过输入库名、表名方式进行模糊搜索。
- 单击确定按钮,完成表的选择。
- 在小窗中,用自然语言输入想要处理的 SQL 逻辑,单击提交按钮,等待语句自动生成。
- 待语句生成后,您可观察下方生成的 SQL 语句,单击“接受”或“拒绝”按钮,选择是否接受智能助手提供的语句信息。
|
编辑器/开发助手引用表 |
通过智能助手主入口或 SQL 编辑界面,呼唤出智能窗口后,您可在输入框中输入 “#库名. 表名”,便可进行表的引用操作,并使用自然语言,完成相关 SQL 语句的智能生成。
|
4.2 SQL 解析-智能诊断
DataLeap 智能开发助手,它能够帮助您分析和解决SQL语句中的错误。通过“AI 诊断”和“AI 修复”能力,快速定位您的错误,并帮助您快速修改 SQL 语句,使其更加准确无误,让您的开发过程更加顺畅。
触发入口 | 操作动图 |
---|
SQL 解析报错窗口 | - 在 SQL 编辑器界面,手动输入一段有异常的代码时,单击工具栏解析按钮,便可进行 SQL 逻辑的解析操作。
- 当解析异常时,可在解析报错的解决方案中,单击“AI 诊断”按钮,完成对输入 SQL 逻辑的诊断:
- 在诊断框中会指出相应的检查入口,您可快速根据智能助手提供的诊断信息,进行错误定位并手动修正。
- 您也可直接单击“AI 修复”按钮,通过 SQL 智能修复能力,直接对有异常的 SQL 代码进行修改,界面展示的对比修改内容,您可根据实际情况判断是否接受 AI 提供的修复方案。
|
4.3 SQL 智能代码补全
DataLeap SQL 智能代码补全可协助您在编写 SQL 代码时,提供自动补全建议的能力。它可以根据已输入的部分代码,为您提供后续 SQL 可能的关键字、表名、列名等补全建议,可适应不同的语法规则,提高 SQL 代码编写效率,减少输入错误。
触发入口 | 操作动图 |
---|
SQL 代码编辑器界面 | - 在 SQL 编辑器界面,输入 SQL 语句的关键词信息后,末尾会跟随一段置灰的 SQL 提示;
- 将鼠标移动至灰色 SQL 提示上,您便可快速进行 SQL 补全操作;
- 您可根据实际提示的补全内容,进行按需进行以下选择操作:
- 接受:您可单击“接受 Tab”按钮,或通过快捷键(Tab),将提示的内容全量接受;
- 接受 Word:您可单击“接受 Word”按钮,或通过快捷键(Mac 电脑按住 Command + →,Windows 电脑按住 Ctrl + →),依次接受提示的单个 SQL 单词或符号;
- 接受行:您可单击“接受行”按钮,或通过快捷键(Mac 电脑按住 Command + ↓,Windows 电脑按住 Ctrl + ↓ ),按行形式接受提示的 SQL 补全内容;
- 取消:您可单击“取消 Esc”按钮,或通过快捷键(Esc),撤销提示的 SQL 补全内容;
- 暂停补全 30 min:如果您临时想取消 SQL 补全提示,可单击 “...” 更多按钮,选择“暂停补全 30 min”,可临时暂停 SQL 补全提示。
|
4.4 SQL 智能代码解释/注释格式优化
DataLeap SQL 智能代码解释/注释/格式优化,可协助您在 SQL 编辑器中选中相关代码后,唤起智能开发助手,通过 AI 能力进行 SQL 代码解释、代码注释及代码风格优化,提高 SQL 代码可读性。
触发入口 | 操作动图 |
---|
代码风格优化 | - 在 SQL 编辑器界面,输入 SQL 语句;
- 将编辑的 SQL 代码全选,上方出现 AI 智能助手提示,单击选择代码风格优化按钮,等待优化完成,并查看差异性;
- 根据实际情况选择上方全部接受按钮,便可快速完成智能代码风格优化。
|
代码注释 | - 在 SQL 编辑器界面,输入 SQL 语句;
- 将编辑的 SQL 代码全选,上方出现 AI 智能助手提示,单击选择代码注释按钮,等待全文注释完成,并查看各 SQL 注释说明;
- 根据实际情况选择上方全部接受按钮,便可快速完成代码智能注释。
|
代码解释 | - 在 SQL 编辑器界面,输入 SQL 语句;
- 将需要解释的 SQL 代码全选,上方出现 AI 智能助手提示,单击选择代码解释按钮,等待语句解释完成,您便可在提示窗口中查看智能代码解释的信息。
|
4.5 变更摘要
您在对线上生产任务做变更或新建任务,并将其提交发布时,DataLeap 智能助手在提交上线的说明中,具备自动生成此次代码变更摘要说明的能力。
触发入口 | 操作动图 |
---|
生成变更摘要 | - 新建任务或对线上生产任务做代码、配置参数等变更;
- 保存任务后,进行重新提交操作;
- 在任务提交说明中,会自动通过 AI 智能助手,生成对应的变更摘要说明,您可按需选择接受、拒绝或重新生成变更说明。
|