使用 Visual Studio 程式碼擴充功能進行開發

Oracle NoSQL Database Cloud ServiceMicrosoft Visual Studio Code 提供擴充功能,可讓您連線至執行中的 Oracle NoSQL Database Cloud Service 執行處理。

您可以使用 Oracle NoSQL Database Visual Studio (VS) 程式碼擴充功能來執行下列作業:
  • 使用「表格總管」以定義完善的樹狀目錄結構檢視表格。
  • 檢視表格的資料欄、索引、主索引鍵以及分區索引鍵資訊。
  • 以正確格式的 JSON 結構檢視資料欄資料。
  • 使用表單式綱要項目或提供 DDL 敘述句來建立表格。
  • 刪除表格。
  • 使用表單式項目或提供 DDL 敘述句來新增資料欄。
  • 刪除資料欄。
  • 建立索引。
  • 刪除索引。
  • 對表格執行 SELECT SQL 查詢,並以列表化格式檢視查詢結果。
  • 執行 DML 敘述句以更新、插入以及刪除表格的資料。
  • 將執行 SELECT 查詢後的「查詢結果」下載至 JSON 檔案。
  • 將執行 SELECT 查詢後取得的每個結果資料列下載至 JSON 檔案。

本文包含下列主題:

安裝 Oracle NoSQL Database Visual Studio 程式碼擴充功能

您可以使用兩種方式安裝 Oracle NoSQL Database VS Code 擴充功能。從 Visual Studio Marketplace 安裝進行線上安裝,或使用 *.vsix 檔案從 VSIX 套件進行離線安裝。

您必須先安裝 Visual Studio 程式碼,才能安裝 Oracle NoSQL Database Visual Studio (VS) 程式碼擴充功能。您可以從此處下載 Visual Studio Code。
  1. 在 Visual Studio 程式碼中,按一下左側導覽中的擴充功能圖示。


    Visual Studio 程式碼活動列

    或者,您可以按下下列按鈕來開啟擴充功能檢視:
    • (Windows 和 Linux) 控制 + Shift + X
    • (macOS) 命令 + Shift + X。
  2. 在擴充市集中搜尋 Oracle NoSQL Database Connector
  3. Oracle NoSQL Database Connector 擴充功能上按一下「安裝」
  1. Oracle NoSQL Database 下載網站下載 Oracle NoSQL Database 的 VSIX 檔案。
  2. 在 Visual Studio 程式碼中,按一下左側導覽中的擴充功能圖示。


    Visual Studio 程式碼活動列

    或者,您可以按下下列按鈕來開啟擴充功能檢視:
    • (Windows 和 Linux) 控制 + Shift + X
    • (macOS) 命令 + Shift + X。
  3. 擴充功能檢視中,按一下其他動作 (...) 功能表,然後按一下從 VSIX 安裝 ...


    從 VSIX 動作安裝

  4. 瀏覽至儲存 *.vsix 檔案的位置,然後按一下安裝

從 Visual Studio 程式碼連線至 Oracle NoSQL Database Cloud Service

Oracle NoSQL Database Visual Studio (VS) Code 擴充功能提供兩種連線至 Oracle NoSQL Database Cloud ServiceOracle NoSQL Database Cloud Simulator 的方法。

