Connect to JSON Services from HeidiSQL

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

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

Configure JSON Connectivity for HeidiSQL

Connectivity to JSON from HeidiSQL is made possible through CData Connect AI. To work with JSON services from HeidiSQL, we start by creating and configuring a JSON connection.

1. Log into Connect AI, click Sources, and then click Add Connection
👁 Adding a Connection

2. Select "JSON" from the Add Connection panel
👁 Selecting a data source

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

   See the Getting Started chapter in the data provider documentation to authenticate to your data source: The data provider models JSON APIs as bidirectional database tables and JSON files as read-only views (local files, files stored on popular cloud services, and FTP servers). The major authentication schemes are supported, including HTTP Basic, Digest, NTLM, OAuth, and FTP. See the Getting Started chapter in the data provider documentation for authentication guides.

   After setting the and providing any authentication values, set to more closely match the data representation to the structure of your data.

   The property is the controlling property over how your data is represented into tables and toggles the following basic configurations.

   • Document (default): Model a top-level, document view of your JSON data. The data provider returns nested elements as aggregates of data.
   • FlattenedDocuments: Implicitly join nested documents and their parents into a single table.
   • Relational: Return individual, related tables from hierarchical data. The tables contain a primary key and a foreign key that links to the parent document.

   See the Modeling JSON Data chapter for more information on configuring the relational representation. You will also find the sample data used in the following examples. The data includes entries for people, the cars they own, and various maintenance services performed on those cars.

   👁 Configuring a connection (Salesforce is shown)
   
4. Click Save & Test
5. Navigate to the Permissions tab in the Add JSON Connection page and update the User-based permissions. 👁 Updating permissions
   

Add a Personal Access Token

When connecting to Connect AI through the REST API, the OData API, or the Virtual SQL Server, a Personal Access Token (PAT) is used to authenticate the connection to Connect AI. It is best practice to create a separate PAT for each service to maintain granularity of access.

1. Click on the Gear icon () at the top right of the Connect AI app to open the settings page.
2. On the Settings page, go to the Access Tokens section and click Create PAT.
3. Give the PAT a name and click Create. 👁 Creating a new PAT
   
4. The personal access token is only visible at creation, so be sure to copy it and store it securely for future use.

With the connection configured and a PAT generated, you are ready to connect to JSON services from HeidiSQL.

Connect to JSON from HeidiSQL using Connect AI

To establish a connection from HeidiSQL to the CData Connect AI 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-JSON
👁 Creating a new session in HeidiSQL.

Configure a SQL Server Connection to Connect AI

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 AI username. This is displayed in the top-right corner of the CData Connect AI interface. For example, [email protected]
5. Set the Password to your PAT created in Connect AI in the previous section.
6. Set the Port to 14333 👁 Configuring a SQL Server connection to Connect AI
   

Query JSON from HeidiSQL

1. In the database listing on the left, find your connection to JSON configured earlier.
2. Expand this connection to view individual tables or data objects present within JSON.
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 👁 Querying within HeidiSQL.
   

Get CData Connect AI

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