開発のためのVisual Studio Code拡張機能の使用

Oracle NoSQL Database Cloud Serviceは、Microsoft Visual Studio Codeの拡張機能を提供しており、Oracle NoSQL Database Cloud Serviceの実行中のインスタンスに接続できます。

Oracle NoSQL Database Visual Studio (VS) Code拡張機能を使用して、次のことができます。

表エクスプローラを使用して、適切な定義のツリー構造で表を表示します。
表の列、索引、主キーおよびシャード・キーに関する情報を表示します。
列データを適切な形式のJSON構造で表示します。
フォームによるスキーマ入力を使用して表および子表を作成するか、DDL文を指定します。
表の削除
フォームベースのエントリを使用して新しい列を追加するか、DDL文を指定します。
列の削除
索引の作成
索引の削除
表に対してSELECT SQL問合せを実行し、問合せ結果を表形式で表示します。
DML文を実行して、表のデータを更新、挿入および削除します。
SELECT問合せを実行した後に、問合せ結果をJSONファイルにダウンロードします。
JSONファイルに、SELECT問合せの実行後に取得した結果の各行をダウンロードします。

この記事には次のトピックが含まれます:

Oracle NoSQL Database Visual Studio Code拡張機能のインストール

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

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

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

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

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

ビジュアル・スタジオ・コードからのOracle NoSQL Database Cloud Serviceへの接続

Oracle NoSQL Database Visual Studio (VS) Code拡張機能には、Oracle NoSQL Database Cloud ServiceまたはOracle NoSQL Database Cloud Simulatorへの接続方法が提供されています。

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

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

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

接続情報を入力します

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

フィールド	説明	サンプル値
リージョン:	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 IDおよびアクセス管理(IAM)で作成します。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>`
Fingerprint:	このユーザーに追加された秘密キーの指紋。署名キーの指紋は、API署名キーの生成およびアップロード中に作成されます。Oracle Cloud Infrastructureドキュメントのキーのフィンガープリントを取得する方法を参照してください。	`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署名キーの生成およびアップロード中に作成されます。Oracle Cloud Infrastructureドキュメントのキーのフィンガープリントを取得する方法を参照してください。必須。キーが暗号化されている場合のみ。
コンパートメント:	Oracle NoSQL Database Cloud Serviceスキーマのコンパートメントの名前またはOCID。値を指定しない場合は、デフォルトで`root`コンパートメントに設定されます。コンパートメントは、Oracle Cloud Infrastructure IDおよびアクセス管理(IAM)で作成します。Oracle Cloud Infrastructureドキュメントのテナントの設定およびコンパートメントの管理を参照してください。	コンパートメント名 `コンパートメント` 親コンパートメントで修飾されたコンパートメント名 `parent.childcompartment` コンパートメントのOCID `ocid1.tenancy.oc1...<unique_ID>`

表- CloudSim接続パラメータ

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

「接続」をクリックします。
保存された接続詳細をワークスペースからクリアするには、「Reset」をクリックします。

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

表- 構成テンプレート

Oracle NoSQL Database Cloud Service Oracle NoSQL Databaseクラウド・シミュレータ

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

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

次を押して「Command Palette」を開きます。
- (WindowsおよびLinux) Control + Shift + P
- (macOS) Command + Shift + P
「コマンド・パレット」から、「Oracle NoSQL: 接続方法」を選択します。

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

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

Oracle NoSQL Database Visual Studio (VS) Code拡張機能を使用してデプロイメントに接続したら、左側のナビゲーションにある「TABLE EXPLORER」を使用して次を実行します。

表、列、索引、主キーおよびシャード・キーを確認します。
新しい表を作成します
既存の表を削除します。
索引の作成
索引の削除
列を追加します。
列の削除
データを表に挿入
SELECT SQL問合せを実行します。

表、列、索引およびキーの確認

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

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

Visual Studio Codeを使用したDDL操作の実行

Visual Studio Codeを使用してDDL操作を実行できます。

ビジュアル・スタジオ・コード・プラグイン内から実行できるDDL操作の一部を次に示します。

CREATE TABLE
DROP TABLE
CREATE INDEX
DROP INDEX
列の追加
列の削除

CREATE TABLE

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

シンプルなDDL入力: このモードを使用すると、Oracle NoSQL Databaseテーブルを宣言的に、つまりDDLステートメントを記述せずに作成できます。
高度なDDL入力: Oracle NoSQL Database表を作成するには、このモードを使用します。

新しい表を追加するOracle NoSQL Database接続の上にポインタを置きます。
表示されるプラス・アイコンをクリックするか、データベース接続名を右クリックして「表の作成」をクリックします。

Create Tableページで、「Simple DDL Input」を選択します。

表- Oracle NoSQL Database表の作成

