Connect to Couchbase 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 Couchbase data. This article demonstrates how to connect to Couchbase using Connect Cloud and query Couchbase data in HeidiSQL.

CData Connect Cloud provides a pure SQL Server interface for Couchbase, allowing you to query data from Couchbase 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 Couchbase, leveraging server-side processing to return the requested Couchbase data quickly.

Configure Couchbase Connectivity for HeidiSQL

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

1. Log into Connect Cloud, click Sources, and then click Add Connection

2. Select "Couchbase" from the Add Connection panel

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

   To connect using the Login method, set User, Password, and Server to the credentials for the account and the address of the server you want to connect to.

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

Add a Personal Access Token

When connecting to Connect Cloud 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 Cloud. 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 Cloud 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.
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 Couchbase data from HeidiSQL.

Connect to Couchbase 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-Couchbase

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 Couchbase from HeidiSQL

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