分享方式：

Databricks Driver for SQLTools for Visual Studio Code

  • 文章

重要

這項功能處於公開預覽狀態。

Databricks Driver for SQLTools 可讓您使用 Visual Studio Code 的 SQLTools 擴充功能來流覽 SQL 物件，並在遠端 Azure Databricks 工作區中執行 SQL 查詢。

開始之前

您必須先符合下列需求，Azure Databricks 工作區和本機開發計算機才能使用 Databricks Driver for SQLTools。

工作區需求

您必須至少有一個 Azure Databricks 工作區可供使用，且工作區必須符合下列需求：

本機開發電腦需求

您必須在本機開發電腦上具有下列專案：

若要安裝 SQLTools 擴充功能，請移至 [SQLTools ]，然後按兩下 [ 安裝]，或：

  1. 在 Visual Studio Code 中，單擊主功能表上的 [ 檢視 > 延伸模組 ]。

  2. 在 [ Marketplace 中的搜尋延伸模組] 方塊 中，輸入 SQLTools。

  3. 按兩下 Matheus Teixeira 的 SQLTools 專案。

    注意

    可能列出多個 SQLTools 專案。 請務必按一下 Matheus Teixeira 中的專案。

  4. 按一下 [安裝]。

若要安裝 Databricks Driver for SQLTools 擴充功能，請移至 Databricks Driver for SQLTools ，然後按兩下 [安裝]，或：

  1. 在 Visual Studio Code 中，單擊主功能表上的 [ 檢視 > 延伸模組 ]。
  2. 在 [ Marketplace 中的搜尋延伸模組] 方塊 中，輸入 Databricks Driver for SQLTools。
  3. 按兩下 Databricks Driver for SQLTools 專案。
  4. 按一下 [安裝]。

驗證

您必須設定 Databricks Driver for SQLTools 的驗證，如下所示。

Databricks Driver for SQLTools 支援下列 Azure Databricks 驗證類型：

注意

Databricks Driver for SQLTools 不支援Microsoft Entra ID （先前稱為 Azure Active Directory） 令牌。

Azure Databricks 個人存取令牌驗證

若要搭配 Azure Databricks 個人存取令牌驗證使用 Databricks Driver for SQLTools，您必須具有 Azure Databricks 個人存取令牌。 若要建立個人存取令牌，請執行下列動作：

  1. 在 Azure Databricks 工作區中，按兩下頂端列中的 Azure Databricks 使用者名稱，然後從下拉式清單中選取 [設定 ]。
  2. 按兩下 [ 開發人員]。
  3. 按兩下 [存取令牌] 旁的 [管理]。
  4. 按一下 [產生新權杖]。
  5. （選擇性）輸入批注，協助您在未來識別此令牌，並變更令牌的預設存留期 90 天。 若要建立沒有存留期的令牌（不建議），請將 [ 存留期（天）] 方塊保留空白（空白）。
  6. 按一下 [產生]。
  7. 將顯示的令牌複製到安全的位置，然後按兩下 [ 完成]。

注意

請務必將複製的令牌儲存在安全的位置。 請勿與其他人共享複製的令牌。 如果您遺失複製的令牌，就無法重新產生完全相同的令牌。 相反地，您必須重複此程式來建立新的令牌。 如果您遺失複製的令牌，或您認為令牌已遭入侵，Databricks 強烈建議您按兩下存取令牌頁面上令牌旁邊的垃圾桶 （Revoke） 圖示，立即從工作區中刪除該令牌。

如果您無法在工作區中建立或使用令牌，這可能是因為您的工作區系統管理員已停用令牌，或未授與您建立或使用令牌的許可權。 請參閱您的工作區管理員或下列專案：

Azure Databricks OAuth 機器對機器 （M2M） 驗證

您可以使用 Azure Databricks OAuth 機器對機器 （M2M） 驗證向 Databricks Driver for SQLTools 進行驗證 ，如下所示：

注意

Databricks Driver for SQLTools 0.4.2 版和更新版本提供 Azure Databricks OAuth M2M 驗證。

  1. 完成 OAuth M2M 驗證的設定步驟。 請參閱 OAuth 計算機對電腦 （M2M） 驗證。
  2. 使用您的 OAuth M2M 驗證組態設定建立 Azure Databricks 組態配置檔。 請參閱 OAuth 計算機對電腦 （M2M） 驗證的一節。
  3. 在您的本機開發計算機上安裝並開啟適用於Visual StudioCode 的 Databricks 擴充功能。
  4. 在 Visual Studio Code 的 Databricks 擴充功能中，按兩下 [設定] 窗格中的 [設定] 按鈕。 如果未顯示 [ 設定 ] 按鈕，請改為單擊齒輪 （設定工作區） 圖示。
  5. 在命令選擇區中，針對 Databricks 主機，輸入您的 Azure Databricks 個別工作區 URL，例如 https://adb-1234567890123456.7.azuredatabricks.net，然後按 Enter。
  6. 選取符合您在步驟 2 中建立的組態設定文件專案。
  7. 完成網頁瀏覽器中的畫面指示，以使用 Azure Databricks 帳戶完成驗證。

