使用 IntelliJ Plugin 進行開發

Oracle NoSQL Database Cloud Service 執行處理或 IntelliJ 的模擬器上瀏覽表格並執行查詢。

Oracle NoSQL Database Cloud Service IntelliJ Plugin 可連線至執行中的 Oracle NoSQL Database Cloud Service 執行處理或模擬器,並可讓您:
  • 使用「表格總管」以定義完善的樹狀目錄結構檢視表格。
  • 檢視表格的資料欄、索引、主索引鍵以及分區索引鍵資訊。
  • 以正確格式的 JSON 結構檢視資料欄資料。
  • 使用表單式綱要項目或提供 DDL 敘述句來建立表格。
  • 刪除表格。
  • 使用表單式項目或提供 DDL 敘述句來新增資料欄。
  • 刪除資料欄。
  • 建立索引。
  • 刪除索引。
  • 對表格執行 SELECT SQL 查詢,並以列表化格式檢視查詢結果。
  • 執行 DML 敘述句以更新、插入以及刪除表格的資料。

本文包含下列主題:

設定 IntelliJ Plug-in

瞭解如何設定 Oracle NoSQL Database Cloud Service 執行處理或模擬器的 IntelliJ Plug-in。

請執行以下步驟:
  1. 下載並啟動 Oracle NoSQL Database Cloud Simulator 。請參閱下載 Oracle NoSQL Database Cloud Simulator
  2. 下載並擷取 Oracle NoSQL Database Java SDK 。請參閱關於 Oracle NoSQL Database SDK 驅動程式
  3. 安裝 IntelliJ 外掛程式,然後重新啟動 IDE。
    有兩個安裝外掛程式的選項 :

    秘訣:

    請勿擷取下載的外掛程式壓縮檔。從磁碟安裝時,請選取 zip 格式的外掛程式。
順利設定 IntelliJ Plugin 之後,請建立 NoSQL 專案,並將其連線至您的 Oracle NoSQL Database Cloud Service 執行處理或模擬器。

在 IntelliJ 中建立 NoSQL 專案

瞭解如何在 IntelliJ 中建立 NoSQL 專案。

請執行以下步驟:
  1. 開啟 IntelliJ IDEA。按一下檔案 > 新增 > 專案
  2. 輸入專案名稱專案位置的值,然後按一下建立
  3. 建立 NoSQL 專案之後,您可以從「專案總管」視窗瀏覽範例 java 檔案。
  4. 確定您的 Oracle NoSQL 專案已啟用「通知」。若要啟用「通知」,請按 Alt+\ 以開啟主功能表。按一下檢視,展開工具視窗 > 通知。通知圖示 通知鈴 - 圖示 會顯示在右側工具視窗列中。
在 IntelliJ 中順利建立 NoSQL 專案之後,請將專案連線至您的 Oracle NoSQL Database Cloud Service 或模擬器。

從 IntelliJ 連線至 Oracle NoSQL Database Cloud Service

瞭解如何使用 IntelliJ Plugin 將 NoSQL 專案連線至 Oracle NoSQL Database Cloud Service

