Query Short.io Data in DataGrip

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 Short.io data. This article shows how to establish a connection to Short.io data in DataGrip.

Create a New Driver Definition for Short.io

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

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 Short.io 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 Short.io

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

   Built-in Connection String Designer

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

   Short.io uses API Key authentication. To obtain your API key:

   1. Log in to your Short.io account
   2. Navigate to Settings > Integrations & API > API
   3. Click Create API Key and copy your API key

   After obtaining the API key, you are ready to connect:

   • AuthScheme: Set this to APIKey.
   • APIKey: Set this to your Short.io API key obtained from Settings > Integrations & API > API.

   Example connection string:

   Profile=C:\profiles\ShortIo.apip;AuthScheme=APIKey;ProfileSettings='APIKey=your_api_key';
   

   Available Tables

   The Short.io profile provides access to the following tables:

   • Domains - Short.io domains associated with the authenticated account
   • Links - Short links for a domain
   • LinkExpand - Expand a short link by domain and path
   • LinksByOriginalUrl - Retrieve multiple short links matching a given original destination URL
   • Folders - Link folders within a specific domain
   • LinkPermissions - Permission records for a specific link within a domain
   • CountryTargeting - Country-based redirect targeting rules for a specific short link
   • RegionTargeting - Region-based redirect targeting rules for a specific short link
   • Regions - List of available regions/states for a given country code
   • DomainStatistics - Aggregated click and traffic statistics for a Short.io domain
   • LinkStatistics - Aggregated click and traffic statistics for a specific Short.io link
   👁 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\ShortIo.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 Short.io

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

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

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

SELECT , FROM Domains WHERE = ''

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