VOOZH about

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

⇱ Query Gumroad Data in DataGrip


Query Gumroad Data in DataGrip

πŸ‘ Jerod Johnson
Jerod Johnson
Director, Technology Evangelism
Create a Data Source for Gumroad in DataGrip and use SQL to query live Gumroad 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 Gumroad data. This article shows how to establish a connection to Gumroad data in DataGrip.

Create a New Driver Definition for Gumroad

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

  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 Gumroad 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 Gumroad

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

    Built-in Connection String Designer

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

    To authenticate to Gumroad and connect to your own data or to allow other users to connect to their data, you can use the OAuth 2.0 standard. This is the recommended authentication method.

    First you need to register an OAuth application with Gumroad. You can create an OAuth application by visiting your Gumroad account settings at https://app.gumroad.com/settings/advanced and navigating to the Applications section.

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

    • AuthScheme: Set this to OAuth.
    • InitiateOAuth: Set this to GETANDREFRESH. The CData API Profile for Gumroad will automatically walk through the OAuth process in order to obtain the access token.
    • OAuthClientID: Set this to the client_id that is specified in your app settings.
    • OAuthClientSecret: Set this to the client_secret that is specified in your app settings.
    • CallbackURL: Set this to the Redirect URI you specified in your app settings.

    Example connection string

    Profile=C:\profiles\Gumroad.apip;AuthScheme=OAuth;InitiateOAuth=GETANDREFRESH;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;CallbackUrl=your_callback_url;
    
    πŸ‘ 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\Gumroad.apip;AuthScheme=OAuth;InitiateOAuth=GETANDREFRESH;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;CallbackUrl=your_callback_url;
  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 Gumroad

To browse through the Gumroad 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 CustomFields WHERE ProductId = 'prod_abc123xyz'
πŸ‘ 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 Gumroad data in DataGrip. Reach out to our Support Team if you have any questions.