How to connect to Gumroad Data with Squirrel SQL client

The CData JDBC Driver for Gumroad enables you to execute queries to Gumroad data in tools like Squirrel SQL Client. In this article, you will create a JDBC data source for Gumroad data and execute queries.

Add the JDBC Driver for Gumroad

Follow the steps below to add the driver JAR.

1. In Squirrel SQL, click Windows -> View Drivers.
2. Click the plus icon to open the Add Driver wizard.
3. In the Name box, enter a user-friendly name for the driver; for example, CData JDBC Driver for Gumroad.
4. In the Example URL box, enter jdbc:api:
5. In the Extra Class Path tab, click Add.
6. In the file explorer dialog that opens, select the JAR file for the driver, located in the lib subfolder of the installation directory.
7. Click List Drivers to populate the Class Name menu with the class name for the driver, cdata.jdbc.api.APIDriver.

Define Connection Properties

Follow the steps below to save connection properties in the driver alias.

1. Click Windows -> View Aliases.
2. In the pane that lists the aliases, click the plus icon.

3. In the Add Alias wizard that opens, the following fields are required for the JDBC driver:

   • Name: Enter a name for the alias; for example, CData Gumroad Source.
   • Driver: Select the CData JDBC Driver for Gumroad.
   • URL: Enter jdbc:api:
   
4. If you want to define any additional properties, click Properties.
5. In the Driver properties tab of the dialog that appears, select the Use driver properties checkbox.
6. In the Specify column, select the checkboxes for the required connection properties.

   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;
   

   Below is a typical connection string:

   jdbc:api:Profile=C:\profiles\Gumroad.apip;AuthScheme=OAuth;InitiateOAuth=GETANDREFRESH;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;CallbackUrl=your_callback_url;
   

   
7. In the dialog that appears after you click OK, click connect to test the connection.

Discover Schemas and Query Gumroad Data

After the metadata has loaded, a new tab for the Gumroad data source is displayed. On the Objects subtab, you can discover schema information, such as the available tables and views.

To view table data, select the table on the Objects tab. The table data is then loaded in a grid on the Content tab.

To execute an SQL query, enter the query on the SQL tab and then click Run SQL (the runner icon). For example:

SELECT ,  FROM CustomFields WHERE ProductId = 'prod_abc123xyz'