How to Query BugHerd Data in MySQL Workbench

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

Connect to BugHerd 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 BugHerd Profile on disk (e.g. C:\profiles\BugHerd.apip). Next, set the ProfileSettings connection property to the connection string for BugHerd (see below).

BugHerd API Profile Settings

BugHerd uses HTTP Basic authentication with an API key as the username. To obtain an API key:

1. Sign in to your BugHerd account at https://www.bugherd.com
2. Navigate to Settings > General Settings
3. Locate the API Key section and copy the generated key

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 BugHerd API key. The driver uses the key as the Basic auth username and sets the password internally to the literal value 'x' as required by BugHerd.

Configure the SQL Gateway

See the SQL Gateway Overview to set up connectivity to BugHerd 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 BugHerd from MySQL Workbench

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

Connect to BugHerd through the SQL Gateway

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

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

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