フィールド	説明
表名:	一意の表名を指定します。
列名	表の主キーの列名を指定します。
列のタイプ	主キー列のデータ型を選択します。
シャード・キーとして設定	シャード・キーとしてこの主キー列を設定するには、このオプションを選択します。シャード・キーは、効率を高めるためにOracle NoSQL Databaseクラスタ全体にデータを分散し、参照およびアクセスしやすくするためにシャード・キーをローカルで共有するレコードを配置することです。シャード・キーを共有するレコードは同じ物理的ロケーションに格納され、アトミックかつ効率的にアクセスできます。
削除	既存の列を削除するには、このボタンをクリックします。
+主キー列の追加	このボタンをクリックすると、コンポジット(複数列)主キーの作成中に列を追加できます。
列名	列名を指定します。
列のタイプ	列のデータ型を選択します。
デフォルト値	(オプション)列のデフォルト値を指定します。ノート: バイナリおよびJSONデータ型の列には、デフォルト値を指定できません。
Null以外	列が常に値を持つように指定するには、このオプションを選択します。
削除	既存の列を削除するには、このボタンをクリックします。
+列の追加	列を追加するには、このボタンをクリックします。
単位	「Days」または「Hours」を選択し、表の行のTTL値に使用します。
値	表の行の有効期間を指定します。日数または時間数が経過すると、行は自動的に期限切れになり、使用できなくなります。デフォルト値はゼロで、有効期限がないことを示します。ノート: 「Time to Live」(TTL)を更新しても、表の既存データのTTL値は変更されません。新しいTTL値は、この値の変更後に表に追加された行と、オーバーライドする行固有の値が指定されていない行にのみ適用されます。

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

子表を作成するには、目的の表を右クリックし、「子表の作成」を選択します。子表は、次の2つのモードで作成できます。
- 単純なDDL入力: このモードを使用すると、他の必要な詳細とともに表名を入力するだけで、子表を作成できます。
- 拡張DDL入力: このモードを使用すると、DDL文を使用して子表を作成できます。
子表の詳細は、Oracle NoSQL Database Cloud Serviceガイドの表階層を参照してください。
「作成」をクリックして、子表を作成します。
表の作成後にDDL文を表示するオプションがあります。既存の表を右クリックします。「表DDLの表示」を選択します。DDL文をコピーするには、「クリップボードにコピー」をクリックします。「OK」をクリックしてダイアログ・ボックスを閉じます。

DROP TABLE

ターゲット表を右クリックします。
「削除」をクリックします。
「Yes」をクリックして表を削除します。

CREATE INDEX

表エクスプローラを探し、「Refresh Schema」アイコンをクリックしてスキーマをリロードします。
索引を作成する表を右クリックします。「索引の作成」を選択します。
「索引の作成」パネルでは、2つのモードで索引を作成するオプションがあります。
- 単純入力: 索引の名前および索引に含める列を指定します。列タイプがJSONの場合、「索引フィールドへのJSONパス」という追加フィールドが表示されます。JSONフィールドの場所へのパスを入力し、そのデータ型を選択します。
- 拡張DDLの使用: 任意の列に索引を作成する有効なDDL文を入力します。複合データ型(配列、マップ、レコードなど)を含めることもできます。
「索引の追加」をクリックします。

DROP INDEX

表エクスプローラを探し、スキーマのリフレッシュをクリックしてスキーマをリロードします。
索引を削除する必要がある表をクリックします。索引のリストが列名の下に表示されます。
削除する索引を右クリックします。「索引の削除」をクリックします。
確認ウィンドウが表示され、「Ok」をクリックして削除アクションを確定します。

列の追加

表エクスプローラを探し、スキーマのリフレッシュをクリックしてスキーマをリロードします。
列を追加する必要がある表を右クリックします。「列の追加」をクリックします。
「列の追加」パネルには、2つのモードで列を追加するオプションがあります。
- 単純なDDL入力: 列の名前を指定し、そのプロパティ(データ型、デフォルト値およびNULL値可能かどうか)を使用して列を定義します。バイナリまたは固定バイナリの場合は、データ型としてBinaryを選択します。固定バイナリの場合は、Sizeフィールドにファイルのサイズを入力し、バイナリ・データ型の場合はフィールドをnullのままにします。
- 拡張DDL入力: このモードを使用すると、有効なDDL文を指定して表に新しい列を追加したり、複合データ型(配列、マップ、レコードなど)の列を作成したり、ネストされた形式でも作成できます。
「新しい列の追加」をクリックします。

列の削除

表エクスプローラを探し、スキーマのリフレッシュをクリックしてスキーマをリロードします。
列を削除する必要がある表を展開します。
削除する列を右クリックし、「削除」を選択します。
確認ウィンドウが表示され、「Ok」をクリックして削除アクションを確定します。

