MS Excel ElasticSearch API Connector
In this article you will learn, how to integrate 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. |
See also
|
Create ODBC Data Source (DSN) based on ZappySys API Driver
To get data from ElasticSearch using MS Excel we first need to create a DSN - Data Source - which will access data from ElasticSearch, which later will be able to get using MS Excel. Perform these steps:-
Install ZappySys ODBC PowerPack.
-
Open ODBC Data Sources (x64):
-
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). -
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:
ElasticSearchDSNElasticSearch -
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.:
ElasticSearchDSNDefault [Http]http://localhost:9200Required Parameters Optional Parameters UserName Fill in the parameter... Password Fill in the parameter... -
Once you configured a data source, you can preview data. Hit Preview tab, and use similar settings to preview data:
-
Click OK to finish creating the data source
Read data in Excel from the DSN
-
In Excel click Data, then select Get Data, proceed with From Other Sources and choose From ODBC item. This will get data from ODBC data source we created:
-
A small window opens, then simply select the data source you created in previous steps:
ElasticSearchDSN -
Most likely, you will be asked to authenticate to a newly created DSN. Just select Windows authentication option together with Use my current credentials option:
ElasticSearchDSN -
Finally, you will be asked to select a table or view to get data from. Select one and load the data!
-
Finally, use data extracted from ElasticSearch API in an Excel worksheet:
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
-
Go to Custom Objects Tab and Click on Add button and Select Add Procedure:
-
Enter the desired Procedure name and click on OK:
-
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>'
-
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 dont 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.
-
Go to Custom Objects Tab and Click on Add button and Select Add Table:
-
Enter the desired Table name and click on OK:
-
And it will open the New Query Window Click on Cancel to close that window and go to Custom Objects Tab.
-
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'
-
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 MS Excel and integrate data without any coding. Click here to Download ElasticSearch Connector for MS Excel 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).Other App Integration scenarios for ElasticSearch
Other API Connectors for MS Excel
How to connect ElasticSearch in MS Excel?
How to get ElasticSearch data in MS Excel?
How to read ElasticSearch data in MS Excel?
How to load ElasticSearch data in MS Excel?
How to import ElasticSearch data in MS Excel?
How to pull ElasticSearch data in MS Excel?
How to push data to ElasticSearch in MS Excel?
How to write data to ElasticSearch in MS Excel?
How to POST data to ElasticSearch in MS Excel?
Call ElasticSearch API in MS Excel
Consume ElasticSearch API in MS Excel
ElasticSearch MS Excel Automate
ElasticSearch MS Excel Integration
Integration ElasticSearch in MS Excel
Consume real-time ElasticSearch data in MS Excel
Consume realtime ElasticSearch API data in MS Excel
ElasticSearch ODBC Driver | ODBC Driver for ElasticSearch | ODBC ElasticSearch Driver | SSIS ElasticSearch Source | SSIS ElasticSearch Destination
Connect ElasticSearch in MS Excel
Load ElasticSearch in MS Excel
Load ElasticSearch data in MS Excel
Read ElasticSearch data in MS Excel
ElasticSearch API Call in MS Excel