Connecting to Oracle NoSQL Database from Visual Studio Code

Oracle NoSQL Database Visual Studio (VS) Code extension allows you to connect to Oracle NoSQL Database by filling in the connection information in the specific fields.

  1. In Visual Studio Code, click the Oracle NoSQL DB view in the Activity Bar.


    Oracle NoSQL DB View

  2. Open the Oracle NoSQL DB Show Connection Settings page from the Command Palette or the Oracle NoSQL DB view in the Activity Bar.
    • Open from Command Palette
      1. Open the Command Palette by pressing:
        • (Windows and Linux) Control + Shift + P
        • (macOS) Command + Shift + P
      2. From the Command Palette, select OracleNoSQL: Show Connections Settings.

        Tip:

        Enter oraclenosql in the Command Palette to display all of the Oracle NoSQL DB commands you can use.
    • Open from Oracle NoSQL DB View
      1. Expand the Table Explorer pane in the left navigation if it's collapsed.
      2. Click Add Connection to open the Oracle NoSQL DB Show Connection Settings page.
  3. In the Connection Settings page, click Onprem to connect to Oracle NoSQL Database.
  4. Click Add New Connection. Enter the connection information, and click Add.

    Table 2-1 Oracle NoSQL Database Connection Parameters

    Field Description
    Connection Name: A unique name, for the connection specification is mandatory from the plugin version 4.0.0. Updating the Connection Name field is recommended after upgrading the plugin from version 3.0.0 or lower.

    Note:

    You can add multiple connections and the stored connection specifications are persistent.
    Endpoint: Service URL of the Oracle NoSQL Database Proxy.
    • http://<proxy_host>:<proxy_http_port>
    • https://<proxy_host>:<proxy_https_port>
    where,
    • http or https indicates the store security. For a secure KVStore, the proxy URL begins with https.
    • proxy_host is the host name of the machine to host the Oracle NoSQL Database Proxy service. For more information, see Configuring the Proxy.
    Namespace: Add the name of an existing namespace in your store. This is an optional field. The default namespace is sysdefault, if not provided. A namespace is a container that contains one or more tables.

    Note:

    You cannot create a table in a namespace that does not exist.
    To create a namespace, see EXECUTE DDL.
    Security: Select SSL for secure KVStores. In case you are creating the connection to a non-secure KVStore, select None.

    The default value is None.

    Username: User name to connect to the secure store. This value is required only if you select SSL for the Security parameter.
    Password: Password to connect to the secure store. This value is required only if you select SSL for the Security parameter.
    Certificate File: Browse to the location of the SSL certificate file (for example, certificate.pem). See Using the Proxy in a secure data store.

    Note:

    The connection processing has changed starting with version 4.0.0. If you are using an older version of the plugin, then only the most recently used connection will be migrated during the upgrade process to version 4.0.0. The plugin will automatically assign the name onprem_old0 to the migrated connection. You can change the connection name using the Modify Connection option in the Connections Setting page.
  5. The connection details are saved. To modify existing connections, select the connection from the Connections drop-down. Click Modify Connections. Make the desired changes in the Connection Parameters and click Save. To remove a connection permanently from the plugin, select the connection from the Connections drop-down. Click Delete Connection. You get a confirmation to delete the plugin, click Yes to remove the connection from the plugin.

Note:

When you want to connect to a on-premise secure cluster using Visual Studio Code Extension, you need to do one of the following if you have self-signed certificates:
  • Add the self-signed certificate to the trusted root store in your Windows configuration (using Microsoft Management Console)).
  • Open Visual Studio Code. Go to File > Preferences > Settings > Application > Proxy. In the Proxy Support menu select off.