1 概述
SQL Prettier是一款SQL代码格式美化工具。相比于内置的代码格式化,SQL代码格式美化工具的美化能力更智能、更规范,并且可配置,可满足业务深度优化诉求。
2 使用前提
- 插件市场需开通 Dataleap 分布式数据自治服务版本后,方可使用,详见版本服务计费说明。
- 适用场景支持 SQL 类型任务:EMR SQL
3 功能简介
- SQL Prettier引用了业界常用的sql-format库作为优化引擎,对代码进行格式优化。下方图比较了内置的SQL格式优化能力与SQL Prettier,可以发现在代码换行、对齐等优化上,SQL Prettier更加智能友好
- 另外,SQL Prettier也提供了个性化订制能力,用户可以根据自身业务情况调整逗号位置、格式化风格、对齐方法等
4 使用步骤
4.1 进入插件市场
- 登录 DataLeap租户控制台 。
- 在概览界面,显示加入的项目中,单击数据开发进入对应项目。
- 在任务开发界面,左侧导航栏中,单击插件市场按钮,进入插件列表页面。
- 单击SQL Prettier插件名称,可查看该插件使用说明文档。
说明
也可以使用Ctrl
+ Shift
+ X
(Mac下使用 ⌘
+ Shift
+ X
),用快捷键方式来快速开启插件市场。
4.2 安装 SQL Prettier
在左侧插件市场列表中,找到 SQL Prettier,并单击右下角安装按钮,即可一键完成安装。
4.3 使用插件
- 插件完成安装后,单击左侧工具栏回到数据开发页,并打开 SQL 作业
- 在 SQL 编辑界面,点击上方工具栏的SQL Prettier按钮,即可完成代码格式化
- 在SQL Prettier按钮上停留一会,就会出现配置框,可以在配置框中订制个性化内容
- 在左下角齿轮中,找到设置,选择到Extensions中的Prettier,可以发现更多个性化配置选项。
Function
:函数名大小写,默认为大写Keyword
:关键字大小写,默认为大写Type
:类型大小写,默认为大写Comma Position
:逗号位置,默认为后置Degrade To Format
:美化失败时降级为内置格式化,默认为关闭Trailing Semicolon
:添加末尾分号,默认为添加Style
:格式化风格,默认为舒适Bindings
: 快捷键(⇧ + ⌥ + F),默认关闭Group
:MAP两两一组,默认不分组Algin As
:字段别名对齐,默认对齐
5 卸载插件
左侧单击插件市场按钮,在已安装列表中找到需要卸载的插件,鼠标移动至右侧的设置按钮,单击卸载,即可完成插件卸载。