C# ElasticSearch API Connector In this article you will learn, how to integrate ElasticSearch data to C# without coding in few clicks (Live / Bi-directional connection to ElasticSearch). Read / write ElasticSearch data inside your app; perform many ElasticSearch operations without coding, just use easy to use high performance API Connector for ElasticSearch Using ElasticSearch API Connector you will be able to connect, read and write data from within C#. Let's take a look at the steps below to see how exactly to accomplish that. Download  Help File  Buy  Driver mentioned in this article is part of ODBC PowerPack which is a collection of high-performance Drivers for various API data source (i.e. REST API, JSON, XML, CSV, Amazon S3 and many more). Using familiar SQL query language you can make live connection and read/write data from API sources or JSON / XML / CSV Files inside SQL Server (T-SQL) or your favorite Reporting (i.e. Power BI, Tableau, Qlik, SSRS, MicroStrategy, Excel, MS Access), ETL Tools (i.e. Informatica, Talend, Pentaho, SSIS). You can also call our drivers from programming languages such as JAVA, C#, Python, PowerShell etc. If you are new with ODBC and ZappySys ODBC PowerPack then check below links to get started. ODBC PowerPack - System Requirements and Installation Getting Started - Using ODBC PowerPack ODBC API Driver Help File

See also Connect ElasticSearch in SSIS Connect ElasticSearch in SQL Server Connect ElasticSearch in Power BI Connect ElasticSearch in SSRS Connect ElasticSearch in Informatica Connect ElasticSearch in MS Access Connect ElasticSearch in MS Excel Connect ElasticSearch in SSAS Connect ElasticSearch in Python Connect ElasticSearch in JAVA Connect ElasticSearch in Tableau Connect ElasticSearch in SAP Crystal Reports Connect ElasticSearch in ODBC

Create ODBC Data Source (DSN) based on ZappySys API Driver

To get data from ElasticSearch using C# we first need to create a DSN - Data Source - which will access data from ElasticSearch, which later will be able to get using C#. Perform these steps:

1. Install ZappySys ODBC PowerPack.

2. Open ODBC Data Sources (x64):
   

3. Create a User Data Source (User DSN) based on ZappySys API Driver:

   

   You should create System DSN if client application is launched under Windows System Account, e.g. as a Windows Service.
   Launch ODBC Data Sources 32-bit version in case your client application is a 32-bit (x86) application (required only for System DSN).

4. When a window appears, firstly give your data source a name if you haven't done that already, then select "ElasticSearch" from the list of Popular Connectors. If "ElasticSearch" is not present in the list, then click "Search Online" and download it. Then set the path to the one where you downloaded it. Finally, hit Continue >> button to continue configuring DSN:

   ElasticSearchDSN

   ElasticSearch

   

5. Another window appears and it's time to configure the Connection Manager. Firstly, select Authentication Type, e.g. Token Authentication. Then select API Base URL (in most cases default one is the right one). More info is available in Authentication section.

   And finally, fill in all the required parameters and set optional parameters if needed.:

   ElasticSearchDSN

   ElasticSearch

   Default [Http]

   http://localhost:9200

   Required Parameters
   Optional Parameters
   UserName	Fill in the parameter...
   Password	Fill in the parameter...

   

6. Once you configured a data source, you can preview data. Hit Preview tab, and use similar settings to preview data:
   

7. Click OK to finish creating the data source

Read data in C# from the DSN

1. Create a fresh new Console project and use this code to get the data:
   

   "ElasticSearchDSN"

   

2. Hit F5 to run the code and read the data:
   

3. Here is program's code in text format:

   
   using System;
   using System.Data.Odbc;
   
   namespace ConsoleApp {
       class Program {
           static void Main() {
               var dsn = "ElasticSearchDSN";
               using (var conn = new OdbcConnection(String.Format("DSN={0}", dsn)))
               {
                   conn.Open();
                   var cmd = new OdbcCommand("SELECT * FROM Products", conn);
                   var rdr = cmd.ExecuteReader();
                   while (rdr.Read())
                   {
                       for (int i = 0; i < rdr.FieldCount; i++)
                       {
                               Console.Write("{0}\t", rdr[i]);
                       }
                       Console.WriteLine();
                   }
               }
               Console.ReadKey();
           }
       }
   }
   
   

