全部產品
Search
文件中心

MaxCompute:SQL注釋

更新時間:Nov 16, 2024

為了增強代碼的可讀性,您可以在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;