Connect to Elorus Data in Aqua Data Studio

Jerod Johnson
Jerod Johnson
Director, Technology Evangelism
Access Elorus data from tools in Aqua Data Studio such as the Visual Query Builder and the Table Data Editor.

The CData JDBC Driver for Elorus integrates Elorus data with wizards and analytics in IDEs like Aqua Data Studio. This article shows how to connect to Elorus data through the connection manager and execute queries.

Create a JDBC Data Source

You can use the connection manager to define connection properties and save them in a new JDBC data source. The Elorus data source can then be accessed from Aqua Data Studio tools.

  1. In Aqua Data Studio, select Register Server from the Servers menu.
  2. In the Register Server form, select the 'Generic - JDBC' connection.
  3. Enter the following JDBC connection properties:
    • Name: Enter a name for the data source; for example, Elorus.
    • Driver Location: Click the Browse button and select the cdata.jdbc.api.jar file, located in the lib subfolder of the installation directory.
    • Driver: Enter the Driver's class name, cdata.jdbc.api.APIDriver.
    • URL: Enter the JDBC URL, which starts with jdbc:api: and is followed by a semicolon-separated list of connection properties.

      Start by setting the Profile connection property to the location of the Elorus Profile on disk (e.g. C:\profiles\Elorus.apip). Next, set the ProfileSettings connection property to the connection string for Elorus (see below).

      Elorus API Profile Settings

      Obtain your API Key from your User Profile in the top-right corner of Elorus. Find your Organization ID under Settings > Organization.

      Built-in Connection String Designer

      For assistance in constructing the JDBC URL, use the connection string designer built into the Elorus JDBC Driver. Either double-click the JAR file or execute the jar file from the command-line.

      java -jar cdata.jdbc.api.jar
      

      Fill in the connection properties and copy the connection string to the clipboard.

      A typical JDBC URL is below:
      jdbc:api:Profile=C:\profiles\Elorus.apip;ProfileSettings='APIKey=your_api_key;OrganizationId=your_org_id';

Query Elorus Data

You can now query the tables exposed.

Ready to get started?

Connect to live data from Elorus with the API Driver

Connect to Elorus