Connect to Backlog Data from HeidiSQL

HeidiSQL is an open-source database administration tool that natively supports MariaDB, MySQL, SQL Server, and PostgreSQL. When paired with CData Connect Cloud, HediSQL reach extends to include access to live Backlog data. This article demonstrates how to connect to Backlog using Connect Cloud and query Backlog data in HeidiSQL.

CData Connect Cloud provides a pure SQL Server interface for Backlog, allowing you to query data from Backlog without replicating the data to a natively supported database. Using optimized data processing out of the box, CData Connect Cloud pushes all supported SQL operations (filters, JOINs, etc.) directly to Backlog, leveraging server-side processing to return the requested Backlog data quickly.

Configure Backlog Connectivity for HeidiSQL

Connectivity to Backlog from HeidiSQL is made possible through CData Connect Cloud. To work with Backlog data from HeidiSQL, we start by creating and configuring a Backlog connection.

1. Log into Connect Cloud, click Connections and click Add Connection

2. Select "Backlog" from the Add Connection panel

3. Enter the necessary authentication properties to connect to Backlog.

   In order to authenticate using the API Key, specify the following:

   • AuthScheme: Set to APIToken.
   • API Key: Set to the API Key that allows you to make requests to the Backlog API. You can generate this key by opening the Settings page in Backlog and selecting the API section.
   • URL: Set to the your Backlog tenant URL.

   In order to authenticate using OAuth, set AuthScheme to "OAuth" and refer to the Help documentation.

4. Click Create & Test
5. Navigate to the Permissions tab in the Add Backlog Connection page and update the User-based permissions.

Add a Personal Access Token

If you are connecting from a service, application, platform, or framework that does not support OAuth authentication, you can create a Personal Access Token (PAT) to use for authentication. Best practices would dictate that you create a separate PAT for each service, to maintain granularity of access.

1. Click on your username at the top right of the Connect Cloud app and click User Profile.
2. On the User Profile page, scroll down to the Personal Access Tokens section and click Create PAT.
3. Give your PAT a name and click Create.

4. The personal access token is only visible at creation, so be sure to copy it and store it securely for future use.

Connect to Backlog from HeidiSQL using Connect Cloud

To establish a connection from HeidiSQL to the CData Connect Cloud Virtual SQL Server API, follow these steps.

Create a new HeidiSQL Session

1. In the Session Manager, select New in the bottom-left
2. Give the new session a descriptive name, e.g. Connect-Cloud-Backlog

Configure a SQL Server Connection to Connect Cloud

1. In the session settings, set the Network type to Microsoft SQL Server (TCP/IP)
2. The Library DLL should automatically update to MSOLEDBSQL
3. Set the Hostname/IP to tds.cdata.com
4. Set the User to your CData Connect Cloud username. This is displayed in the top-right corner of the CData Connect Cloud interface. For example, [email protected]
5. Set the Password to your PAT created in Connect Cloud in the previous section.
6. Set the Port to 14333

Query Backlog from HeidiSQL

1. In the database listing on the left, find your connection to Backlog configured earlier.
2. Expand this connection to view individual tables or data objects present within Backlog.
3. Write custom SQL queries targeting these tables, treating the data source like any SQL Server database, or visually explore each tabular data set by selecting the relevant tables

Get CData Connect Cloud

To get live data access to 100+ SaaS, Big Data, and NoSQL sources directly from your SQL Server database, try CData Connect Cloud today!