Learn more
 

Ready to get started?

Download a free trial of the Cosmos DB Data Provider to get started:

 Download Now

Learn more:

Cosmos DB Icon Cosmos DB ADO.NET Provider

Rapidly create and deploy powerful .NET applications that integrate with Cosmos DB document databases.

In this article

Related articles

DataBind Charts to Cosmos DB Data


Use the standard ADO.NET procedures for databinding to provide bidirectional access to Cosmos DB data from controls in the Visual Studio toolbox. This article demonstrates a graphical approach using wizards in Visual Studio, as well as how to databind with only a few lines of code.

DataBinding facilitates two-way interaction with data through UI controls. Using the CData ADO.NET Provider for Cosmos DB streamlines the process of binding Cosmos DB data to Windows Forms and Web controls within Visual Studio. In this article, we will demonstrate using wizards to establish a binding between Cosmos DB data and a chart that dynamically updates. Additionally, the code walk-through section will guide you through the creation of a chart using just 10 lines of code.

DataBind to a Chart

DataBinding consists of three steps: Instantiate the control, configure the data source, and databind.

Configure the Connection and Select Database Objects

To create a chart control and establish a connection to Cosmos DB, follow the steps outlined below using the Data Source Configuration Wizard. Within the wizard, you'll have the option to choose the specific Cosmos DB entities you wish to bind to.

  1. In a Windows Forms project, drag and drop a Chart control from the toolbox to the form. In the Data section of the Chart properties, select DataSource and then select Add Project Data Source from the menu.
  2. In the Data Source Configuration Wizard that appears, select Database -> Dataset.
  3. In the Choose Your Data Connection step, click New Connection.

  4. In the Add Connection dialog, click Change to select the CData Cosmos DB Data Source.

    Below is a typical connection string:

    AccountEndpoint=myAccountEndpoint;AccountKey=myAccountKey;

    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 connection, 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.

  5. Choose the database objects you want to work with. This example uses the Customers table.

DataBind

After adding the data source and selecting database objects, you can bind the objects to the chart. This example assigns the x-axis to City and the y-axis to CompanyName.

  1. In the Chart properties, click the button in the Series property to open the Series Collection Editor.
  2. In the Series properties, select the columns you want for the x- and y-axes: Select columns from the menu in the XValueMember and YValueMember properties.

The chart is now databound to the Cosmos DB data. Run the chart to display the current data.

Code Walk-through

DataBinding to Cosmos DB data requires only a few lines of code and can be completed in three easy steps.

  1. Connect to Cosmos DB.
  2. Create the CosmosDBDataAdapter to execute the query and create a DataSet to be filled with its results.
  3. DataBind the result set to the chart.

Below is the complete code:

CosmosDBConnection conn = new CosmosDBConnection("AccountEndpoint=myAccountEndpoint;AccountKey=myAccountKey;"); CosmosDBCommand comm = new CosmosDBCommand("SELECT City, CompanyName FROM Customers", conn); CosmosDBDataAdapter da = new CosmosDBDataAdapter(comm); DataSet dataset = new DataSet(); da.Fill(dataset); chart1.DataSource = dataset; chart1.Series[0].XValueMember = "City"; chart1.Series[0].YValueMembers = "CompanyName"; // Insert code for additional chart formatting here. chart1.DataBind();