使用 Visual Studio Code 扩展进行开发

Oracle NoSQL Database Cloud Service 为 Microsoft 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 Code 扩展

您可以通过两种方式安装 Oracle NoSQL Database VS Code 扩展。从 Visual Studio Marketplace 安装以进行联机安装，或者使用 *.vsix 文件从 VSIX 软件包安装以进行脱机安装。

必须先安装 Visual Studio Code，然后才能安装 Oracle NoSQL Database Visual Studio (VS) 代码扩展。您可以从此处下载 Visual Studio Code。

从 Visual Studio Marketplace 安装
从 VSIX 安装

在 Visual Studio Code 中，单击左侧导航中的扩展图标。
或者，可以通过按下以下命令打开扩展视图：
- （Windows 和 Linux）控件 + Shift + X
- (macOS) 命令 + Shift + X。
在扩展市场中搜索 Oracle NoSQL Database Connector 。
单击 Oracle NoSQL Database Connector 扩展上的“安装”

从 Oracle NoSQL Database Downloads 站点下载 Oracle NoSQL Database 的 VSIX 文件。
在 Visual Studio Code 中，单击左侧导航中的扩展图标。
或者，可以通过按下以下命令打开扩展视图：
- （Windows 和 Linux）控件 + 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 的方法。

您可以为配置文件提供连接信息，或在特定字段中填写连接信息。如果您使用的是 Node.js 驱动程序，并且已将连接详细信息保存在文件中，请使用“通过配置文件连接”选项连接到 Oracle NoSQL Database Cloud Service 。否则，如果要创建新连接，请使用“填写单个字段”选项。

填写单个字段
通过配置文件连接

在 Visual Studio Code 中，单击活动栏中的 Oracle NoSQL DB 视图。
从命令面板或活动栏中的 Oracle NoSQL DB 视图打开 Oracle NoSQL DB 显示连接设置页。
- 从命令面板打开
  1. 通过按下以下命令面板打开命令面板：
    - （Windows 和 Linux）控件 + Shift + P
    - (macOS) 命令 + Shift + P
  2. 在命令面板中，选择 OracleNoSQL:Show Connections Settings 。
    
    提示：
    在命令面板中输入 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 。

请输入连接信息。

表 - 云连接参数

域	说明	示例值
区域：	选择 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 身份和访问管理 (IAM) 中创建区间。请参阅Oracle Cloud Infrastructure 文档中的设置租户和管理区间。	划分名称 `我的区间` 符合其父区间的限定区间名称 `parent.childcompartment` 区间 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 文档中的从哪里获取租户的 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`
私有密钥文件：	浏览找到存储私钥的位置。请参见 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 身份和访问管理 (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`。

单击连接。
单击重置可从工作区中清除保存的连接详细信息。

创建配置文件，例如 config.json 或带有 JSON 对象的文件。连接到 Oracle NoSQL Database Cloud Service 或 Oracle NoSQL Database Cloud Simulator 的配置文件格式如下所示。

表 - 配置模板

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）控件 + Shift + X
- (macOS) 命令 + Shift + X
从命令面板中，选择 Oracle NoSQL：Connect via Config File 。

提示：
在命令面板中输入 oraclenosql 以显示可以使用的所有 Oracle NoSQL DB 命令。
浏览到存储 *.config 文件的位置，然后单击选择。

使用 Visual Studio Code 扩展管理表

使用 Oracle NoSQL Database Visual Studio (VS) 代码扩展连接到部署后，使用左侧导航中的 TABLE EXPLORER 可执行以下操作：

浏览表、列、索引、主键和分片键。
创建新表。
删除现有表。
创建索引。
删除索引。
添加列。
删除列。
将数据插入表中。
执行 SELECT SQL 查询。

探讨表、列、索引和键

展开活动连接时，Oracle NoSQL Database VS Code 将显示该部署中的表。

单击表名可查看其列、索引、主键和分片键。列名及其数据类型一起显示。
您可以随时刷新方案或表来重新查询部署，并使用最新数据填充 Oracle NoSQL Database Cloud Service 。
- 在 TABLE EXPLORER（表 EXPLORER）中，找到连接并单击“刷新”图标以重新加载方案。或者，可以右键单击连接并选择刷新方案。
- 在 TABLE EXPLORER（表 EXPLORER）中，找到表名，然后单击“Refresh（刷新）”图标以重新加载表。或者，可以右键单击表名并选择刷新表。

使用 Visual Studio Code 执行 DDL 操作

可以使用 Visual Studio Code 执行 DDL 操作。

可从 Visual Studio Code 插件内执行的一些 DDL 操作包括：

CREATE TABLE
删除表
创建索引
删除索引
添加列
删除列

CREATE TABLE

可以采用两种模式创建 Oracle NoSQL Database 表：

简单 DDL 输入：可以使用此模式以声明方式创建 Oracle NoSQL Database 表，即无需编写 DDL 语句。
高级 DDL 输入：可以使用此模式通过 DDL 语句创建 Oracle NoSQL Database 表。

将鼠标悬停在 Oracle NoSQL Database 连接上以添加新表。
单击显示的加号图标。

在创建表页中，选择简单 DDL 输入。

表 - 创建 Oracle NoSQL Database 表