請執行以下步驟:
  1. 在 IntelliJ 中開啟 NoSQL 專案。
  2. 按一下綱要總管視窗中的工作圖示 任務圖示,即可開啟 Plugin 的設定值對話方塊。
  3. 展開「設定值總管」中的工具 > Oracle NoSQL ,然後按一下連線
  4. 從「設定檔」類型的下拉式功能表選取雲端。您可以在連線下拉式清單中檢視雲端設定檔類型的所有現有連線。
  5. 按一下新增連線。您有兩個建立連線的選項。使用組態檔:您可以指定儲存在本機系統中的組態檔位置。此組態檔包含各種連線參數,例如租用戶 ID、使用者 ID、指紋、密碼詞組以及私密金鑰。b. 進階:您可以直接指定各種連線參數的值 (如下所示)。輸入下列連線參數的值,然後按一下確定

    表格 - 連線參數

    Parameter - 參數 描述 範例值
    連線名稱 必須從 Plugin 版本 1.5.1 取得特定連線規格的唯一名稱。從 1.4.0 版或更舊版本升級 Plugin 之後,建議更新「連線名稱」欄位。

    附註:

    您可以新增多個連線,而且儲存的連線設定是永久的。
    ndcs_con1
    端點 Oracle NoSQL Database Cloud Service 的區域網路存取點。 https://nosql.us-ashburn-1.oci.oraclecloud.com (適用於北美地區的阿什本 Oracle NoSQL Database Cloud Service 區域識別碼)。如需服務端點清單,請參閱資料區域和關聯的服務端點
    SDK 路徑 解壓縮 Oracle NoSQL Database Java SDK 之目錄的完整路徑。 D:\oracle-nosql-java-sdk-5.4.14\oracle-nosql-java-sdk
    組態檔案 配置檔儲存在本機系統中的目錄路徑。 ~/.oci/config
    設定檔 設定檔的名稱。

    附註:

    您可以為這些項目建立多個具有不同值的設定檔,然後指定要載入哪一個設定檔。
    DEFAULT
    用戶 ID 和使用者 ID Oracle NoSQL Database Cloud Service 的租用戶 OCID 和使用者的 OCID。 請參閱 Oracle Cloud Infrastructure 文件中的 Where to get the Tenancy's OCID and User's OCID
    指紋和密碼詞組 (選擇性) 產生並上傳 API 簽署金鑰時所建立簽署金鑰的指紋和密碼詞組。
    請參閱 Oracle Cloud Infrastructure 文件中的下列資源:
    私密金鑰 為使用者產生的私密金鑰。 對於應用程式使用者,必須產生並上傳 API 簽署金鑰。請參閱 How to Generate an API Signing Key ,以使用選擇性密碼詞組來產生簽署金鑰。
    區間 (選擇性) 您 NoSQL 資料庫綱要的區間 OCID/ 區間名稱。

    附註:

    當您指定區間名稱時,必須指定整個階層,其中包含分隔每個項目的冒號。
    developers:dev1.

    此處的 dev1developers. 區間下的區間

    附註:

    若未指定值,預設為根區間。

    附註:

    如果您從 1.4.0 或更新版本更新 Plugin,所有儲存的連線都會移轉至新版本。在此情況下,「連線名稱」將會與「端點」相同。請依照下面的步驟變更「連線名稱」。
  6. IntelliJ Plugin 會將連線詳細資訊儲存在指定的連線名稱中。若要修改連線詳細資訊,請在連線下拉式清單中選擇連線名稱。按一下修改連線。您可以變更任何連線參數 (如上所述),然後按一下確定來儲存設定值。若要從 Plugin 移除連線名稱,請選擇連線名稱,然後按一下刪除連線。確認要刪除的動作後,便會從 Plugin 移除連線名稱。
  7. 按一下「綱要總管」中的 Web 圖示。現有的連線清單會顯示在下拉式方塊中。連線名稱將以下列格式顯示在 NoSQL 工具視窗中:Connection Name:Endpoint:Compartment Name/OCID (如果不是 root)。選擇連線並按一下確定。IntelliJ Plugin 可將您的專案連線至 Oracle NoSQL Database Cloud Service,並在「綱要總管」視窗中顯示其綱要。
順利將專案連線至 Oracle NoSQL Database Cloud Service 之後,您就可以管理綱要中的表格和資料。

從 IntelliJ 連線至 Oracle NoSQL Database Cloud Simulator

瞭解如何使用 IntelliJ Plugin 將 NoSQL 專案連線至 Oracle NoSQL Database Cloud Simulator

