JupyterLab SQL 延伸模組的 SQL 編輯器功能

SQL 擴充功能提供魔術命令，可啟用 JupyterLab 筆記本儲存格內的 SQL 編輯器功能。

如果您是 SageMaker 分佈映像 1.6 版的使用者，則必須在 JupyterLab 筆記本%load_ext amazon_sagemaker_sql_magic中執行，以載入 SQL 延伸魔術程式庫。這會開啟 SQL 編輯功能。

對於 SageMaker 分佈映像 1.7 版及更新版本的使用者，不需要任何動作，SQL 延伸模組會自動載入。

載入擴充功能後，請在儲存格開頭新增%%sm_sql魔術命令，以啟用 SQL 編輯器的下列功能。

• Connection-selection 下拉式清單：在將%%sm_sql魔術命令新增至儲存格時，下拉式功能表會顯示在儲存格頂端，其中包含可用的資料來源連線。選取連線以自動填入查詢該資料來源所需的參數。以下是透過選取名為 的連線所產生的%%sm_sql魔術命令字串範例connection-name。

  %%sm_sql --metastore-type GLUE_CONNECTION --metastore-id connection-name

  使用以下 SQL 編輯器的功能來建置 SQL 查詢，然後執行儲存格來執行查詢。如需 SQL 執行功能的詳細資訊，請參閱JupyterLab SQL 延伸模組的 SQL 執行功能。

• 查詢結果下拉式清單：您可以從連線選擇下拉式功能表旁的下拉式功能表中選取結果類型，以指定如何呈現查詢結果。選擇下列兩種替代方案：

  • 儲存格輸出：（預設） 此選項會在筆記本儲存格輸出區域中顯示查詢的結果。

  • Pandas Dataframe：此選項會將查詢結果填入 pandas DataFrame。額外的輸入方塊可讓您在選擇此選項時命名 DataFrame。

• SQL 語法反白：儲存格會自動以視覺方式區分 SQL 關鍵字、子句、運算子等，依顏色和樣式區分。這可讓 SQL 程式碼更容易閱讀和理解。關鍵字，例如 SELECT、WHERE、 FROM和 等內建函數，例如 SUM和 COUNT，或 等子句GROUP BY，以不同的顏色和粗體樣式反白顯示。

• SQL 格式：您可以透過下列其中一種方式，將一致的縮排、大寫、間距和換行套用至群組或個別的 SQL 陳述式和子句。這可讓 SQL 程式碼更容易閱讀和理解。

  • 在 SQL 儲存格上按一下滑鼠右鍵，然後選擇格式化 SQL。

  • 當 SQL 儲存格成為焦點時，請在 Windows 上使用 ALT + F 捷徑，或在 MacOS 上使用選項 + F。

• SQL 自動完成：延伸項目會在您輸入時提供 SQL 關鍵字、函數、資料表名稱、資料欄名稱等的自動建議和完成。當您開始輸入 SQL 關鍵字，例如 SELECT或 時WHERE，延伸模組會顯示快顯視窗，其中包含自動完成其餘字詞的建議。例如，在輸入資料表或資料欄名稱時，建議比對資料庫結構描述中定義的資料表和資料欄名稱。

  重要

  若要在 JupyterLab 筆記本中啟用 SQL 自動完成，SageMaker AI 分佈映像 1.6 版的使用者必須在終端機中執行下列npm install -g vscode-jsonrpc sql-language-server命令。安裝完成後，執行 以重新啟動 JupyterLab 伺服器restart-jupyter-server。

  對於 SageMaker 分佈映像 1.7 版和更新版本的使用者，不需要任何動作。

  儲存格提供兩種自動完成已辨識 SQL 關鍵字的方法：

  • 明確調用 （建議）：選擇 Tab 鍵以啟動內容感知建議功能表，然後選擇輸入以接受建議的項目。

  • 持續提示：儲存格會在您輸入時自動建議完成。

  注意

  • 只有在 SQL 關鍵字為大寫時，才會觸發自動完成。例如，輸入 的SEL提示SELECT，但輸入sel不會。

  • 當您第一次連線到資料來源時，SQL 自動完成會為資料來源的中繼資料編製索引。此索引程序可能需要一些時間才能完成，具體取決於資料庫的大小。