X

The Oracle NoSQL Database Blog covers all things Oracle NoSQL Database. On-Prem, Cloud and more.

Ease Your Oracle NoSQL Database Cloud Application Development with Eclipse

Vishal Settipalli
Principal Product Manager

How about building an Oracle NoSQL Database Cloud Service application up and running quickly?

If you missed how you can run a locally deployable Oracle NoSQL Database Cloud Simulator to build, test and debug your Java application read this.

To enhance your experience of building an application with Oracle NoSQL Database Cloud Service we are announcing a plugin for the commonly used open source Integrated Development Environments (IDEs) - Eclipse. With this Eclipse plugin you can:

  • Connect to a running instance of the Oracle NoSQL Database Cloud Simulator or Oracle NoSQL Database cloud service to
    • Explore development/test data from tables associated with your Oracle Cloud account
    • Build and test your Oracle NoSQL Database queries
    • Paginate results
  • Add a NoSQL Nature to an existing project – this simplifies adding Oracle NoSQL Database Cloud service client and dependent libraries automatically to your project classpath
  • Browse Examples

Excited! Read further to learn more on how to install the plugin and explore the features that have been provided.

Install Oracle NoSQL Database Cloud Simulator

Oracle NoSQL Database Cloud Simulator is distributed as cloudsim.jar within the SDK. The latest SDK and Driver packages can be downloaded from Oracle Technology Network.

Installation of Cloud Simulator is as simple as unzip/gunzip the distribution.

Detailed instructions can be found in the official documentation.

Starting Oracle NoSQL Database Cloud Simulator

Oracle NoSQL Database Cloud SDK comes with helper scripts which will help you to start Cloud Simulator. To start cloudsim the only parameter required is –root which is where the database files are created.

For other options and detailed steps to start Cloud Simulator is here.

Install Eclipse Plugin for Oracle NoSQL Database Cloud Simulator

NOTE: Oracle NoSQL Database Eclipse Plugin has been built to work with Eclipse Neon 4.6 and later releases.

Now that you have started Cloud Simulator, you can install the Eclipse Plugin to build your application. Follow the screenshots below for detailed instructions to install the plugin.

Before installing ensure you have downloaded the plugin distribution and unzipped to a desired location.

  • Help -> Install Software
  • Point to the directory where you have unzipped the distribution

  • If the plugin is already installed – this step will update the installation

  • Accept the License and click on Finish

  • This will take a few mins to complete the installation and prompt you to restart Eclipse.

Once Eclipse is restarted to verify the plugin installation:

  1. Right click on your existing application -> Configure.
  2. You should an option to Add Oracle NoSQL Nature

Alternately:

  1. Window->Show View -> Other
  2. You should see Oracle NoSQL – Schema Explorer

Configure the plugin

Once the plugin is installed and verified you need to ensure the plugin understands where to find the Oracle NoSQL Database Cloud SDK. Instructions on downloading the SDK, client libraries can be found here.

Once you have the SDK follow these steps to set preferences for the plugin.

  • Window -> Preferences
  • Oracle NoSQL Preferences – The plugin allows you to work with either Cloud Simulator or Oracle NoSQL Database Cloud Service.
    • If you would like your application to work with Cloud Simulator:
      • Select the Profile Type CloudSim.
      • Enter the Service URL – http://localhost:8080
      • Tenant Identifier – this will be the namespace under which all your tables would be created
    • Location of the downloaded SDK
  • If you would like your application to work with the Oracle NoSQL Database Cloud Service:
    • Select the Profile Type as Cloud
    • Enter the Endpoint – ndcs.uscom-east-1.oraclecloud.com/
    • Entitlement ID – this will be the 9 digit entitlement ID associated with your cloud account.
    • IDCS URL – this will be the idcs – Authentication URL associated with your cloud account.

NOTE: The endpoint is specific to one of the available data centers. Please ensure to check and use the right endpoint where your Oracle Cloud account has been created.

NOTE: In case you don’t have the Entitlement ID and IDCS URL follow this to obtain details specific to your Oracle Cloud account.

Adding a Oracle NoSQL Database Nature to an existing Eclipse Project

To add an Oracle NoSQL nature to your existing application

  • Right click on the application
  • Configure
  • Add Oracle NoSQL Nature

Browse Oracle NoSQL Database Examples

To browse Examples that are bundled as part of the SDK, the plugin allows you to create a new Eclipse Project of type NoSQL Examples

  • File -> New -> Other -> Oracle NoSQL – NoSQl Examples

  • Click on next and enter the desired Project Name
  • Select one/all the bundled examples and click on Finish
  • This will create a new Project with the required Oracle NoSQL Database libraries and the source of the examples.

Explore Tables and Data

A very useful feature that the plug-in provides is the ability to browse data that you store and use in your development/test environment in Cloud Simulator or data stored in your Oracle NoSQL Database Cloud Service. Ensure to select the appropriate Profile Type before exploring the tables and data.

With the Data Explorer a developer can:

  • View all the development and test tables created.
  • View the detailed structure of the tables created which includes Primary key, Shard key, indexes, columns and types.

  • Build, test and run Oracle NoSQL queries on your development/test data before using it within your application.
  • Paginate data stored in Cloud Simulator. The amount of data that you want to show in a single view can be configured in Window->Preferences.

Explore Data stored in Oracle NoSQL Database Cloud Service

Before you explore data stored in your Oracle NoSQL Database Cloud Service account ensure to have read Getting Started with Oracle NoSQL Database Cloud and Develop your NoSQL Application in Oracle Cloud.

Once you have read these and have setup your Oracle NoSQL Database Eclipse Plugin preferences with details related to your cloud account you should select the Profile Type as Cloud and follow the steps outlined earlier.

So you can see how easy it is get started with building, testing and debugging your application for Oracle NoSQL Database Cloud Service.

Be the first to comment

Comments ( 0 )
Please enter your name.Please provide a valid email address.Please enter a comment.CAPTCHA challenge response provided was incorrect. Please try again.