Azure Databricks OAuth 使用者對機器 （U2M） 驗證

您可以使用 Azure Databricks OAuth 使用者對機器 （U2M） 驗證向 Databricks Driver for SQLTools 進行驗證 ，如下所示：

注意

Databricks Driver for SQLTools 0.4.2 版和更新版本提供 Azure Databricks OAuth U2M 驗證。

  1. 在您的本機開發計算機上安裝並開啟適用於Visual StudioCode 的 Databricks 擴充功能。
  2. 在 Visual Studio Code 的 Databricks 擴充功能中，按兩下 [設定] 窗格中的 [設定] 按鈕。 如果未顯示 [ 設定 ] 按鈕，請改為單擊齒輪 （設定工作區） 圖示。
  3. 在命令選擇區中，針對 Databricks 主機，輸入您的 Azure Databricks 個別工作區 URL，例如 https://adb-1234567890123456.7.azuredatabricks.net。 然後按 Enter。
  4. 選取 [OAuth][用戶到計算機]。
  5. 完成網頁瀏覽器中的畫面指示，以使用 Azure Databricks 帳戶完成驗證。 如果出現提示，請允許 all-apis 存取。

Azure CLI 驗證

您可以使用 Azure CLI 向 Databricks Driver for SQLTools 進行驗證，如下所示：

注意

使用 Azure CLI 進行驗證處於 實驗 性功能狀態。 這項功能可在 Databricks Driver for SQLTools 0.4.2 版和更新版本中取得。

  1. 如果您尚未這麼做，請在本機開發計算機上安裝 Azure CLI 。
  2. 在您的本機開發計算機上安裝並開啟適用於Visual StudioCode 的 Databricks 擴充功能。
  3. 在 Visual Studio Code 的 Databricks 擴充功能中，按兩下 [設定] 窗格中的 [設定] 按鈕。 如果未顯示 [ 設定 ] 按鈕，請改為單擊齒輪 （設定工作區） 圖示。
  4. 在命令選擇區中，針對 Databricks 主機，輸入您的 Azure Databricks 個別工作區 URL，例如 https://adb-1234567890123456.7.azuredatabricks.net。 然後按 Enter。
  5. 選取 [Azure CLI]。
  6. 遵循螢幕上的提示，以使用 Azure CLI 完成驗證。

線上至架構

  1. 在 Visual Studio Code 的提要欄中，按兩下 [SQLTools ] 圖示。
  2. 在 SQLTools 檢視中，如果這是您第一次使用 SQLTools 擴充功能，請按兩下 [連線] 窗格中的 [新增連線]。 否則，請按下窗格標題列中的 [ 新增連線 ] 圖示。
  3. 在 [ SQLTools 設定 ] 索引標籤上 ，針對 [選取資料庫驅動程式 ] 步驟，按兩下 [Databricks ] 圖示。
  4. 針對 [ 連線設定 ] 步驟，輸入下列有關倉儲、目錄和架構的資訊：

    1. 針對 [ 連線名稱]，輸入此連線的一些唯一名稱。

    2. （選擇性）針對 [ 連線群組 ] 輸入現有連接群組的名稱，以將新的連線新增至該群組。 或者，輸入唯一的名稱，以建立具有新聯機的新聯機群組。 線上群組可讓您更輕鬆地在擴充功能中尋找連線。

    3. 針對 [使用連線]，選取下列其中一項：

      • 若要使用 Azure Databricks 個人存取令牌進行驗證，請選取 [主機名] 和 [ 令牌]。
      • 針對 Databricks Driver for SQLTools 0.4.2 版和更新版本，若要使用 OAuth U2M 或 M2M 或 Azure CLI 驗證，請選取 VS Code 擴充功能 （beta）。

    4. 如果您選取 [使用 連線的主機名] 和 [令牌]，則針對 [主機] 輸入倉儲的伺服器主機名設定。 若要取得倉儲的伺服器 主機名 設定，請參閱 取得 Azure Databricks 計算資源的連線詳細數據。

    5. 針對 [路徑]，輸入倉儲或叢集的 HTTP 路徑 設定。 若要取得倉儲的 HTTP 路徑 設定，請參閱 取得 Azure Databricks 計算資源的連線詳細數據。

    6. 如果您選取 [主機名] 和 [令牌] 以連線，請在 [令牌] 中輸入您的 Azure Databricks 個人存取令牌值。

    7. 針對 [目錄]，輸入目錄的名稱。

      注意

      針對未針對 Unity 目錄啟用的工作區，您可以將 Catalog 保留空白，以使用的預設值hive_metastore。

    8. 針對 [架構]，輸入架構的名稱。

    9. （選擇性）針對 [ 顯示記錄預設限制]，保留預設值 50 ，只顯示每個查詢的前 50 個數據列，或輸入不同的限制。

  5. 按一下 [測試連接] 。
  6. 如果連線測試成功，請按兩下 [ 儲存連線]。

