SQL Server 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.
Video Tutorial - Integrate
ElasticSearch data in SQL Server
This video covers following and more so watch carefully. After watching this video follow the steps described in this article.
- How to download / install required driver for
ElasticSearchintegration in SQL Server
- How to configure connection for
- Features about
ElasticSearchDriver (Authentication / Query Language / Examples / Driver UI)
ElasticSearchConnection in SQL Server
Create Data Source in ZappySys Data Gateway based on ZappySys API Driver
Download and install ZappySys ODBC PowerPack.
Search for gateway in start menu and Open ZappySys Data Gateway:
Go to Users Tab to add our first Gateway user. Click Add; we will give it a name tdsuser and enter password you like to give. Check Admin option and click OK to save. We will use these details later when we create linked server:
Now we are ready to add a data source. Click Add, give data source a name (Copy this name somewhere, we will need it later) and then select Native - ZappySys API Driver. Finally, click OK.ElasticSearchDSN
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:9200
Required 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 SQL Server from the ZappySys Data Gateway data source
To read the data in SQL Server the first thing you have to do is create a Linked Server. Go to SQL Server Management Studio and configure it in a similar way:
Then click on Security option and configure username we created in ZappySys Data Gateway in one of the previous steps:
Finally, open a new query and execute a query we saved in one of the previous steps:
SELECT * FROM OPENQUERY([MY_LINKED_SERVER_NAME], 'SELECT * FROM Products');
So far we have assumed that Gateway is running on the same machine as SQL Server. However there will be a case when ZappySys ODBC PowerPack is installed on a different machine than SQL Server. In such case you may have to perform additional Firewall configurations. On most computers firewall settings wont allow outside traffic to ZappySys Data Gateway. In such case perform following steps to allow other machines to connect to Gateway.Method-1 (Preferred)
If you are using newer version of ZappySys Data Gateway then adding firewall rule is just a single click.
- Search for gateway in start menu and open ZappySys Data Gateway.
- Go to Firewall Tab and click Add Firewall Rule button like below. This will create Firewall rule to all Inbound Traffic on Port 5000 (Unless you changed it).
- Search for Windows Firewall Advanced Security in start menu.
- Under Inbound Rules > Right click and click [New Rule] >> Click Next
- Select Port on Rule Type >> Click Next
- Click on TCP and enter port number under specified local port as 5000 (use different one if you changed Default port) >> Click Next
- Select Profile (i.e. Private, Public) >> Click Next
- Enter Rule name [i.e. ZappySys Data Gateway – Allow Inbound ] >> Click Next
- Click OK to save the rule
OPENQUERY vs EXEC (handling larger SQL text)
So far we have seen examples of using OPENQUERY. It allows us to send pass-through query at remote server. The biggest limitation of OPENQUERY is it doesn't allow you to use variables inside SQL so often we have to use unpleasant looking dynamic SQL (Lots of tick, tick …. and escape hell). Well there is good news. With SQL 2005 and later you can use
EXEC(your_sql) AT your_linked_server syntax .
Disadvantage of EXEC AT is you cannot do SELECT INTO like OPENQUERY. Also you cannot perform JOIN like below in EXEC AT
However you can always do INSERT INTO MyTable EXEC(…) AT LINKEDSRV. So table must exists when you do that way. Here is how to use it. To use EXEC AT you must turn on RPC OUT option. Notice how we used variable in SQL to make it dynamic. This is much cleaner than previous approach we saw.
SELECT a.* FROM OPENQUERY(ls_json,'select * from $') a JOIN OPENQUERY(ls_json,'select * from $') b ON a.id=b.id;
Here is the difference between OPENQUERY vs EXEC approaches:
USE [master] GO EXEC master.dbo.sp_addlinkedserver @server = N'ls_Json', @srvproduct=N'', @provider=N'SQLNCLI', @datasrc=N'localhost,5000', @provstr=N'Network Library=DBMSSOCN;', @catalog=N'JsonApi'; EXEC master.dbo.sp_addlinkedsrvlogin @rmtsrvname=N'ls_Json',@useself=N'False',@locallogin=NULL,@rmtuser=N'tdsuser',@rmtpassword='########'; GO EXEC sp_serveroption 'ls_Json', 'rpc out', true; go declare @tbl varchar(100)='$'; EXEC('select * from ' + @tbl ) AT ls_Json;
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 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.
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"
ConclusionIn this article we discussed how to connect to ElasticSearch in SQL Server and integrate data without any coding. Click here to Download ElasticSearch Connector for SQL Server 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).
Actions supported by ElasticSearch ConnectorElasticSearch 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.
|Enter Document ID||
|Index Name (choose one --OR-- enter * --OR-- comma seperated names)||
|Enter Query (JSON Format)||
Other App Integration scenarios for ElasticSearch
Other API Connectors for SQL Server
How to connect ElasticSearch in SQL Server?
How to get ElasticSearch data in SQL Server?
How to read ElasticSearch data in SQL Server?
How to load ElasticSearch data in SQL Server?
How to import ElasticSearch data in SQL Server?
How to pull ElasticSearch data in SQL Server?
How to push data to ElasticSearch in SQL Server?
How to write data to ElasticSearch in SQL Server?
How to POST data to ElasticSearch in SQL Server?
Call ElasticSearch API in SQL Server
Consume ElasticSearch API in SQL Server
ElasticSearch SQL Server Automate
ElasticSearch SQL Server Integration
Integration ElasticSearch in SQL Server
Consume real-time ElasticSearch data in SQL Server
Consume realtime ElasticSearch API data in SQL Server
ElasticSearch ODBC Driver | ODBC Driver for ElasticSearch | ODBC ElasticSearch Driver | SSIS ElasticSearch Source | SSIS ElasticSearch Destination
Connect ElasticSearch in SQL Server
Load ElasticSearch in SQL Server
Load ElasticSearch data in SQL Server
Read ElasticSearch data in SQL Server
ElasticSearch API Call in SQL Server