Connecting to Oracle NoSQL Database from IntelliJ

Learn how to connect your NoSQL project to Oracle NoSQL Database KVStore using the IntelliJ plugin.

Prerequisites:

To create a successful connection to your Oracle NoSQL Database KVStore, ensure that:

• The KVStore is deployed and running.
• The Oracle NoSQL Database Proxy is started. See Configuring the Proxy. Starting the release 19.5, Proxy is bundled along with the Oracle NoSQL Database download package.

Perform the following steps:

1. Open your NoSQL project in IntelliJ.
2. Click the task icon in the Schema Explorer window to open the Settings dialog for the plugin.
3. Expand Tools > Oracle NoSQL in the Settings Explorer, and click Connections. You can view all the existing connections for the on-premises profile type under the Connections dropdown.
4. Select Onprem from the drop-down menu for the Profile type.
5. Click Add Connection. Enter values for the following connection parameters, and click OK.

   Table 5-5 Connection Parameters

   Parameter	Description
   Connection Name	A unique name, that is given to a specific connection specification is mandatory from the plugin version 1.5.1. Updating the Connection Name field is recommended after upgrading the plugin from version 1.4.0 or lower. Note: You can add multiple connections and the stored connection specifications are persistent.
   Proxy URL	http://<proxy_host>:<proxy_http_port> or https://<proxy_host>:<proxy_http_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 proxy service. This should match the host you configured earlier. See Configuring the Proxy.
   SDK Path	Complete path to the directory where you extracted the Oracle NoSQL Java SDK. For example, D:\oracle-nosql-java-sdk-5.4.14\oracle-nosql-java-sdk
   Namespace	Provide the name of your namespace. This is optional. If no value is provided then the default namespace sysdefault is used. Note: You can add one or more namespaces to your store, create tables within them, and grant permission for users to access namespaces and tables.
   Security	Select SSL for secure KVStores. In case, you are creating connection to a non-secure KVStore, select None. The default value is SSL. Note: In case of secure KVStores, the proxy URL must begin with https.
   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.
   TrustStore	Browse to the location where the certificate trust file is placed. See Using the Proxy in a secure data store.
   Passphrase	Give a value for the passphrase. A passphrase refers to a secret used to protect an encryption key. This is optional.

   Note:

   If you are updating the plugin from version 1.4.0 or lower, all the stored connections migrate to the new version. In this case, the Connection Name will be the same as Proxy URL. Follow the below step to change the Connection Name.
6. The IntelliJ Plugin saves the connection details in the connection name specified. To modify the connection details, choose the connection name in the drop-down for Connections. Click Modify Connection. You can change any of the connection parameters (mentioned above) and click OK to save the settings. To remove a connection name from the plugin, choose the connection name and click Delete Connection. Once you confirm the action to delete, the connection name is removed from the plugin.
7. Click the Web icon in the Schema Explorer. The list of existing connections is displayed in the dropdown box. The connection will be displayed in the NoSQL tool window in the following format : Connection Name:Proxy URL:Namespace(if specified). Choose the connection and click OK. The Intellij plugin connects your project to the Oracle NoSQL Database KVStore and displays its schema in the Schema Explorer window.

After you successfully connect your project to your Oracle NoSQL Database KVStore, you can manage the tables and data in your schema.