變更連線的設定

此程式假設您已成功連線到至少一個倉儲。

  1. 如果看不到 SQLTools 檢視，請在 Visual Studio Code 的提要欄中，按兩下 [SQLTools ] 圖示。
  2. 在 [ 連線] 窗格中，如果目標連線存在，請展開連線群組。
  3. 以滑鼠右鍵按兩下連線，然後按兩下 [ 編輯連線]。
  4. 變更目標設定。
  5. 按一下 [測試連接] 。
  6. 如果連線測試成功，請按兩下 [ 儲存連線]。

瀏覽架構的物件

  1. 在 [ 連線] 窗格中，如果目標連線存在，請展開連線群組。
  2. 按兩下或展開倉儲的目標連線。
  3. 如果連線存在目標資料庫，請展開目標資料庫 （schema）。
  4. 如果資料庫有一或多個數據表或檢視表，請展開 [數據表 ] 或 [檢視表]。
  5. 展開任何目標數據表或檢視表，以檢視數據表或檢視的數據行。

檢視數據表或檢視表的數據列或架構

在 [連接] 窗格中展開 [數據表] 或 [檢視] 時，執行下列其中一項動作：

  • 若要顯示數據表或檢視的數據列，請以滑鼠右鍵按兩下數據表或檢視表，然後按兩下 [顯示資料表記錄] 或 [顯示檢視記錄]。
  • 若要顯示數據表或檢視表的架構，請以滑鼠右鍵按兩下資料表或檢視表，然後按兩下 [描述數據表] 或 [描述檢視]。

產生數據表的插入查詢

  1. 將游標放在現有的編輯器中，放在您要加入插入查詢的位置。
  2. 在 [連接] 窗格中展開 [數據表] 時，以滑鼠右鍵按兩下數據表，然後按兩下 [產生插入查詢]。 插入查詢的定義會加入至數據指標的插入點。

建立並執行查詢

此程式假設您已成功連線到至少一個倉儲。

  1. 在 [ 連線] 窗格中，如果目標連線存在，請展開連線群組。
  2. 按兩下或展開倉儲的目標連線。
  3. 選取連接后，按兩下 [連線] 窗格標題列中的[新增 SQL 檔案]。 新的編輯器索引標籤隨即出現。
  4. 在新編輯器中輸入您的 SQL 查詢。
  5. 若要執行 SQL 查詢，請按下編輯器中的 [ 在作用中連線 上執行]。 查詢的結果會顯示在新編輯器索引標籤中。

執行現有的查詢

此程式假設您已成功連線到至少一個倉儲。

  1. 在 [ 連線] 窗格中，如果目標連線存在，請展開連線群組。
  2. 按兩下或展開倉儲的目標連線。
  3. 選取連接后，開啟擴展名為 .sql的任何檔案，或在先前開啟的任何編輯器中選取任何連續 SQL 語句群組。
  4. 若要從開啟 .sql 的檔案執行 SQL 查詢，並在編輯器中顯示您的 .sql 檔案內容，請在編輯器中按兩下 [在作用中連接 上執行]。 查詢的結果會顯示在新編輯器索引標籤中。
  5. 若要在先前開啟的編輯器中執行選取的 SQL 語句群組，請以滑鼠右鍵按下您的選取專案，然後按兩下 [ 執行選取的查詢]。 查詢的結果會顯示在新編輯器索引標籤中。

將使用量記錄傳送至 Databricks

如果您在使用 Databricks Driver for SQLTools 時遇到問題，您可以執行下列動作，將使用量記錄和相關信息傳送至 Databricks 支援：

  1. 在本機開發計算機上安裝適用於 Visual Studio Code 的 Databricks 擴充功能。
  2. 檢查 [記錄：已啟用] 設定或設定databricks.logs.enabled為 true來開啟記錄，如 Visual Studio Code Databricks 延伸模組的設定中所述，請務必在開啟記錄之後重新啟動 Visual Studio Code。
  3. 嘗試重現您的問題。
  4. 從命令選擇區 （從主功能表檢視>命令選擇區），執行 Databricks：開啟完整記錄命令。
  5. Databricks Logs.log將出現的、 databricks-cli-logs.json和 sdk-and-extension-logs.json 檔案傳送給 Databricks 支援。
  6. 同時複製問題內容中的終端機 （檢視>終端機）內容，並將此內容傳送至 Databricks 支援。

[ 輸出 ] 檢視 [檢視 > 輸出]、[Databricks 記錄檔] 顯示已截斷的資訊，如果 已核取 [記錄：已啟用 ] 或 databricks.logs.enabled 設定為 true。 若要顯示詳細資訊，請變更下列設定，如 Visual Studio Code Databricks 延伸模組的設定中所述：

  • 記錄：陣列長度 上限或 databricks.logs.maxArrayLength
  • 記錄：欄位長度 上限或 databricks.logs.maxFieldLength
  • 記錄：截斷深度 或 databricks.logs.truncationDepth

其他資源