請執行以下步驟:
  1. 在 IntelliJ 中開啟 NoSQL 專案。
  2. 按一下綱要總管視窗中的工作圖示 任務圖示,即可開啟 Plugin 的設定值對話方塊。
  3. 在「設定值總管」中展開工具 > Oracle NoSQL ,然後按一下連線。您可以在連線下拉式清單中檢視 Cloudsim 設定檔類型的所有現有連線。
  4. 從「設定檔」類型的下拉式功能表選取 Cloudsim
  5. 按一下新增連線。輸入下列連線參數的值,然後按一下確定

    表格 - 連線參數

    Parameter - 參數 描述 範例值
    連線名稱 必須從 Plugin 版本 1.5.1 取得特定連線規格的唯一名稱。從 1.4.0 版或更舊版本升級 Plugin 之後,建議更新「連線名稱」欄位。

    附註:

    您可以新增多個連線,而且儲存的連線設定是永久的。
    nosql_sim1
    服務 URL 執行 Oracle NoSQL Database Cloud Simulator 的 IP 位址和連接埠。 預設值為 http://localhost:8080
    租用戶 ID 識別租用戶的唯一 ID。 預設值為 exampleId。如果您要測試範例,請保留此值。
    SDK 路徑 解壓縮 Oracle NoSQL Database Java SDK 之目錄的完整路徑。 D:\oracle-nosql-java-sdk-5.4.14\oracle-nosql-java-sdk

    附註:

    如果您從 1.4.0 或更新版本更新 Plugin,所有儲存的連線都會移轉至新版本。在此情況下,「連線名稱」將會與「端點」相同。請依照下面的步驟變更「連線名稱」。
  6. IntelliJ Plugin 會將連線詳細資訊儲存在指定的連線名稱中。若要修改連線詳細資訊,請在連線下拉式清單中選擇連線名稱。按一下修改連線。您可以變更任何連線參數 (如上所述),然後按一下確定來儲存設定值。若要從 Plugin 移除連線名稱,請選擇連線名稱,然後按一下刪除連線。確認要刪除的動作後,便會從 Plugin 移除連線名稱。
  7. 按一下「綱要總管」中的 Web 圖示。現有的連線清單會顯示在下拉式方塊中。選擇連線並按一下確定。IntelliJ Plugin 可將您的專案連線至 Oracle NoSQL Database Cloud Service,並在「綱要總管」視窗中顯示其綱要。

    附註:

    將專案連線至 Oracle NoSQL Database Cloud Simulator 之前,必須先啟動並在執行中。否則,您的連線要求將在 IntelliJ 中失敗。
順利將專案連線至 Oracle NoSQL Database Cloud Simulator 之後,您就可以管理綱要中的表格和資料。

使用 IntelliJ 外掛程式管理表格

瞭解如何在 Oracle NoSQL Database Cloud ServiceOracle NoSQL Database Cloud Simulator 中建立表格及檢視 IntelliJ 中的表格資料。

