Connect to Perigon Data in Aqua Data Studio

The CData JDBC Driver for Perigon integrates Perigon data with wizards and analytics in IDEs like Aqua Data Studio. This article shows how to connect to Perigon 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 Perigon 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, Perigon.
   • 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.

     Using API Key Authentication

     To use the Perigon API, you need to obtain an API key from your Perigon account. Navigate to the Perigon dashboard and generate an API key from your account settings.

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

     • AuthScheme: Set this to APIKey.
     • APIKey: Set this to your Perigon API key.

     Example connection string:

     Profile=C:\profiles\Perigon.apip;AuthScheme=APIKey;ProfileSettings="APIKey=your_api_key"
     

     Available Tables

     The Perigon profile provides access to the following tables:

     • Articles - News articles retrieved from the Perigon news intelligence API
     • Headlines - Story clusters grouping related headline articles
     • Sources - News sources tracked by the Perigon news intelligence API
     • Journalists - Journalist profiles tracked by the Perigon news intelligence API

     Built-in Connection String Designer

     For assistance in constructing the JDBC URL, use the connection string designer built into the Perigon 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.

     👁 Using the built-in connection string designer to generate a JDBC URL (Salesforce is shown.)
     A typical JDBC URL is below:

     jdbc:api:Profile=C:\profiles\Perigon.apip;AuthScheme=APIKey;ProfileSettings="APIKey=your_api_key"

   👁 The JDBC data source, defined by the JAR path, driver class, and JDBC URL. (QuickBooks is shown.)
   

Query Perigon Data

You can now query the tables exposed.