SQL注释

为了增强代码的可读性,您可以在MaxCompute SQL代码中增加注释。本文为您介绍MaxCompute SQL单行注释与多行注释的使用说明。

使用限制

  • 目前暂不支持在DataWorks数据开发页面中使用多行注释功能。

  • 若您在MaxCompute本地客户端(odpscmd)中使用SQL注释,则odpscmd必须为V0.49.0及以上版本。

  • 本地客户端(odpscmd)云命令行(odpscmd)中使用单行注释时,必须以半角分号(;)作为注释的结束符。对于多行注释,暂不支持包含半角分号(;)。

语法格式

单行注释

使用--作为单行注释的起始符号。语法如下:

-- 注释内容

--开始,直至该行结束的所有内容均视为注释,可以将注释单独放置于一行(位于代码上方),或置于代码的右侧。

说明

若您在MaxCompute控制台的SQL分析界面或DataWorks数据开发页面编写SQL代码,可使用Ctrl+/快捷键为目标代码行添加单行注释。

多行注释

使用/*作为多行注释的起始符号,*/作为多行注释的结束符号,实现一次性注释程序中多行的内容。语法如下:

/* 
注释
内容
*/
重要

MaxCompute同时支持使用/*+...*/作为Hint语法,例如MAPJOIN HINTSKEWJOIN HINT,Hint的优先级高于多行注释。因此,务必确保多行注释的起始符号不会被识别为Hint的起始符号,建议可以用/**作为多行注释的起始符号。

使用示例

假设my_table为已存在的表名,注释示例如下:

  • 示例1:有效的单行注释。

    -- 单行注释
    DESC my_table; -- 单行注释
  • 示例2:有效的多行注释。

    SELECT /* 有效的
    多行
    注释
    */ * FROM my_table;
  • 示例3:无效的多行注释,其中/*+被识别成了Hint的起始标识。

    SELECT /*+ 无效的
    多行
    注释
    */ * FROM my_table;