DataBind Charts to Elasticsearch Data

Ready to get started?

Download for a free trial:

Download Now

Learn more:

Elasticsearch ADO.NET Provider

Rapidly create and deploy powerful .NET applications that integrate with Elasticsearch.



Use the standard ADO.NET procedures for databinding to provide bidirectional access to Elasticsearch 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 enables bidirectional access to data from UI controls. You can use the CData ADO.NET Provider for Elasticsearch to easily databind Elasticsearch data to Windows Forms and Web controls in Visual Studio. This article shows how to use wizards to databind Elasticsearch data to a chart that reflects any changes. The code walk-through section shows how to create a chart in 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

Follow the procedure below to use the Data Source Configuration Wizard to create a chart control and the connection to Elasticsearch. In the wizard, you can select the Elasticsearch entities you want to databind.

  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 Elasticsearch Data Source.

    Below is a typical connection string:

    Server=127.0.0.1;Port=9200;User=admin;Password=123456;

    Set the Server and Port connection properties to connect. To authenticate, set the User and Password properties, PKI (public key infrastructure) properties, or both. To use PKI, set the SSLClientCert, SSLClientCertType, SSLClientCertSubject, and SSLClientCertPassword properties.

    The data provider uses X-Pack Security for TLS/SSL and authentication. To connect over TLS/SSL, prefix the Server value with 'https://'. Note: TLS/SSL and client authentication must be enabled on X-Pack to use PKI.

    Once the data provider is connected, X-Pack will then perform user authentication and grant role permissions based on the realms you have configured.

    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 Orders 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 OrderName and the y-axis to Freight.

  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 Elasticsearch data. Run the chart to display the current data.

Code Walk-through

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

  1. Connect to Elasticsearch.
  2. Create the ElasticsearchDataAdapter 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:

ElasticsearchConnection conn = new ElasticsearchConnection("Server=127.0.0.1;Port=9200;User=admin;Password=123456;"); ElasticsearchCommand comm = new ElasticsearchCommand("SELECT Orders.Freight, Customers.ContactName FROM Customers INNER JOIN Orders ON Customers.CustomerId=Orders.CustomerId", conn); ElasticsearchDataAdapter da = new ElasticsearchDataAdapter(comm); DataSet dataset = new DataSet(); da.Fill(dataset); chart1.DataSource = dataset; chart1.Series[0].XValueMember = "OrderName"; chart1.Series[0].YValueMembers = "Freight"; // Insert code for additional chart formatting here. chart1.DataBind();