Redash is a collaboration tool that lets you query, visualize, and share your data. When paired with
CData Connect AI, Redash gets access to live Cosmos DB data. This article demonstrates how to connect to Cosmos DB
using Connect AI and work with live Cosmos DB data in Redash.
CData Connect AI provides a pure SQL Server interface for Cosmos DB, allowing you to query data from
Cosmos DB 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 Cosmos DB, leveraging server-side processing to return the
requested Cosmos DB data quickly.
Configure Cosmos DB Connectivity for Redash
Connectivity to Cosmos DB from Redash is made possible through CData Connect AI. To work with Cosmos DB data in Redash, we start by creating and configuring a Cosmos DB connection.
-
Log into Connect AI, click Sources, and then click Add Connection
๐ Adding a Connection
- Select "Cosmos DB" from the Add Connection panel
๐ Selecting a data source
-
Enter the necessary authentication properties to connect to Cosmos DB.
To obtain the connection string needed to connect to a Cosmos DB account using the SQL API, log in to the Azure Portal, select Azure Cosmos DB, and select your account. In the Settings section, click Connection String and set the following values:
- AccountEndpoint: The Cosmos DB account URL from the Keys blade of the Cosmos DB account
- AccountKey: In the Azure portal, navigate to the Cosmos DB service and select your Azure Cosmos DB account. From the resource menu, go to the Keys page. Find the PRIMARY KEY value and set AccountKey to this value.
๐ Configuring a connection (Salesforce is shown)
-
Click Save & Test
-
Navigate to the Permissions tab in the Add Cosmos DB 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.
-
Click on the Gear icon () at the top right of the Connect AI app to open the settings page.
-
On the Settings page, go to the Access Tokens section and click Create PAT.
-
Give the PAT a name and click Create.
๐ Creating a new PAT
-
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 Cosmos DB data from Redash.
Connect to Cosmos DB from Redash using Connect AI
To establish a connection from Redash to CData Connect AI using the Virtual SQL Server, follow these steps:
- Log into Redash.
- Click the settings widget on the top right.
- Click New Data Source.
- Select Microsoft SQL Server as the Data Source Type.
-
On the configuration tab, set the following properties:
- Database Name: enter the Connection Name of the CData Connect AI data source you want to connect to (for example, Salesforce1).
- Server: enter the virtual SQL Server host name (tds.cdata.com)
- User: enter your CData Connect AI username. This is displayed in the top-right corner of the CData Connect AI interface. For example, [email protected].
- Password: enter the PAT you generated on the Settings page.
- Port: enter 14333
๐ Configuring the connection to Connect AI from Redash.
- Click Create.
- Click Test Connection to ensure that the connection is configured properly.
You can now work with live Cosmos DB data in Redash.
Get CData Connect AI
To get live data access to hundreds of SaaS, Big Data, and NoSQL sources directly from Redash,
try CData Connect AI today!