Ready to get started?

Download a free trial of the Cosmos DB ODBC Driver to get started:

 Download Now

Learn more:

Cosmos DB Icon Cosmos DB ODBC Driver

The Cosmos DB ODBC Driver is a powerful tool that allows you to connect with live Cosmos DB document databases, directly from any applications that support ODBC connectivity.

Access Cosmos DB like you would a database - read, write, and update through a standard ODBC Driver interface.

Build Dashboards with Cosmos DB Data in Dundas BI



Create dynamic dashboards and perform analytics based on Cosmos DB data in Dundas BI.

The CData ODBC Driver for Cosmos DB enables access to live data from Cosmos DB under the ODBC standard, allowing you work with Cosmos DB data in a wide variety of BI, reporting, and ETL tools and directly, using familiar SQL queries. This article shows how to connect to Cosmos DB data as a generic ODBC Data Provider and create charts, reports, and dashboards based on Cosmos DB data in Dundas BI.

Connect to Cosmos DB Data

  1. If you have not already done so, provide values for the required connection properties in the data source name (DSN). You can configure the DSN using the built-in Microsoft ODBC Data Source Administrator. This is also the last step of the driver installation. See the "Getting Started" chapter in the Help documentation for a guide to using the Microsoft ODBC Data Source Administrator to create and configure a DSN.

    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.

    When you configure the DSN, you may also want to set the Max Rows connection property. This will limit the number of rows returned, which is especially helpful for improving performance when designing reports and visualizations.

  2. Open the Dundas BI interface, open the menu, and click New Data Connector.
  3. Configure the Dundas BI Data Connector:
    • Name the Data Connector.
    • Select "ODBC generic" as the Data Provider.
    • Check the "Use System DSN" checkbox.
    • Select the appropriate System DSN.

Add Cosmos DB Data to a Dashboard

You are now ready to create a dashboard with Cosmos DB data.

  1. Navigate to the Home page.
  2. Click Explore Data.
  3. Expand the appropriate Data Connector.
  4. Drag the relevant data from the Connector to the panel.
    • You can select an entire "table" to add, but you may need to remove Measures/Rows from the Metric Set to build an appropriate visualization. Alternatively, you can select only the fields you wish to include in the visualization.
    • With the fields selected, you can add any filters or conditions on the Measures and Rows, further customizing the visualization.
  5. Click Re-visualize from the menu bar and select the appropriate visualization for the data.
  6. Click Add To New Dashboard to add the visualization to a new dashboard.
  7. Configure the dashboard, creating dynamic visualizations of Cosmos DB data.