共用方式為


使用 Visual Studio Code 連線並查詢 Azure Cosmos DB 執行個體

Visual Studio Code 是適用於 Linux、macOS 和 Windows 的多功能程式碼編輯器,支援眾多延伸模組。 這個快速入門教你如何使用 Visual Studio Code 連接 Azure Cosmos DB for NoSQL 和 Azure Cosmos DB for MongoDB。 它涵蓋執行核心資料庫作業,包括查詢、插入、更新和刪除資料。

先決條件

  • 已設定資料庫與容器的 Azure Cosmos DB for NoSQL 帳戶。 使用下列任一快速入門來設定資源:

安裝擴充功能

若要在 Visual Studio 中連線並管理 Azure Cosmos DB 資料,請先安裝 Azure Databases 延伸模組。

  1. 開啟 Visual Studio Code。
  2. 可透過選取 [檢視] > [延伸模組] 或使用捷徑,在 Windows 上按 [Ctrl + Shift + X]、在 macOS 上按 [Command + Shift + X] 來存取 [延伸模組] 面板。
  3. 在搜尋列輸入 DocumentDB for Visual Studio Code,然後選取該延伸模組。 然後,選取 [安裝]
  4. 安裝完成後,如有提示,請重新載入 Visual Studio Code。

連線到 Azure Cosmos DB for NoSQL

  1. 在 Visual Studio Code 中,前往 [Azure] 面板 (在活動列選取 [Azure] 圖示)。

  2. 透過 Microsoft Entra ID 登入您的 Azure Cosmos DB for NoSQL 帳戶:

    附註

    存取 Azure Cosmos DB 資源時,請使用 Microsoft Entra ID 角色型存取控制。

  3. 登入後,在 Azure 樹狀檢視中找到您的 Azure 訂用帳戶,然後向下切入至 Azure Cosmos DB。

  4. 選取現有帳戶,或按右鍵建立新資源。

查詢並顯示您的資料

下列步驟會使用查詢編輯器來執行查詢,並檢視查詢的結果:

  1. 在您集合的功能表中,於集合上按右鍵以在預覽中開啟查詢編輯器。

    Visual Studio Code 中查詢編輯器的螢幕擷取畫面。

  2. 在查詢編輯器中執行提供的查詢,以在資料表檢視中顯示您的資料:

    Visual Studio Code 中查詢編輯器結果的螢幕擷取畫面。

  3. 在其他支援的檢視中探索您的資料:

    • JSON 檢視:查看未經處理資料結構。

      查詢編輯器在 JSON 檢視中的結果螢幕擷取畫面。

    • 樹狀檢視:輕鬆探索巢狀資料。

      查詢編輯器在樹狀檢視中的結果螢幕擷取畫面。

檢視查詢和索引計量

在查詢編輯器中,檢視更多查詢和索引計量,以更有效地最佳化您的查詢效能。

  1. 選取位於查詢 [結果] 旁的 [狀態] 索引標籤。 Visual Studio Code 中查詢狀態的螢幕擷取畫面。

  2. 如需計量定義的詳細資訊,請參閱查詢計量文件

插入、編輯和刪除文件

  • 即時文件編輯:立即新增、檢視、編輯和刪除文件,變更會即時反映。

  • 從 JSON 匯入:快速從 JSON 檔案載入資料。 在 Visual Studio Code 中編輯文件的螢幕擷取畫面。

匯出查詢結果

  • 下載結果:將查詢結果下載為 CSV 或 JSON 檔案。 在 Visual Studio Code 中匯出結果的螢幕擷取畫面。

先決條件

  • 已設定資料庫與容器的 Azure Cosmos DB for NoSQL 帳戶。
  • 已安裝 MongoDB 殼層 (mongosh) 以進行命令列互動 (選用但建議安裝)。

安裝擴充功能

若要在 Azure Cosmos DB 中連線和管理資料,您需要為 Visual Studio Code 安裝 Azure Databases 延伸模組。

  1. 開啟 Visual Studio Code。
  2. 可透過選取 [檢視] > [延伸模組] 或使用捷徑,在 Windows 上按 [Ctrl + Shift + X]、在 macOS 上按 [Command + Shift + X] 來存取 [延伸模組] 面板。
  3. 在搜尋列輸入 DocumentDB for Visual Studio Code,然後選取該延伸模組。 然後,選取 [安裝]
  4. 安裝完成後,如有提示,請重新載入 Visual Studio Code。