域	说明
表名称：	指定唯一的表名。
列名称	为表中的主键指定列名。
列类型	为主键列选择数据类型。
设置为分片键	选择此选项可将此主键列设置为分片键。分片键是在 Oracle NoSQL Database 集群中分发数据以提高效率，并定位共享分片键的记录，以便于参考和访问。共享分片密钥的记录存储在同一物理位置中，可以原子性和高效地访问。
删除	单击此按钮可删除现有列。
+ 添加主关键字列	单击此按钮可在创建组合（多列）主键时添加更多列。
列名称	指定列名称。
列类型	选择列的数据类型。
默认值	（可选）指定列的默认值。注意：无法为二进制和 JSON 数据类型列指定默认值。
非空值	选择此选项可指定列必须始终具有值。
删除	单击此按钮可删除现有列。
+ 添加列	单击此按钮可添加更多列。
单位	选择要用于表中行的 TTL 值的单位（天数或小时数）。
值	指定表中行的到期持续时间。在天数或小时数之后，行将自动失效，并且不再可用。默认值为零，表示没有到期时间。注意：更新表生存时间 (TTL) 不会更改表中任何现有数据的 TTL 值。新 TTL 值仅应用于修改此值后添加到表的那些行以及未为其提供覆盖行特定值的行。

单击显示 DDL 可查看基于在简单 DDL 输入模式的字段中输入的值形成的 DDL 语句。单击创建时将执行此 DDL 语句。
单击创建。

删除表

右键单击目标表。
单击删除表。
单击是以删除表。

创建索引

找到表浏览器，然后单击“Refresh Schema（刷新方案）”重新加载方案。
右键单击需要创建索引的表。选择创建索引。
指定索引的名称以及要包含在索引中的列。
单击添加索引。

删除索引

找到表浏览器，然后单击“Refresh Schema（刷新方案）”重新加载方案。
单击需要删除索引的表。索引列表显示在列名称下方。
右键单击要删除的索引。单击删除索引。
此时将显示一个确认窗口，单击确定以确认放置操作。

添加列

找到表浏览器，然后单击“Refresh Schema（刷新方案）”重新加载方案。
右键单击需要添加列的表。单击添加列。
指定列名并定义列及其属性：数据类型、默认值以及该列是否可为空。
单击添加新列。

删除列

找到表浏览器，然后单击“Refresh Schema（刷新方案）”重新加载方案。
展开需要删除列的表。
右键单击要删除的列，然后选择删除列。
此时将显示一个确认窗口，单击确定以确认放置操作。

使用 Visual Studio Code 执行 DML 操作

可以添加数据、修改现有数据以及从表 usingVisual Studio Code 插件查询数据。

插入数据

找到表浏览器，然后单击“Refresh Schema（刷新方案）”重新加载方案。
右键单击需要插入行的表。选择插入行。
在“插入行”面板中，输入插入新行的详细信息。可以采用两种模式插入新 ROW：
- 简单输入：可以使用此模式插入新行，而无需编写 DML 语句。在此加载基于表单的行字段条目，您可以在其中输入行中每个字段的值。
- 高级 JSON 输入：您可以使用此模式通过提供包含列名及其对应值的 JSON 对象作为键 - 值对来向表中插入新行。
单击插入行。

修改数据 - UPDATE ROW/DELETE ROW：

找到表浏览器，然后单击“Refresh Schema（刷新方案）”重新加载方案。
单击需要修改数据的表。
在 SQL> 右侧的文本框中，输入 SQL 语句以从表中提取数据。单击 > 运行查询。
要单独查看单个单元格数据，请单击表单元格。
要执行“Update（更新）”和“Delete Row（删除行）”等 DML 操作，请右键单击特定行。从显示的上下文菜单中选择您的选项。
- 删除行：此时将显示一个确认窗口，单击确定删除该行。
- 更新行：在列出的行下方会打开一个单独的 HTML 面板，其中包含基于表单的条目中的列名及其对应值，或者将输入作为 ON 键对对象提供。您可以选择两种方法中的任意一种并提供新值。
  
  注意：
  在任何行中，都不能更新 PRIMARY KEY 和 GENERATED ALWAYS AS IDENTITY 列。

对表执行 SQL 查询

找到表浏览器，然后单击“Refresh Schema（刷新方案）”重新加载方案。
右键单击该表，然后选择浏览表。
在 SQL> 右侧的文本框中，输入 SELECT 语句以从表中提取数据。
单击 > 运行查询。从表中检索相应的数据。
右键单击任意行，然后单击“Download row in to JSON file（将行下载到 JSON 文件）”。单行将下载到 JSON 文件中。
单击下载查询结果可将 SELECT 语句的完整结果保存为 JSON 文件。
单击提取所有记录可从表中检索所有数据。

删除连接

Oracle NoSQL Database Connector 提供了两种从 Visual Studio (VS) 代码中删除连接的方法。

您可以执行以下操作：

删除与命令面板的连接，或者
从活动栏中的 Oracle NoSQL DB 视图中删除连接。

注意：

从 Visual Studio Code 中删除连接会从当前工作区中删除持久连接详细信息。

从 Oracle NoSQL DB 视图中删除连接
删除与命令面板的连接

如果已折叠，则展开左侧导航中的 TABLE EXPLORER 窗格。
右键单击要删除的连接，然后单击删除连接。

通过按下以下命令面板打开命令面板：
- （Windows 和 Linux）控件 + Shift + P
- (macOS) 命令 + Shift + P
在命令面板中，选择 OracleNoSQL：Remove Connection 。

提示：
在命令面板中输入 oraclenosql 以显示可以使用的所有 Oracle NoSQL DB 命令。

标题和版权信息

使用 Visual Studio Code 扩展进行开发

Oracle 和/或其关联公司。