Build Cosmos DB-Connected Dashboards in Redash

Redash lets you connect and query your data sources, build dashboards to visualize data and share them with your company. When paired with CData Connect Server, you get instant, cloud-to-cloud access to Cosmos DB data for visualizations, dashboards, and more. This article shows how to create a virtual database for Cosmos DB and build visualizations from Cosmos DB data in Redash.

CData Connect Server provides a pure SQL Server interface for Cosmos DB, allowing you to easily build reports from live Cosmos DB data in Redash — without replicating the data to a natively supported database. As you build visualizations, Redash generates SQL queries to gather data. Using optimized data processing out of the box, CData Connect Server pushes all supported SQL operations (filters, JOINs, etc) directly to Cosmos DB, leveraging server-side processing to quickly return the requested Cosmos DB data.

Create a Virtual SQL Server Database for Cosmos DB Data

CData Connect Server uses a straightforward, point-and-click interface to connect to data sources and generate APIs.

1. Login to Connect Server and click Connections.
2. Select "Cosmos DB" from Available Data Sources.
3. 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.
4. Click Save Changes
5. Click Privileges -> Add and add the new user (or an existing user) with the appropriate permissions.

With the virtual database created, you are ready to connect to Cosmos DB data from Redash.

Visualize Cosmos DB Data in Redash

The steps below outline creating a new data source in Redash based on the virtual Cosmos DB database in Connect Server and building a simple visualization from the data.

Create a New Data Source

1. Log into Redash, click on your profile and click "Data Sources"
2. Click the " New Data Source" button
3. Select "Microsoft SQL Server" as the Data Source Type
4. On the configuration tab, set the following properties:
   • Name: Name the data source (e.g. Cosmos DB (CData Connect))
   • Host: The full URL to your CData Connect instance (e.g. https://connect_server_url)
   • Port: The port of the CData Connect SQL Server endpoint (e.g. 1433)
   • User: A CData Connect user
   • Password: The password for the above user
   • Database name: The name of the virtual database for Cosmos DB (e.g. CosmosDB1)
   • Click the checkbox to Use SSQL
5. Click Create
6. Click the "Test Connection" button to ensure you have configured the connection properly

With the new Data Source created, we are ready to visualize our Cosmos DB data.

Create a Cosmos DB Data Visualization

1. Click Create -> New Query
2. Select the newly created Data Source (you can explore the data structure in the New Query wizard)
3. Write a SQL statement to retrieve the data, for example:
   SELECT City, CompanyName FROM Customers
4. Click the "Execute" button to load Cosmos DB data into Redash via CData Connect
5. Use the Visualization Editor to create and analyze graphs from Cosmos DB data
6. You can schedule the query to refresh and update the visualization periodically

SQL Access to Cosmos DB Data from Cloud Applications

At this point, you have a direct, cloud-to-cloud connection to Cosmos DB data from Redash. You can create new visualizations, build dashboards, and more. For more information on gaining SQL access to data from more than 100 SaaS, Big Data, and NoSQL sources from cloud applications like Redash, refer to our Connect Server page.