Connect to Abyssale Data in Aqua Data Studio

The CData JDBC Driver for Abyssale integrates Abyssale data with wizards and analytics in IDEs like Aqua Data Studio. This article shows how to connect to Abyssale 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 Abyssale 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, Abyssale.
   • 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 Abyssale Profile on disk (e.g. C:\profiles\Abyssale.apip). Next, set the ProfileSettings connection property to the connection string for Abyssale (see below).

     Abyssale API Profile Settings

     Abyssale uses API Key authentication. Your Abyssale API Key is sent as the x-api-key request header. You can generate or view your API Key in the Abyssale dashboard under Settings > API.

     After setting the following connection properties, you are ready to connect:

     • AuthScheme: Set this to APIKey.
     • APIKey: Set this to your Abyssale API Key.

     Built-in Connection String Designer

     For assistance in constructing the JDBC URL, use the connection string designer built into the Abyssale 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\Abyssale.apip;AuthScheme=APIKey;ProfileSettings='APIKey=your_api_key';

   

Query Abyssale Data

You can now query the tables exposed.