您可以提供組態檔的連線資訊,或在特定欄位中填入連線資訊。如果您使用 Node.js 驅動程式且已將連線詳細資訊儲存在檔案中,請使用「透過組態檔連線」選項連線至 Oracle NoSQL Database Cloud Service 。否則,如果您要建立新連線,請使用「填寫個別欄位」選項。
  1. 在 Visual Studio 程式碼中,按一下活動列中的 Oracle NoSQL DB 檢視。


    Visual Studio 程式碼活動列

  2. 從「命令選用區」或活動列中的 Oracle NoSQL DB 檢視,開啟 Oracle NoSQL DB 顯示連線設定值頁面。
    • 從命令選用區開啟
      1. 命令選用區
        • (Windows 和 Linux) 控制 + Shift + P
        • (macOS) 命令 + Shift + P
      2. 從「命令選用區」中選取 OracleNoSQL:顯示連線設定值

        秘訣:

        在「命令選用區」中輸入 oraclenosql ,即可顯示所有您可以使用的 Oracle NoSQL DB 命令。


        Oracle NoSQL DB 顯示連線設定值命令

    • 從 Oracle NoSQL DB 檢視開啟
      1. 展開左側導覽中的 TABLE EXPLORER 窗格 (如果隱藏)。
      2. 按一下新增連線以開啟 Oracle NoSQL DB 顯示連線設定值頁面。


      Oracle NoSQL DB 表格總管

  3. 顯示連線設定值頁面中,按一下雲端CloudSim 以連線至 Oracle NoSQL Database Cloud ServiceOracle NoSQL Database Cloud Simulator


    Oracle NoSQL Database Cloud Service 的 NoSQL 資料庫連線設定值

  4. 輸入連線資訊。

    表格 - 雲端連線參數

    欄位 描述 範例值
    區域: 選取 Oracle NoSQL Database Cloud Service 端點的「區域」ID。 us-ashburn-1
    組態檔案: 瀏覽至儲存 OCI 組態檔的位置。 /home/user/security/config/oci.config
    設定檔: 要用來連線至 Oracle NoSQL Database Cloud Service 的組態設定檔名稱。

    如果您未指定此值,欄位會預設為 DEFAULT 設定檔。

    ADMIN_USER
    區間: Oracle NoSQL Database Cloud Service 綱要之區間的名稱或 OCID。

    如果您未提供任何值,欄位會預設為 root 區間。

    您可以在 Oracle Cloud Infrastructure Identity and Access Management (IAM) 中建立區間。請參閱 Oracle Cloud Infrastructure 文件中的設定您的租用戶管理區間

    • 區間名稱

      我的區間

    • 以其父項區間限定區塊名稱

      parent.childcompartment

    • Compartment OCID

      ocid1.tenancy.oc1...<unique_ID>

    租用戶 OCID: Oracle NoSQL Database Cloud Service 的租用戶 OCID。請參閱 Oracle Cloud Infrastructure 文件中的 Where to Get the Tenancy's OCID and User's OCID ocid1.tenancy.oc1..<unique_ID>
    使用者 OCID: Oracle NoSQL Database Cloud Service 的使用者 OCID。請參閱 Oracle Cloud Infrastructure 文件中的 Where to Get the Tenancy's OCID and User's OCID ocid1.user.oc1..<unique_ID>
    Fingerprint: 新增至此使用者的私密金鑰指紋。

    產生並上傳 API 簽署金鑰時,會建立簽署金鑰的指紋。請參閱 Oracle Cloud Infrastructure 文件中的如何取得金鑰的指紋

    12:34:56:78:90:ab:cd:ef:12:34:56:78:90:ab:cd:ef
    私密金鑰檔案: 瀏覽至儲存私密金鑰的位置。請參閱 How to Generate an API Signing Key ,以使用選擇性的密碼詞組來產生簽署金鑰。 /home/user/.oci/oci_api_key.pem
    密碼詞組: 建立私密金鑰時所指定的密碼詞組。產生並上傳「API 簽章金鑰」時,會建立簽章金鑰的密碼。請參閱 Oracle Cloud Infrastructure 文件中的如何取得金鑰的指紋

    是必要的,只有金鑰經過加密時才需要。

     
    區間: Oracle NoSQL Database Cloud Service 綱要之區間的名稱或 OCID。

    如果您未提供任何值,欄位會預設為 root 區間。

    您可以在 Oracle Cloud Infrastructure Identity and Access Management (IAM) 中建立區間。請參閱 Oracle Cloud Infrastructure 文件中的設定您的租用戶管理區間

    • 區間名稱

      我的區間

    • 以其父項區間限定區塊名稱

      parent.childcompartment

    • Compartment OCID

      ocid1.tenancy.oc1...<unique_ID>

    表格 - CloudSim 連線參數

    欄位 描述 範例值
    Endpoint: Oracle NoSQL Database Cloud Simulator 執行處理的「服務端點 URL」。 http://myinstance.cloudsim.com:8080

    如果未指定值,則預設為 http://localhost:8080

    用戶 ID: 識別租用戶的唯一 ID。 Tenant01

    如果未指定值,則預設為 TestTenant

  5. 按一下連線
  6. 按一下重設,從工作區清除儲存的連線詳細資訊。
  1. 建立組態檔,例如 config.json 或包含 JSON 物件的檔案。連線至 Oracle NoSQL Database Cloud ServiceOracle NoSQL Database Cloud Simulator 的組態檔格式如下所示。

    表格 - 組態範本

    Oracle NoSQL Database Cloud Service Oracle NoSQL Database 雲端模擬器
    使用 OCI 組態檔連線的組態樣板
    {
     "region": "<region-id-of-nosql-cloud-service-endpoint>",
     "compartment": "<oci-compartment-name-or-id>",
     "auth":
      {
       "iam":
        {
         "configFile": "<path-to-OCI-config-file>", 
         "profileName": "<oci-credentials-profile-name>"
        }
      }
    }
    使用 IAM 認證證明資料連線的組態樣板
    {
     "region": "<region-id-of-nosql-cloud-service-endpoint>",
     "compartment": "<oci-compartment-name-or-id>",
     "auth":
      {
       "iam":
        {
         "tenantId": "<tenancy-ocid>",
         "userId": "<user-ocid>",
         "fingerprint": "<fingerprint-for-the-signing-key>",
         "privateKeyFile": "<path-to-the-private-key>",
         "passphrase": "<passphrase-of-the-signing-key>"
         }
       }
    }
    {
     "endpoint": "http://myinstance.cloudsim.com:8080",
     "auth" : "Bearer<tenant-id>"
    }
  2. 按下列鍵開啟 [ 指令選盤 ]:
    • (Windows 和 Linux) 控制 + Shift + X
    • (macOS) 命令 + Shift + X
  3. 從「命令選用區」中選取 Oracle NoSQL:透過組態檔連線

    秘訣:

    在「命令選用區」中輸入 oraclenosql ,即可顯示所有您可以使用的 Oracle NoSQL DB 命令。


    透過組態檔連線

  4. 瀏覽至儲存 *.config 檔案的位置,然後按一下選取