連線至 Oracle NoSQL Database Cloud SimulatorOracle NoSQL Database Cloud Service 之後,您可以執行使用 Oracle NoSQL Database Java SDK 下載的範例來建立範例表格。透過 IntelliJ Plugin 的說明,您可以在「綱要總管」視窗中檢視表格及其資料。
執行範例程式:
  1. 開啟連線至您 Oracle NoSQL Database Cloud Service 或模擬器的 NoSQL 專案。
  2. 在「專案瀏覽器」視窗中尋找並按一下 BasicTableExample。您可以在 oracle-nosql-java-sdk 下的範例資料夾中找到此資訊。透過查看程式碼,您可以注意到此程式建立一個名為 audienceData 的表格、將兩個資料列放入此表格、查詢插入的資料列、刪除插入的資料列,最後再刪除 audienceData 表格。
  3. 若要傳送必要的引數,請按一下執行 (Run) > 編輯組態 (Edit Configurations) 。視連線類型而定,輸入下列程式引數,然後按一下確定

    表格 - 程式引數

    連線類型 程式引數 其他資訊
    Cloudsim http://localhost:8080 如果您在不同的連接埠上啟動 Oracle NoSQL Database Cloud Simulator ,則必須將 8080 取代為該連接埠號碼。
    雲端 us-ashburn-1 -configFile D:\OCI_PROP\config 第一個引數指示您 Oracle NoSQL Database Cloud Service 的資料區域。第二個引數傳送的組態檔包含連線至 Oracle NoSQL Database Cloud Service 的證明資料。
  4. 若要執行此程式,請按一下執行 > 執行 'BasicExampleTable' 或按 Shift + 10
  5. 驗證終端機中的日誌,以確認程式碼執行成功。您可以看到顯示訊息,指出建立表格、插入資料列等等。

    秘訣:

    由於 BasicExampleTable 會刪除插入的資料列並刪除 audienceData 表格,因此您無法在「綱要總管」中檢視此表格。如果您要在「綱要總管」中查看表格,請將刪除插入之資料列並刪除表格的程式碼加上註解,然後重新執行程式。
  6. 檢視表格及其資料:
    1. 尋找「綱要總管」,然後按一下 Refresh icon 圖示以重新載入綱要。
    2. 在您的租用戶 ID 底下尋找 audienceData 表格,然後展開以檢視其資料欄、主索引鍵以及分區索引鍵詳細資訊。
    3. 按兩下表格名稱以檢視其資料。或者,您可以在表格上按一下滑鼠右鍵,然後選取瀏覽表格
    4. 記錄檢視器視窗會顯示在主要編輯器中。按一下執行以執行查詢並顯示表格資料。
    5. 若要個別檢視儲存格資料,請按兩下儲存格。

使用 IntelliJ 執行 DDL 作業

您可以使用 IntelliJ 來執行 DDL 作業。

CREATE TABLE

  • 尋找「綱要總管」,然後按一下重新整理圖示以重新載入綱要。
  • 在連線名稱上按一下滑鼠右鍵,然後選擇建立表格
  • 在提示中,輸入新表格的詳細資料。您可以使用兩種模式建立 Oracle NoSQL Database 表格:
    • ** 簡單 DDL 輸入 ** :您可以使用此模式以宣告方式建立表格,也就是不撰寫 DDL 敘述句。
    • ** 進階 DDL 輸入 ** :您可以使用此模式來使用 DDL 敘述句建立表格。
  • 您可以選擇在建立 DDL 敘述句之前先檢視該敘述句。按一下顯示 DDL 可根據在「簡單 DDL 輸入模式」的欄位中輸入的值,檢視 DDL 敘述句。當您按一下「建立 (Create)」時,就會執行這個 DDL 敘述句。
  • 按一下建立以建立表格。
  • 若要建立子項表格,請在想要的表格上按一下滑鼠右鍵,然後選擇建立子項表格。您可以使用兩種模式建立子項表格:
    • ** 簡單 DDL 輸入 ** :只要輸入表格名稱以及其他必要的詳細資訊,即可使用此模式建立子項表格。
    • ** 進階 DDL 輸入 ** :您可以使用此模式,使用 DDL 敘述句建立子項表格。

    如需子項表格的詳細資訊,請參閱 Oracle NoSQL Database Cloud Service Guide 中的表格階層

  • 按一下建立可建立子項表格。
  • 您可以選擇在建立表格之後檢視 DDL 敘述句。在現有表格上按一下滑鼠右鍵。選擇檢視表格 DDL 。若要複製 DDL 敘述句,請按一下複製到剪貼簿。若要關閉對話方塊,請按一下確定

刪除表格

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

