VOOZH about

URL: https://www.cdata.com/kb/tech/perigon-jdbc-datagrip.rst

⇱ Query Perigon Data in DataGrip


Query Perigon Data in DataGrip

πŸ‘ Jerod Johnson
Jerod Johnson
Director, Technology Evangelism
Create a Data Source for Perigon in DataGrip and use SQL to query live Perigon data.

DataGrip is a database IDE that allows SQL developers to query, create, and manage databases. When paired with the CData API Driver for JDBC, DataGrip can work with live Perigon data. This article shows how to establish a connection to Perigon data in DataGrip.

Create a New Driver Definition for Perigon

The steps below describe how to create a new Data Source in DataGrip for Perigon.

  1. In DataGrip, click File -> New > Project and name the project πŸ‘ Creating a new DataGrip project.
  2. In the Database Explorer, click the plus icon () and select Driver. πŸ‘ Adding a new Driver.
  3. In the Driver tab:
    • Set Name to a user-friendly name (e.g. "CData Perigon Driver")
    • Set Driver Files to the appropriate JAR file. To add the file, click the plus (), select "Add Files," navigate to the "lib" folder in the driver's installation directory and select the JAR file (e.g. cdata.jdbc.api.jar).
    • Set Class to cdata.jdbc.api.API.jar
  4. Click "Apply" then "OK" to save the Connection πŸ‘ A configured Driver (Salesforce is shown).

Configure a Connection to Perigon

  1. Once the connection is saved, click the plus (), then "Data Source" then "CData Perigon Driver" to create a new Perigon Data Source.
  2. In the new window, configure the connection to Perigon with a JDBC URL.

    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 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
    πŸ‘ Using the built-in connection string designer to generate a JDBC URL (Salesforce is shown.)
  3. Set URL to the connection string, e.g.,
    jdbc:api:Profile=C:\profiles\Perigon.apip;AuthScheme=APIKey;ProfileSettings="APIKey=your_api_key"
  4. Click "Apply" and "OK" to save the connection string πŸ‘ A configured Data Source (Salesforce is shown).

At this point, you will see the data source in the Data Explorer.

Execute SQL Queries Against Perigon

To browse through the Perigon entities (available as tables) accessible through the JDBC Driver, expand the Data Source.

πŸ‘ Exploring the data (Salesforce is shown.)

To execute queries, right click on any table and select "New" -> "Query Console."

πŸ‘ Opening a new Query Console.

In the Console, write the SQL query you wish to execute. For example:

SELECT , FROM Articles WHERE = ''
πŸ‘ Querying with SQL (Salesforce is shown.)

Download a free, 30-day trial of the CData API Driver for JDBC and start working with your live Perigon data in DataGrip. Reach out to our Support Team if you have any questions.