使用 Visual Studio 程式碼擴充功能管理表格

使用 Oracle NoSQL Database Visual Studio (VS) Code 擴充功能連線至部署後,請使用左側導覽中的 TABLE EXPLORER 來執行下列作業:
  • 探索表格、資料欄、索引、主索引鍵以及分區索引鍵。
  • 建立新表格。
  • 刪除現有表格。
  • 建立索引。
  • 刪除索引。
  • 新增資料欄。
  • 刪除資料欄。
  • 在表格中插入資料。
  • 執行 SELECT SQL 查詢。

探索表格、資料欄、索引及金鑰

展開作用中連線時,Oracle NoSQL Database VS Code 會顯示該部署中的表格。
  • 按一下表格名稱即可檢視其資料欄、索引、主索引鍵以及分區索引鍵。此時會顯示資料欄名稱及其資料類型。
  • 您可以隨時重新整理綱要或表格,以重新查詢您的部署,並將最新資料填入 Oracle NoSQL Database Cloud Service
    • TABLE EXPLORER 中尋找連線,然後按一下「重新整理」圖示以重新載入綱要。或者,您可以在連線上按一下滑鼠右鍵,然後選取重新整理綱要


      Oracle NoSQL DB VS 程式碼擴充重新整理綱要

    • TABLE EXPLORER 中,找出表格名稱,然後按一下「重新整理」圖示以重新載入表格。或者,您可以在表格名稱上按一下滑鼠右鍵,然後選取重新整理表格


      Oracle NoSQL DB VS 程式碼重新整理表格

使用 Visual Studio 程式碼執行 DDL 作業