建立索引

  • 尋找「綱要總管」,然後按一下「重新整理」圖示以重新載入綱要。
  • 在需要建立索引的表格上按一下滑鼠右鍵。選擇建立索引
  • 在「建立索引」面板中,您可以選擇以兩種模式建立索引:
    • ** 以表單為基礎的索引建立 (簡單 DDL 輸入) ** :輸入建立索引的詳細資訊,不寫入任何 DDL 敘述句。指定索引的名稱和要作為索引一部分的資料欄。如果資料欄是 JSON 資料類型,就會顯示一個名為 "JSON Path to Index Field" 的額外欄位。輸入 JSON 欄位位置的路徑,然後選擇資料類型。
    • ** 以 DDL 敘述句建立索引 (針對進階 DDL 輸入) ** :輸入有效的 DDL 敘述句以建立索引。它也可以包含複雜的資料類型,例如陣列、對應和記錄。
  • 按一下 新增索引

刪除索引

  • 尋找「綱要總管」,然後按一下「重新整理」圖示以重新載入綱要。
  • 按一下目標表格即可查看列出的資料欄、主索引鍵、索引以及分區索引鍵。
  • 找出必須刪除的目標索引,然後按一下滑鼠右鍵。按一下刪除索引
  • 確認視窗隨即顯示,按一下確定以確認刪除動作。

新增資料欄

  • 尋找「綱要總管」,然後按一下「重新整理」圖示以重新載入綱要。
  • 在需要新增資料欄的表格上按一下滑鼠右鍵。選擇新增資料欄
  • 您可以使用兩種模式新增 COLUMN:
    • 簡單 DDL 輸入 :您可以使用此模式新增資料欄,而不寫入 DDL 敘述句。如果是二進位或固定二進位,請選取 Binary 資料類型。若為固定二進位,請在 Size 欄位中輸入檔案大小,並在二進位資料類型時將欄位保持為空值。
    • 進階 DDL 輸入:您可以使用此模式提供有效的 DDL 敘述句,將資料欄新增至表格。此模式也可以建立複雜資料類型的資料欄。例如,陣列、對應或記錄,以及巢狀格式。
  • 在這兩種模式中,指定資料欄的名稱,並使用其特性定義資料欄 - 資料類型、預設值以及是否為空值。
  • 按一下新增資料欄

刪除資料欄

  • 尋找「綱要總管」,然後按一下「重新整理」圖示以重新載入綱要。
  • 按一下目標表格即可查看列出的資料欄、主索引鍵、索引以及分區索引鍵。
  • 找出必須刪除的目標資料欄,然後按一下滑鼠右鍵。按一下刪除資料欄
  • 確認視窗隨即顯示,按一下確定以確認刪除動作。

凍結 /UnFreeze 綱要

您必須先凍結單一表格的綱要,才能將其設為「全域作用中」表格。凍結表格的綱要之後,就無法對綱要進行任何變更。若要凍結單一表格的綱要,至少必須要有一個 JSON 資料欄。在表格上按一下滑鼠右鍵,然後選擇凍結 / 取消凍結。確認之後,表格的綱要就會被凍結。同樣地,若要解除凍結表格的綱要,請在表格上按一下滑鼠右鍵,然後選擇凍結 / 取消凍結。確認之後,表格的綱要會變更回可變,這表示可以更改綱要。

附註:

必須先刪除表格區域複本 (表格必須是單一表格),才能執行解凍作業。

管理複本

請參閱區域表格複本,瞭解複本的用途,以及如何透過新增區域複本,將單一表格轉換成全域作用中表格。

新增複本

您可以將區域複本新增至單一表格,將它設為全域作用中表格,或將複本新增至現有的全域作用中表格。表格應先凍結,再將複本新增至該表格。在表格上按一下滑鼠右鍵,然後從區域複本中選擇新增複本。您可以從複製區域的下拉式清單中選擇複本。您可以決定複製區域中表格的「讀取單位」和「寫入單位」。無法在複本中變更 / 編輯表格的磁碟儲存值。按一下新增複本。在區域中複製表格。

檢視複本

在表格上按一下滑鼠右鍵,然後從區域複本中選擇檢視複本。您可以檢視表格的複本清單。

刪除複本

在表格上按一下滑鼠右鍵,然後從區域複本選擇刪除複本。按一下新增,然後選擇要移除的複本。您可以選擇一次多個要刪除的複本。若要從必須刪除的複本清單中移除複本,請按一下移除。按一下刪除複本。確認之後,就會將表格從所有選取的複本刪除。

編輯保留的容量

您可以編輯表格的保留容量和使用狀況模型。在表格上按一下滑鼠右鍵,然後選擇編輯保留的容量。您可以選擇兩種容量模式之一 - 佈建的容量或隨選容量。編輯值,然後按一下套用變更

如果編輯的表格是「全域作用中」表格:
  • 儲存容量變更具有全域範圍 (一個區域表格複本中的變更會自動傳輸至所有區域表格複本)。
  • 將讀取單位、寫入單位或容量模式中的變更從隨選變更為已佈建,反之亦然,具有本機範圍 (僅在起始它的區域表格複本中變更)。

使用 IntelliJ 執行 DML 作業

您可以使用 IntelliJ Plugin 從表格新增資料、修改現有資料和查詢資料。

插入資料

  • 尋找「綱要總管」,然後按一下「重新整理」圖示以重新載入綱要。
  • 在需要插入資料列的表格上按一下滑鼠右鍵。選擇插入資料列
  • 在「插入列」面板中,輸入插入新列的詳細資料。您可以使用兩種模式插入新的 ROW:
    • 簡易輸入:您可以使用此模式插入新列,而不用寫入 DML 陳述式。在此載入表單型列欄位項目,您可在此輸入列中每個欄位的值。
      • 對於二進位資料類型,輸入的字串必須是二進位值的有效 Base64 編碼,或在想要的資料欄中選取要上傳的檔案。
      • 對於固定二進位資料類型,輸入的字串必須是二進位值的有效 Base64 編碼,或上傳建立特定資料欄時定義的大小檔案。

      附註:

      您為二進位資料類型上傳的檔案格式只能有 .bin 副檔名。
    • 進階 JSON 輸入 :您可以使用此模式將新資料列插入表格,方法為提供包含資料欄名稱的 JSON 物件及其對應值作為索引鍵 - 值組。輸入也可以是複雜的資料類型,例如陣列、對應、記錄。
  • 按一下插入資料列

修改資料 - UPDATE ROW/DELETE ROW

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

      附註:

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

查詢表格

  • 尋找「綱要總管」,然後按一下「重新整理」圖示以重新載入綱要。
  • 在表格上按一下滑鼠右鍵,然後選擇瀏覽表格
  • 在左側的文字方塊中,輸入 SELECT 敘述句以從表格擷取資料。
  • 按一下執行以執行查詢。會從表格擷取對應的資料。
  • 在任何資料列上按一下滑鼠右鍵,然後按一下下載 JSON 。在對話方塊中,瀏覽至您要儲存檔案的位置,然後按一下儲存。下載檔案後,畫面右下角會出現通知。按一下連結以開啟下載的檔案。檔案會在瀏覽器中開啟。
    • 如果是「二進位」資料類型,只要按一下輸出中的下載二進位物件即可。
  • 按一下下載查詢結果,即可下載查詢結果中的所有資料。在對話方塊中,瀏覽至您要儲存檔案的位置,然後按一下儲存。如果有多個資料列,則進度列會顯示在畫面右下方,以顯示即時下載的資料列數目。下載檔案後,畫面右下角會出現通知。按一下連結以開啟下載的檔案。檔案會在瀏覽器中開啟。
  • 按一下顯示查詢計劃,即可檢視查詢的執行計劃。
  • 按一下上一個命令下拉式清單,檢視提供輸出的前 20 個最近執行的 SQL 敘述句。

    附註:

    此下拉式清單只會顯示與您正在處理之表格相關的 SQL 敘述句。

綱要總管

  • 在「綱要總管」視窗中,您可以驗證特定資料欄的完整資料類型。尋找特定的資料欄,資料類型後面接著資料欄名稱。