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

Create a New Driver Definition for Paddle

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

1. In DataGrip, click File -> New > Project and name the project
2. In the Database Explorer, click the plus icon () and select Driver.
3. In the Driver tab:
   • Set Name to a user-friendly name (e.g. "CData Paddle 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
   Additionally, in the advanced tab you can change driver properties and some other settings like VM Options, VM environment, VM home path, DBMS, etc
   • For most cases, change the DBMS type to "Unknown" in Expert options to avoid native SQL Server queries (Transact-SQL), which might result in an invalid function error
4. Click "Apply" then "OK" to save the Connection

Configure a Connection to Paddle

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

   Built-in Connection String Designer

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

   Paddle uses API key authentication. To obtain an API key:

   1. Sign in to your Paddle account at https://vendors.paddle.com
   2. Navigate to Developer Tools > Authentication
   3. Click "Generate API Key"
   4. Assign the appropriate permissions for the data you wish to access
   5. Copy the generated key (sandbox keys begin with pdl_sdbx_apikey_; production keys begin with pdl_live_apikey_)

   After obtaining your API key, set the following connection properties:

   • AuthScheme: Set this to APIKey.
   Set the following in the ProfileSettings connection property:
   • APIKey: Set this to your Paddle API key.

   Example Connection String

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

   Connecting to Paddle

   Once the authentication is configured, you can connect to Paddle and query data from any of the available tables such as Products, Customers, Subscriptions, and Transactions.

   
3. Set URL to the connection string, e.g.,

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

4. Click "Apply" and "OK" to save the connection string

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

Execute SQL Queries Against Paddle

To browse through the Paddle 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 Products WHERE  = ''

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