您可以使用 Visual Studio 程式碼執行 DDL 作業。

可從 Visual Studio Code Plugin 內部執行的部分 DDL 作業包括:

CREATE TABLE

您可以使用兩種模式建立 Oracle NoSQL Database 表格:
  • 簡單 DDL 輸入:您可以使用此模式以宣告方式建立 Oracle NoSQL Database 表格,也就是不撰寫 DDL 敘述句。
  • 進階 DDL 輸入:您可以使用此模式,使用 DDL 敘述句建立 Oracle NoSQL Database 表格。
  1. 將游標暫留在 Oracle NoSQL Database 連線上即可新增表格。
  2. 按一下顯示的「加號」圖示。
  3. 建立表格頁面中,選取簡單 DDL 輸入


    使用簡單 DDL 輸入模式建立 Oracle NoSQL Database 表格

    表格 - 建立 Oracle NoSQL Database 表格

    欄位 描述
    表格名稱: 指定唯一的表格名稱。
    資料欄名稱 指定表格中主索引鍵的資料欄名稱。
    資料欄類型 選取您主索引鍵資料欄的資料類型。
    設為分區索引鍵 選取此選項即可將此主索引鍵資料欄設為分區索引鍵。分區金鑰是在 Oracle NoSQL Database 叢集之間分配資料以提高效率,並將共用分區金鑰的記錄定位在本機,以方便參考和存取。共用分區金鑰的記錄會儲存在相同的實體位置,並能夠以異常且有效率的方式存取。
    移除 按一下此按鈕即可刪除現有的資料欄。
    + 新增主索引鍵資料欄 按一下此按鈕,即可在建立複合 (多資料欄) 主索引鍵時新增其他資料欄。
    資料欄名稱 指定資料欄名稱。
    資料欄類型 選取資料欄的資料類型。
    預設值 (選擇性) 指定資料欄的預設值。

    附註:

    無法指定二進位和 JSON 資料類型資料欄的預設值。
    非空值 選取此選項可指定資料欄必須一律具有值。
    移除 按一下此按鈕即可刪除現有的資料欄。
    + 新增資料欄 按一下此按鈕可新增更多的欄。
    Unit - 單位 選取表格中資料列 TTL 值要使用的單位 ( 天數時數 )。
    指定表格中資料列的到期持續時間。在天數或時數之後,列會自動到期,且不再可用。預設值為零,表示沒有到期時間。

    附註:

    將「表格時間更新為作用中 (TTL)」不會變更表格中任何現有資料的 TTL 值。新的 TTL 值會套用至修改此值之後新增至表格的資料列,以及未提供覆寫資料列特定值的資料列。
  4. 按一下顯示 DDL ,檢視根據在簡單 DDL 輸入模式之欄位中輸入的值所形成的 DDL 敘述句。此 DDL 敘述句會在您按一下建立時執行。
  5. 按一下建立

刪除表格

  1. 在目標表格上按一下滑鼠右鍵。
  2. 按一下刪除表格
  3. 按一下以刪除表格。

建立索引

  • 尋找「表格總管」,然後按一下「重新整理綱要」以重新載入綱要。
  • 在需要建立索引的表格上按一下滑鼠右鍵。選擇建立索引
  • 指定索引的名稱和要作為索引一部分的資料欄。
  • 按一下 新增索引

刪除索引

  • 尋找「表格總管」,然後按一下「重新整理綱要」以重新載入綱要。
  • 按一下需要移除索引的表格。索引清單會顯示在資料欄名稱下方。
  • 在要刪除的索引上按一下滑鼠右鍵。按一下刪除索引
  • 確認視窗隨即顯示,按一下確定以確認刪除動作。

新增資料欄

  • 尋找「表格總管」,然後按一下「重新整理綱要」以重新載入綱要。
  • 在需要新增資料欄的表格上按一下滑鼠右鍵。按一下新增資料欄
  • 指定資料欄的名稱,並使用其特性定義資料欄 - 資料類型、預設值以及資料欄是否為空值。
  • 按一下新增資料欄

刪除資料欄

  • 尋找「表格總管」,然後按一下「重新整理綱要」以重新載入綱要。
  • 展開需要移除資料欄的表格。
  • 在要移除的資料欄上按一下滑鼠右鍵,然後選擇刪除資料欄
  • 確認視窗隨即顯示,按一下確定以確認刪除動作。

使用 Visual Studio 程式碼執行 DML 作業

您可以從表格 usingVisual Studio Code Plugin 新增資料、修改現有資料及查詢資料。

插入資料

  • 尋找「表格總管」,然後按一下「重新整理綱要」以重新載入綱要。
  • 在需要插入資料列的表格上按一下滑鼠右鍵。選擇插入資料列
  • 在「插入列」面板中,輸入插入新列的詳細資料。您可以使用兩種模式插入新的 ROW:
    • 簡易輸入:您可以使用此模式插入新列,而不用寫入 DML 陳述式。在此載入表單型列欄位項目,您可在此輸入列中每個欄位的值。
    • 進階 JSON 輸入 :您可以使用此模式將新資料列插入表格,方法為提供包含資料欄名稱的 JSON 物件及其對應值作為索引鍵 - 值組。
  • 按一下插入資料列

修改資料 - UPDATE ROW/DELETE ROW:

  • 尋找「表格總管」,然後按一下「重新整理綱要」以重新載入綱要。
  • 按一下需要修改資料的表格。
  • 在 SQL> 右側的文字方塊中,輸入要從表格擷取資料的 SQL 敘述句。按一下 > 以執行查詢。
  • 若要個別檢視個別的儲存格資料,請按一下表格儲存格。
  • 如果要執行 DML 作業,例如「更新」和「刪除資料列」,請在特定資料列上按一下滑鼠右鍵。從顯示的右鍵選單中挑選選項。
    • 刪除資料列:會顯示確認視窗,按一下確定以刪除資料列。
    • 更新資料列:個別的 HTML 面板會在列出的資料列下方開啟,其中包含以表單為基礎之項目中的資料欄名稱及其對應值,或提供輸入作為 ON 鍵組物件。您可以選擇兩種方法其中之一,然後提供新值。

      附註:

      在任何資料列中,無法更新 PRIMARY KEY 與 GENERATED ALWAYS AS IDENTITY 資料欄。

執行表格的 SQL 查詢

  • 尋找「表格總管」,然後按一下「重新整理綱要」以重新載入綱要。
  • 在表格上按一下滑鼠右鍵,然後選擇瀏覽表格
  • 在 SQL> 右側的文字方塊中,輸入 SELECT 敘述句以從您的表格擷取資料。
  • 按一下 > 以執行查詢。會從表格擷取對應的資料。
  • 在任何資料列上按一下滑鼠右鍵,然後按一下「下載資料列至 JSON 檔案」。單一資料列會下載至 JSON 檔案。
  • 按一下下載查詢結果,將 SELECT 敘述句的完整結果儲存為 JSON 檔案。
  • 按一下擷取所有記錄,從表格擷取所有資料。

移除連線

Oracle NoSQL Database Connector 提供兩種方法來移除 Visual Studio (VS) 程式碼的連線。

您可以:
  • 移除「命令選用區」的連線,或者
  • 從活動列的 Oracle NoSQL DB 檢視移除連線。

附註:

若移除 Visual Studio 程式碼的連線,會將持續的連線詳細資訊自目前的工作區刪除。
  1. 展開左側導覽中的 TABLE EXPLORER 窗格 (如果隱藏)。
  2. 在您要移除的連線按一下滑鼠右鍵,然後按一下移除連線


Table Explorer

  1. 命令選用區
    • (Windows 和 Linux) 控制 + Shift + P
    • (macOS) 命令 + Shift + P
  2. 從「命令選用區」中選取 OracleNoSQL:移除連線

    秘訣:

    在「命令選用區」中輸入 oraclenosql ,即可顯示所有您可以使用的 Oracle NoSQL DB 命令。


    移除連線