Visual Studio Codeを使用したDML操作の実行

表usingVisual Studio Codeプラグインから、データの追加、既存データの変更およびデータの問合せを実行できます。

データを挿入

表エクスプローラを探し、スキーマのリフレッシュをクリックしてスキーマをリロードします。
行を挿入する必要がある表を右クリックします。「行を挿入」を選択します。
「挿入行」パネルで、新しい行を挿入するための詳細を入力します。新しいROWを2つのモードで挿入できます。
- シンプルな入力: このモードを使用すると、DML文を記述せずに新しい行を挿入できます。ここでは、フォーム・ベースの行フィールドのエントリがロードされ、行のすべてのフィールドの値を入力できます。
  - バイナリ・データ型の場合、入力される文字列は、バイナリ値の有効なBase64エンコーディングであるか、目的の列にアップロードするファイルを選択する必要があります。
  - 固定バイナリ・データ型の場合、入力される文字列は、バイナリ値の有効なBase64エンコーディングであるか、列に指定されたサイズに従ってファイルをアップロードする必要があります。
  ノート:
  バイナリ・データ型用にアップロードするファイル形式には、.bin拡張子が必要です。
- 拡張JSON入力: このモードを使用すると、列名と対応する値をキーと値のペアとして格納するJSONオブジェクトを指定することで、新しい行を表に挿入できます。入力は、配列、マップ、レコードなどの複合データ型でもかまいません。
「行を挿入」をクリックします。

データの変更- UPDATE ROW/DELETE ROW:

表エクスプローラを探し、スキーマのリフレッシュをクリックしてスキーマをリロードします。
データの変更が必要な表をクリックします。
右側の「SQL>」の下のテキストボックスに、表からデータをフェッチするSQL文を入力します。問合せを実行するには、「>」をクリックします。
個々のセルのデータを個別に表示するには、表のセルをクリックします。
「更新行」や「削除行」などのDML操作を実行するには、特定の行を右クリックします。表示されたコンテキストメニューからオプションを選択します。
- 「Delete Row」: 確認ウィンドウが表示され、「Ok」をクリックして行を削除します。
- Update Row: リストされた行の下に別のHTMLパネルが開き、フォームベースのエントリに列名とその対応する値が含まれているか、入力をONキー・ペア・オブジェクトとして指定します。2つの方法のいずれかを選択し、新しい値を指定できます。
  
  ノート:
  任意の行で、PRIMARY KEY列およびGENERATED ALWAYS AS IDENTITY列を更新することはできません。

表に対するSQL問合せの実行

表エクスプローラを探し、スキーマのリフレッシュをクリックしてスキーマをリロードします。
表を右クリックし、「Browse Table」を選択します。
右側の「SQL>」の下のテキストボックスに、SELECT文を入力して表からデータをフェッチします。
問合せを実行するには、「>」をクリックします。対応するデータが表から取得されます。
任意の行を右クリックし、「Download JSON」をクリックします。単一行がJSONファイルにダウンロードされます。ダイアログ・ボックスで、ファイルを保存する場所にナビゲートして、「保存」をクリックします。
「Download Query Result」をクリックして、SELECT文の結果全体をJSONファイルとして保存します。ダイアログ・ボックスで、ファイルを保存する場所にナビゲートして、「保存」をクリックします。
「すべてのレコードのフェッチ」をクリックして、表からすべてのデータを取得します。
「Show Query Plan」をクリックして、問合せの実行プランを表示します。
「前のコマンド」ドロップダウンをクリックして、出力を提供した最近実行されたSQL文を表示します。

ノート:
ドロップダウンには、処理対象の表に関連するSQL文のみが表示されます。

表エクスプローラ

「表エクスプローラ」ウィンドウで、特定の列のデータ型を確認できます。特定の列を見つけ、データ型の後に列名が続きます。

接続を削除しています

Oracle NoSQL Database Connectorは、Visual Studio (VS) Codeから削除する2つの方法を提供します。

次が可能です:

コマンド・パレットを使用して接続を削除するか、または
[活動バー]の[Oracle NoSQL DB]ビューから接続を削除します。

ノート:

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

「Oracle NoSQL DB」ビューからの接続の削除
コマンド・パレットを使用した接続の削除

左側のナビゲーションにある「テーブル・エクスプローラ」ペインが折りたたまれている場合は、これを展開します。
削除する接続を右クリックし、「削除」をクリックします。

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

ヒント :
使用できるすべてのOracle NoSQL DBコマンドを表示するには、「コマンド・パレット」にoraclenosqlと入力します。

タイトルおよび著作権情報

開発のためのVisual Studio Code拡張機能の使用

Oracle and/or its affiliates.