How to Query Harvest Data in MySQL Workbench

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

Connect to Harvest 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.

Start by setting the Profile connection property to the location of the Harvest Profile on disk (e.g. C:\profiles\Harvest.apip). Next, set the ProfileSettings connection property to the connection string for Harvest (see below).

Harvest API Profile Settings

To authenticate to Harvest, you can use either Token authentication or the OAuth standard. Use Basic authentication to connect to your own data. Use OAuth to allow other users to connect to their data.

Using Token Authentication

To use Token Authentication, set the APIKey to your Harvest Personal Access Token in the ProfileSettings connection property. In addition to APIKey, set your AccountId in ProfileSettings to connect.

Using OAuth Authentication

First, register an OAuth2 application with Harvest. The application can be created from the "Developers" section of Harvest ID.

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

• ProfileSettings: Set your AccountId in ProfileSettings.
• AuthScheme: Set this to OAuth.
• OAuthClientId: Set this to the client ID that you specified in your app settings.
• OAuthClientSecret: Set this to the client secret that you specified in your app settings.
• CallbackURL: Set this to the Redirect URI that you specified in your app settings.
• InitiateOAuth: Set this to GETANDREFRESH. You can use InitiateOAuth to manage how the driver obtains and refreshes the OAuthAccessToken.

Configure the SQL Gateway

See the SQL Gateway Overview to set up connectivity to Harvest 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.

👁 Creating a MySQL Remoting Service in SQL Gateway (Salesforce is shown)

Query Harvest from MySQL Workbench

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

Connect to Harvest through the SQL Gateway

1. In MySQL Workbench, click to add a new MySQL connection.
2. Name the connection (CData SQL Gateway for Harvest).
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 Harvest Data

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

With access to live Harvest data from MySQL Workbench, you can easily work with Harvest, 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.