4. If you want to avoid to be dependent on a DSN name and creating multiple DSNs for each platform (x86, x64), then you can use a fully qualified connection string. Simply go to your DSN and copy the Connection String . Then in your C# code use Connection String when initializing OdbcConnection object, for example:

   using (var conn = new OdbcConnection("DRIVER={ZappySys API Driver};ServiceUrl=https://services.odata.org/V3/Northwind/Northwind.svc;Provider=OData;AuthName=Http;"))
    {
        // ...
    }
   

   How to overcome long ConnectionString Issue?

   If you copy ConnectionString from UI and if you have long RefreshToken=xxxxxxxxxxxxxxxxxx...xxx, very long more than 1000 chars. It can cause the issue.

   To overcome from a such issue you can supply RefreshToken via file actually. You just need to cut the RefreshToken and paste it in some text file and save it and pass that file path instead of the RefreshToken.

   using (var conn = new OdbcConnection("Driver={ZappySys API Driver};RefreshToken=xxxxxx...xxx;ServiceUrl=xxx...;"))
    {
        // ...
    }
   

   You can use that file path in the ConnectionString, remove the RefreshToken=xxxxxx...xxx; attribute from the ConnectionString and you can pass RefreshTokenFile=c:\my_refresh_token.txt;

   using (var conn = new OdbcConnection("Driver={ZappySys API Driver};RefreshTokenFile={{YourRefreshTokenFilePath}};ServiceUrl=...;"))
     {
        // ...
     }
   

Create Custom Store Procedure in ZappySys Driver

You can create procedures to encapsulate custom logic and then only pass handful parameters rather than long SQL to execute your API call.

Steps to create Custom Store Procedure in ZappySys Driver. You can insert Placeholders anywhere inside Procedure Body. Read more about placeholders here

1. Go to Custom Objects Tab and Click on Add button and Select Add Procedure:
   

2. Enter the desired Procedure name and click on OK:
   

3. Select the created Store Procedure and write the your desired store procedure and Save it and it will create the custom store procedure in the ZappySys Driver:
   Here is an example stored procedure for ZappySys Driver. You can insert Placeholders anywhere inside Procedure Body. Read more about placeholders here
   

   CREATE PROCEDURE [usp_get_orders]
       @fromdate = '<<yyyy-MM-dd,FUN_TODAY>>'
    AS
       SELECT * FROM Orders where OrderDate >= '<@fromdate>';
   

   
   

4. That's it now go to Preview Tab and Execute your Store Procedure using Exec Command. In this example it will extract the orders from the date 1996-01-01:
   

   Exec usp_get_orders '1996-01-01';

   
   

Create Custom Virtual Table in ZappySys Driver

ZappySys API Drivers support flexible Query language so you can override Default Properties you configured on Data Source such as URL, Body. This way you don't have to create multiple Data Sources if you like to read data from multiple EndPoints. However not every application support supplying custom SQL to driver so you can only select Table from list returned from driver.

Many applications like MS Access, Informatica Designer wont give you option to specify custom SQL when you import Objects. In such case Virtual Table is very useful. You can create many Virtual Tables on the same Data Source (e.g. If you have 50 URLs with slight variations you can create virtual tables with just URL as Parameter setting.

1. Go to Custom Objects Tab and Click on Add button and Select Add Table:
   

2. Enter the desired Table name and click on OK:
   

3. And it will open the New Query Window Click on Cancel to close that window and go to Custom Objects Tab.

4. Select the created table, Select Text Type AS SQL and write the your desired SQL Query and Save it and it will create the custom table in the ZappySys Driver:
   Here is an example SQL query for ZappySys Driver. You can insert Placeholders also. Read more about placeholders here
   

   SELECT
     "ShipCountry",
     "OrderID",
     "CustomerID",
     "EmployeeID",
     "OrderDate",
     "RequiredDate",
     "ShippedDate",
     "ShipVia",
     "Freight",
     "ShipName",
     "ShipAddress",
     "ShipCity",
     "ShipRegion",
     "ShipPostalCode"
   FROM "Orders"
   Where "ShipCountry"='USA'

   
   

5. That's it now go to Preview Tab and Execute your custom virtual table query. In this example it will extract the orders for the USA Shipping Country only:
   

   SELECT * FROM "vt__usa_orders_only"

   
   

Conclusion

In this article we discussed how to connect to ElasticSearch in C# and integrate data without any coding. Click here to Download ElasticSearch Connector for C# and try yourself see how easy it is. If you still have any question(s) then ask here or simply click on live chat icon below and ask our expert (see bottom-right corner of this page).

Download ElasticSearch Connector for C# Documentation 

Actions supported by ElasticSearch Connector

ElasticSearch Connectors support following actions for REST API integration. If some actions are not listed below then you can easily edit Connector file and enhance out of the box functionality.

Other App Integration scenarios for ElasticSearch

Other API Connectors for C#

Download ElasticSearch Connector for C# Documentation 

Common Searches: