Oracle NoSQL Database Visual Studio Code拡張機能について

Oracle NoSQL Database Visual Studio Code Extensionのインストール

Oracle NoSQL Database VS Code拡張は、2つの方法でインストールできます。Visual Studio Marketplaceからオンライン・インストール用にインストールするか、オフライン・インストール用に*.vsixファイルを使用してVSIXパッケージからインストールします。

Oracle NoSQL Database Visual Studio (VS)コード拡張をインストールする前に、Visual Studio Codeをインストールする必要があります。Visual Studio Codeはここからダウンロードできます。

Visual Studio Marketplaceからインストール
VSIXからインストールする

Visual Studio Codeで、左側のナビゲーションの「拡張」アイコンをクリックします。
または、次を押して「拡張」ビューを開くこともできます:
- (WindowsおよびLinux) Control + Shift + X
- (macOS)コマンド+ Shift + X。
拡張マーケットプレイスでOracle NoSQL Database Connectorを検索します。
Oracle NoSQL Database Connector拡張機能の「インストール」をクリックします

Oracle NoSQL DatabaseのVSIXファイルをOracle NoSQL Databaseダウンロード・サイトからダウンロードします。
Visual Studio Codeで、左側のナビゲーションの「拡張」アイコンをクリックします。
または、次を押して「拡張」ビューを開くこともできます:
- (WindowsおよびLinux) Control + Shift + X
- (macOS)コマンド+ Shift + X。
「拡張」ビューで、「その他のアクション(...)」メニューをクリックし、「VSIXからインストール...」をクリックします。
*.vsixファイルが格納されている場所を参照して、「インストール」をクリックします。

Visual Studio CodeからのOracle NoSQL Database Cloud Serviceへの接続

Oracle NoSQL Database Visual Studio (VS)コード拡張では、Oracle NoSQL Database Cloud ServiceまたはOracle NoSQL Database Cloud Simulatorに接続するための2つの方法が提供されます。

構成ファイルに接続情報を指定するか、特定のフィールドの接続情報を入力できます。Node.jsドライバを使用しており、ファイルに接続の詳細がすでに保存されている場合は、「構成ファイルを介した接続」オプションを使用してOracle NoSQL Database Cloud Serviceに接続します。新しい接続を作成する場合は、「個別のフィールドに入力」オプションを使用します。

個々のフィールドに入力
構成ファイル経由で接続

Visual Studio Codeで、「アクティビティ・バー」の「Oracle NoSQL DB」ビューをクリックします。
コマンド・パレットまたは「アクティビティ・バー」のOracle NoSQL DBビューからOracle NoSQL DBの「接続設定の表示」ページを開きます。
- コマンド・パレットから開く
  1. 次を押してコマンド・パレットを開きます:
    - (WindowsおよびLinux) Control + Shift + P
    - (macOS)コマンド+ Shift + P
  2. コマンド・パレットから、OracleNoSQL:接続設定の表示を選択します。
    
    ヒント:
    コマンド・パレットにoraclenosqlと入力して、使用可能なすべてのOracle NoSQL DBコマンドを表示します。
- Oracle NoSQL DBビューからオープン
  1. 左側のナビゲーションの「TABLE EXPLORER」ペインが縮小されている場合は、ペインを展開します。
  2. 「接続の追加」をクリックして、Oracle NoSQL DBの「接続設定の表示」ページを開きます。
「接続設定の表示」ページで、「クラウド」またはCloudSimをクリックしてOracle NoSQL Database Cloud ServiceまたはOracle NoSQL Database Cloud Simulatorに接続します。

接続の情報を入力します。

表5-4クラウド接続パラメータ

フィールド	説明	サンプル値
リージョン:	Oracle NoSQL Database Cloud Serviceエンドポイントのリージョン識別子を選択します。	`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)でコンパートメントを作成します。「テナンシの設定」および「コンパートメントの管理」 in Oracle Cloud Infrastructureドキュメントを参照してください。	コンパートメント名 `私のコンパートメント` 親コンパートメントで修飾されたコンパートメント名 `parent.childcompartment` コンパートメントOCID `ocid1.tenancy.oc1...<unique_ID>`
テナントOCID:	Oracle NoSQL Database Cloud ServiceのテナンシのOCID。Oracle Cloud InfrastructureドキュメンテーションのテナンシのOCIDおよびユーザーのOCIDの取得場所を参照してください	`ocid1.tenancy.oc1..<unique_ID>`
ユーザーOCID:	Oracle NoSQL Database Cloud ServiceのユーザーのOCID。Oracle Cloud InfrastructureドキュメンテーションのテナンシのOCIDおよびユーザーのOCIDの取得場所を参照してください。	`ocid1.user.oc1..<unique_ID>`
指紋:	このユーザーに追加された秘密キーのフィンガープリント。署名キーのフィンガープリントは、API署名キーの生成およびアップロード中に作成されます。How to Get the Key's Fingerprint in Oracle Cloud Infrastructure Documentationを参照してください。	`12:34:56:78:90:ab:cd:ef:12:34:56:78:90:ab:cd:ef`
秘密キー・ファイル:	秘密キーが格納されている場所を参照します。オプションのパスフレーズを使用して署名キーを生成するには、API署名キーの生成方法を参照してください。	`/home/user/.oci/oci_api_key.pem`
パスフレーズ:	秘密キーの作成時に指定したパスフレーズ。署名キーのパス・フレーズは、API署名キーの生成およびアップロード中に作成されます。How to Get the Key's Fingerprint in Oracle Cloud Infrastructure Documentationを参照してください。必須(鍵が暗号化されている場合のみ)。
コンパートメント:	Oracle NoSQL Database Cloud Serviceスキーマのコンパートメントの名前またはOCID。値を指定しない場合、フィールドはデフォルトで`root`コンパートメントに設定されます。 Oracle Cloud Infrastructure Identity and Access Management (IAM)でコンパートメントを作成します。「テナンシの設定」および「コンパートメントの管理」 in Oracle Cloud Infrastructureドキュメントを参照してください。	コンパートメント名 `私のコンパートメント` 親コンパートメントで修飾されたコンパートメント名 `parent.childcompartment` コンパートメントOCID `ocid1.tenancy.oc1...<unique_ID>`

表5-5 CloudSim接続パラメータ

フィールド	説明	サンプル値
エンドポイント:	Oracle NoSQL Database Cloud Simulatorインスタンスのサービス・エンドポイントURL。	`http://myinstance.cloudsim.com:8080` 値を指定しない場合、デフォルトで`http://localhost:8080`に設定されます。
テナント識別子:	テナントを識別する一意の識別子。	`Tenant01` 値を指定しない場合、デフォルトで`TestTenant`になります。

「接続」をクリックします。
「リセット」をクリックして、保存した接続の詳細をワークスペースからクリアします。

構成ファイル(config.json、JSONオブジェクトを含むファイルなど)を作成します。Oracle NoSQL Database Cloud ServiceまたはOracle NoSQL Database Cloud Simulatorに接続するための構成ファイル形式を次に示します。

表5-6構成テンプレート

Oracle NoSQL Database Cloud Service Oracle NoSQL Database Cloud Simulator

Oracle NoSQL Database Cloud Service	Oracle NoSQL Database Cloud Simulator
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>" }`

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>"
}

次を押してコマンド・パレットを開きます。
- (WindowsおよびLinux) Control + Shift + X
- (macOS)コマンド+ Shift + X
コマンド・パレットから、「Oracle NoSQL:構成ファイル経由で接続」を選択します。

ヒント:
コマンド・パレットにoraclenosqlと入力して、使用可能なすべてのOracle NoSQL DBコマンドを表示します。
*.configファイルが格納されている場所を参照し、「選択」をクリックします。

Visual Studio Code拡張機能を使用した表の管理

Oracle NoSQL Database Visual Studio (VS)コード拡張を使用してデプロイメントに接続したら、左側のナビゲーションにあるTABLE EXPLORERを使用して、次のことを行います:

表、列、索引、主キーおよびシャード・キーを確認します。
新しいテーブルを作成します。
既存の表を削除します。
表に対してSELECT SQL問合せおよびDML文を実行します。

アクティブな接続を展開すると、Oracle NoSQL Database VSコードにそのデプロイメントの表が表示されます。

表名をクリックして、列、索引、主キーおよびシャード・キーを表示します。列名がデータ型とともに表示されます。
スキーマまたは表をいつでもリフレッシュしてデプロイメントを再問合せし、Oracle NoSQL Database Cloud Serviceに最新データを移入できます。
- TABLE EXPLORERで、接続を探し、「Refresh」アイコンをクリックします。または、接続を右クリックして「スキーマのリフレッシュ」を選択することもできます。
- TABLE EXPLORERで、表名を見つけて「リフレッシュ」アイコンをクリックして表を再ロードします。または、表名を右クリックして「表のリフレッシュ」を選択します。

表のSQL問合せおよびDML文の実行

ターゲット表を右クリックし、「表の参照」を選択します。
「SQL」ウィンドウで、テキスト・ボックスにSELECT問合せを指定して、クリックします

.問合せ結果が表形式で表示されます。1ページの行数を調整できます。DML文を実行して、表のデータを更新、挿入および削除することもできます。
個々のセル・データを表示するには、表のセルをクリックします。

表の削除

ターゲット表を右クリックします。
「表の削除」をクリックします。
「はい」をクリックし、表を削除します。

Visual StudioコードからのOracle NoSQL Database Cloud Service表の作成

Oracle NoSQL Database Cloud Service表は、次の2つのモードで作成できます:

シンプルなDDL入力:このモードを使用すると、Oracle NoSQL Database Cloud Service表を宣言的に、つまりDDL文を記述せずに作成できます。
拡張DDL入力:このモードを使用すると、DDL文を使用してOracle NoSQL Database Cloud Service表を作成できます。

簡易DDL入力
拡張DDL入力

Oracle NoSQL Database Cloud Service接続にカーソルを合せて新しい表を追加します。
表示される「Plus」アイコンをクリックします。

「表の作成」ページで、「単純なDDL入力」を選択します。

単純なDDL入力モードを使用したOracle NoSQL Database Cloud Service表の作成

表5-7 Oracle NoSQL Database Cloud Service表の作成

フィールド	説明
読取り容量(読取りユニット)	読取りユニット数を入力します。読取りユニットについて学習するには、容量の見積りを参照してください。
書込み容量(書込みユニット)	書込みユニット数を入力します。書込みユニットについて学習するには、容量の見積りを参照してください。
ディスク・ストレージ(GB)	表によって使用されるディスク領域をギガバイト(GB)で指定します。ストレージ容量について学習するには、容量の見積りを参照してください。
表名:	テナンシ内で一意となる表名を指定します。表名は、Oracle NoSQL Database Cloud Serviceの命名規則に準拠している必要があります。サービス制限を参照してください。
列名	表の主キーの列名を指定します。列のネーミング要件の詳細は、サービス制限を参照してください。
列タイプ	主キーのデータ型を選択します。
Shard Keyとして設定	この主キー列をシャード・キーとして設定するには、このオプションを選択します。シャード・キーは、効率を高めるためにOracle NoSQL Database Cloud Serviceクラスタ全体にデータを分散し、参照やアクセスが簡単になるようにシャード・キーをローカルで共有するレコードを配置することです。シャード・キーを共有するレコードは同じ物理的ロケーションに格納され、アトミックかつ効率的にアクセスできます。
削除	既存の列を削除するには、このボタンをクリックします。
+主キー列の追加	コンポジット(複数列)主キーの作成中に列を追加するには、このボタンをクリックします。
列名	列名を指定します。サービス制限で説明されている列の命名要件に準拠していることを確認します。
列タイプ	主キーのデータ型を選択します。
デフォルト値	(オプション)列のデフォルト値を指定します。ノートバイナリおよびJSONデータ型の列には、デフォルト値を指定できません。
nullでない	列が常に値を持つように指定するには、このオプションを選択します。
削除	既存の列を削除するには、このボタンをクリックします。
+列の追加	列を追加するには、このボタンをクリックします。
単位	表の行のTTL値に使用する単位(「日」または「時間」)を選択します。
値	表内の行の有効期限を指定します。日数または時間数の後、行は自動的に失効し、使用できなくなります。デフォルト値はゼロで、有効期限がないことを示します。ノート表Time to Live (TTL)を更新しても、表の既存のデータのTTL値は変更されません。新しいTTL値は、この値の変更後に表に追加された行と、行固有値の上書きが指定されていない行のみに適用されます。

「DDLの表示」をクリックして、「単純なDDL入力」モードのフィールドに入力した値に基づいて形成されたDDL文を表示します。このDDL文は、「作成」をクリックすると実行されます。
「作成」をクリックします。

Oracle NoSQL Database Cloud Service接続にカーソルを合せて新しい表を追加します。
表示される「Plus」アイコンをクリックします。

「表の作成」ページで、「拡張DDL入力」を選択します。

拡張DDL入力モードを使用したOracle NoSQL Database Cloud Service表の作成

表5-8 Oracle NoSQL Database Cloud Serviceの表の作成

フィールド	説明
読取り容量(読取りユニット)	読取りユニット数を入力します。読取りユニットについて学習するには、容量の見積りを参照してください。
書込み容量(書込みユニット)	書込みユニット数を入力します。書込みユニットについて学習するには、容量の見積りを参照してください。
ディスク・ストレージ(GB)	表によって使用されるディスク領域をギガバイト(GB)で指定します。ストレージ容量について学習するには、容量の見積りを参照してください。
DDL文	表の作成のDDL文を指定します。Oracle NoSQL DatabaseのSQLリファレンスを参照してください。

「作成」をクリックします。

接続の削除

Oracle NoSQL Database Connectorには、Visual Studio (VS)コードから接続を削除するための2つの方法があります。

可能なこと:

コマンド・パレットを使用した接続の削除
アクティビティ・バーのOracle NoSQL DBビューから接続を削除します。

ノート

Visual Studio Codeから接続を削除すると、永続化された接続の詳細が現在のワークスペースから削除されます。

Oracle NoSQL DBビューからの接続の削除
コマンド・パレットで接続を削除

左側のナビゲーションの「TABLE EXPLORER」ペインが縮小されている場合は、ペインを展開します。
削除する接続を右クリックし、「接続の削除」をクリックします。

表エクスプローラ

次を押してコマンド・パレットを開きます:
- (WindowsおよびLinux) Control + Shift + P
- (macOS)コマンド+ Shift + P
コマンド・パレットから、OracleNoSQL:接続の削除を選択します。

ヒント:
コマンド・パレットにoraclenosqlと入力して、使用可能なすべてのOracle NoSQL DBコマンドを表示します。

Oracle Cloud Infrastructureドキュメント

Oracle NoSQL Database Visual Studio Code Extensionのインストール

Visual Studio CodeからのOracle NoSQL Database Cloud Serviceへの接続

Visual Studio Code拡張機能を使用した表の管理

Visual StudioコードからのOracle NoSQL Database Cloud Service表の作成

接続の削除