How to Query Paddle Data in MySQL Workbench

You can use the SQL Gateway from the ODBC Driver for Paddle to query Paddle data through a MySQL interface. Follow the procedure below to start the MySQL remoting service of the SQL Gateway and work with live Paddle data in MySQL Workbench.

Connect to Paddle Data

If you have not already done so, provide values for the required connection properties in the data source name (DSN). You can use the built-in Microsoft ODBC Data Source Administrator to configure the DSN. This is also the last step of the driver installation. See the "Getting Started" chapter in the help documentation for a guide to using the Microsoft ODBC Data Source Administrator to create and configure a DSN.

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.

• 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.

Configure the SQL Gateway

See the SQL Gateway Overview to set up connectivity to Paddle data as a virtual MySQL database. You will configure a MySQL remoting service that listens for MySQL requests from clients. The service can be configured in the SQL Gateway UI.

Query Paddle from MySQL Workbench

The steps below outline connecting to the virtual Paddle database created in the SQL Gateway from MySQL Workbench and issuing basic queries to work with live Paddle data.

Connect to Paddle through the SQL Gateway

1. In MySQL Workbench, click to add a new MySQL connection.
2. Name the connection (CData SQL Gateway for Paddle).
3. Set the Hostname, Port, and Username parameters to connect to the SQL Gateway.
4. Click Store in Vault to set and store the password.
5. Click Test Connection to ensure the connection is configured properly and click OK.

NOTE: When we refer to Username and Password, we mean the credentials for the user(s) created for the SQL Gateway.

Query Paddle Data

1. Open the connection you just created (CData SQL Gateway for Paddle).
2. Click File -> New Query Tab.
3. Write a SQL query to retrieve Paddle data, like SELECT * FROM `CData API Sys`.Products;

With access to live Paddle data from MySQL Workbench, you can easily work with Paddle, just like you would a MySQL database. Get started now with a free, 30-day trial of the CData API Driver for ODBC and the CData SQL Gateway.