連線至 MongoDB 工作負載

現在,連線至 Azure Cosmos DB for MongoDB 中的 MongoDB 工作負載。

  1. 在 [工作區] 面板中,展開 [MongoDB 帳戶] 區段。

  2. 在這裡,您可以檢視所有的 MongoDB 帳戶。 使用您的認證連線至新的 MongoDB 帳戶。

    附註

    所有成功連線的 MongoDB 叢集都會保留在 MongoDB 帳戶區段,即使關閉 Visual Studio Code 也不會消失。

直覺化資料管理

在 Visual Studio Code 中輕鬆管理您的資料庫:

  • 建立與刪除資料庫/集合:使用資源面板中帳戶、資料庫或集合的快顯功能表來建立或刪除資料庫與集合。

  • 從 JSON 匯入:快速將資料從 JSON 檔案匯入您的集合。

    • 開始匯入
      1. 在資源檢視中,於集合名稱上按右鍵,然後選取 [將文件匯入至集合]
      2. 或者,點選集合中的 [文件] 項目以開啟 [集合檢視],然後選取 [匯入] 按鈕。
    • 選取 JSON 檔案
      1. 瀏覽以尋找包含您資料的 *.json 檔案。
      2. 確認以啟動匯入處理程序。
  • 匯出資料:將集合或查詢結果儲存為 JSON,以進行備份或共用。

    • 開始匯出
      • 選項 1
        1. 在資源檢視中,於集合名稱上按右鍵,然後選取 [從集合匯出文件] 以匯出整個集合。
      • 選項 2
        1. 點選集合中的 [文件] 項目以開啟 [集合檢視],然後選取 [匯出] 按鈕。
        2. 選擇匯出整個集合或目前查詢的結果。
    • 指定目的地檔案
      1. 輸入目的地 *.json 檔案的名稱和位置。
      2. 確認匯出以開始儲存資料。
  • 即時文件編輯:立即新增、檢視、編輯和刪除文件,並即時更新。

    • 開啟文件編輯
      • 可直接在 [集合檢視] 中存取文件編輯選項。這些控制項位於資料檢視上方,方便存取。
    • 可用動作
      • 新增:在集合中建立新文件。
      • 檢視:查看所選文件的內容。
      • 編輯:修改所選文件的內容。
      • 刪除:移除所選文件,變更將立即生效。

MongoDB 實例的 VS-code 擴充截圖。

強大的查詢工具

順暢地執行您的查詢,並縮小搜尋範圍:

  • 即時結果: 立即以您偏好的格式 (資料表、JSON 或樹狀檢視) 檢視查詢結果。

    • 可透過 [檢視] 下拉式功能表輕鬆切換檢視。
  • 直接執行查詢:撰寫並執行 MongoDB 查詢,具備語法醒目提示與自動完成等功能。

    • 若要執行查詢,請在查詢編輯器中選取 [查詢尋找] 按鈕或按 Ctrl/Cmd+Enter

附註

目前僅支援尋找篩選查詢,擴充查詢功能即將推出。

彈性資料檢視

使用多種檢視探索您的資料,以獲得不同的觀點:

  • JSON 檢視:查看原始 JSON 資料結構。

    VS Code 延伸模組中 MongoDB 執行個體的 JSON 檢視螢幕擷取畫面。

  • 樹狀檢視:輕鬆瀏覽並探索巢狀資料。

    VS Code 延伸模組中 MongoDB 執行個體的樹狀檢視螢幕擷取畫面。

  • 資料表檢視:快速掃描資料並深入檢視巢狀文件。

    • 若要向下切入:尋找具有 {} 圖示的項目,這些圖示表示內嵌物件。 按兩下以展開和檢視內容。

    • 若要返回:使用資料表檢視下方瀏覽階層連結返回上一層。

    VS Code 延伸模組中 MongoDB 執行個體的資料表檢視螢幕擷取畫面。

Mongo 殼層整合

提供命令列功能:

  • 啟動mongosh:直接在 Visual Studio Code 中執行進階 MongoDB 命令。

附註

MongoDB 殼層 (mongosh) 不包含在延伸模組中。 必須另外安裝並手動設定。

叢集管理

隨時掌握您的資源:

  • 檢視叢集詳細資料:查看叢集的階層、伺服器版本及資源使用狀況。

  • 管理標籤:使用可與 Azure 入口網站同步的標籤來組織叢集。