ElasticSearch Connector for SSIS

Read / write ElasticSearch data inside your app; perform many ElasticSearch operations without coding, just use easy to use high performance API Connector for ElasticSearch

In this article you will learn how to quickly and efficiently integrate ElasticSearch data in SSIS without coding. We will use high-performance ElasticSearch Connector to easily connect to ElasticSearch and then access the data inside SSIS.

Let's follow the steps below to see how we can accomplish that!

Download Documentation

ElasticSearch Connector for SSIS is based on ZappySys API Connector Framework which is a part of SSIS PowerPack. It is a collection of high-performance SSIS connectors that enable you to integrate data with virtually any data provider supported by SSIS, including SQL Server. SSIS PowerPack supports various file formats, sources and destinations, including REST/SOAP API, SFTP/FTP, storage services, and plain files, to mention a few (if you are new to SSIS and SSIS PowerPack, find out more on how to use them).

Video Tutorial - Integrate ElasticSearch data in SSIS

This video covers the following topics and more, so please watch carefully. After watching the video, follow the steps outlined in this article:

How to download and install the required PowerPack for ElasticSearch integration in SSIS
How to configure the connection for ElasticSearch
Features of the ZappySys API Source (Authentication / Query Language / Examples / Driver UI)
How to use the ElasticSearch in SSIS

Prerequisites

Before we begin, make sure the following prerequisites are met:

SSIS designer installed. Sometimes it is referred as BIDS or SSDT (download it from Microsoft).
Basic knowledge of SSIS package development using Microsoft SQL Server Integration Services.
SSIS PowerPack is installed (if you are new to SSIS PowerPack, then get started!).

Read data from ElasticSearch in SSIS (Export data)

In this section we will learn how to configure and use ElasticSearch Connector in API Source to extract data from ElasticSearch.

Begin with opening Visual Studio and Create a New Project.
Select Integration Service Project and in new project window set the appropriate name and location for project. And click OK.

In the new SSIS project screen you will find the following:
- SSIS ToolBox on left side bar
- Solution Explorer and Property Window on right bar
- Control flow, data flow, event Handlers, Package Explorer in tab windows
- Connection Manager Window in the bottom
Note: If you don't see ZappySys SSIS PowerPack Task or Components in SSIS Toolbox, please refer to this help link.
Now, Drag and Drop SSIS Data Flow Task from SSIS Toolbox. Double click on the Data Flow Task to see Data Flow designer.
From the SSIS toolbox drag and API Source (Predefined Templates) on the data flow designer surface, and double click on it to edit it:
Select New Connection to create a new connection:
Use a preinstalled ElasticSearch Connector from Popular Connector List or press Search Online radio button to download ElasticSearch Connector. Once downloaded simply use it in the configuration:

ElasticSearch

Now it's time to configure authentication. Firstly, configure authentication settings in ElasticSearch service and then proceed by configuring API Connection Manager. Start by expanding an authentication type:

Basic Authentication (UserId/Password)

ElasticSearch authentication

For Local / Hosted Instance by you

Get your userid / password and enter on the connection UI

For Managed Instance (By Bonsai search)

If your instance is hosted by bonsai then perform these steps to get your credentials for API call

Go to https://app.bonsai.io/clusters/{your-instance-id}/tokens
Copy Access Key and Access Secret and enter on the connection UI. Click Test connection.
If your Cluster has no data you can generate sample data by visiting this URL and click Add Sample Data https://{your-cluster-id}.apps.bonsaisearch.net/app/home#/tutorial_directory

API Connection Manager configuration

Just perform these simple steps to finish authentication configuration:

Set Authentication Type to Basic Authentication (UserId/Password) [Http]
Optional step. Modify API Base URL if needed (in most cases default will work).
Fill in all the required parameters and set optional parameters if needed.
Finally, hit OK button:

ElasticSearch

Basic Authentication (UserId/Password) [Http]

http://localhost:9200

Optional Parameters
User Name (or Access Key)
Password (or Access Secret)
Ignore certificate related errors

Windows Authentication (No Password)

ElasticSearch authentication

No instructions available.

API Connection Manager configuration

Just perform these simple steps to finish authentication configuration:

Set Authentication Type to Windows Authentication (No Password) [Http]
Optional step. Modify API Base URL if needed (in most cases default will work).
Fill in all the required parameters and set optional parameters if needed.
Finally, hit OK button:

ElasticSearch

Windows Authentication (No Password) [Http]

http://localhost:9200

Optional Parameters
Ignore certificate related errors

Select the desired endpoint, change/pass the properties values, and click on Preview Data button to make the API call.

API Source - 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
That's it! We are done! Just in a few clicks we configured the call to ElasticSearch using ElasticSearch Connector.

You can load the source data into your desired destination using the Upsert Destination , which supports SQL Server, PostgreSQL, and Amazon Redshift. We also offer other destinations such as CSV , Excel , Azure Table , Salesforce , and more . You can check out our SSIS PowerPack Tasks and components for more options. (*loaded in Trash Destination)

Write data to ElasticSearch using SSIS (Import data)

In this section we will learn how to configure and use ElasticSearch Connector in the API Destination to write data to ElasticSearch.

Video tutorial

This video covers following and more so watch carefully. After watching this video follow the steps described in this article.

How to download SSIS PowerPack for ElasticSearch integration in SSIS
How to configure connection for ElasticSearch
How to write or lookup data to ElasticSearch
Features about SSIS API Destination
Using ElasticSearch Connector in SSIS

Step-by-step instructions

In upper section we learned how to read data, now in this section we will learn how to configure ElasticSearch in the API Source to POST data to the ElasticSearch.

Read the data from the source, being any desired source component. In example we will use ZappySys Dummy Data Source component.
From the SSIS Toolbox drag and drop API Destination (Predefined Templates) on the Data Flow Designer surface and connect source component with it, and double click to edit it.
Select New Connection to create a new connection:

API Destination - 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
Use a preinstalled ElasticSearch Connector from Popular Connector List or press Search Online radio button to download ElasticSearch Connector. Once downloaded simply use it in the configuration:

ElasticSearch

Proceed with selecting the desired Authentication Type. Then select API Base URL (in most cases default one is the right one). Finally, fill in all the required parameters and set optional parameters if needed. You may press a link Steps to Configure which will help set certain parameters. More info is available in Authentication section.

Basic Authentication (UserId/Password)

ElasticSearch authentication

For Local / Hosted Instance by you

Get your userid / password and enter on the connection UI

For Managed Instance (By Bonsai search)

If your instance is hosted by bonsai then perform these steps to get your credentials for API call

Go to https://app.bonsai.io/clusters/{your-instance-id}/tokens
Copy Access Key and Access Secret and enter on the connection UI. Click Test connection.
If your Cluster has no data you can generate sample data by visiting this URL and click Add Sample Data https://{your-cluster-id}.apps.bonsaisearch.net/app/home#/tutorial_directory

API Connection Manager configuration

Just perform these simple steps to finish authentication configuration:

Set Authentication Type to Basic Authentication (UserId/Password) [Http]
Optional step. Modify API Base URL if needed (in most cases default will work).
Fill in all the required parameters and set optional parameters if needed.
Finally, hit OK button:

ElasticSearch

Basic Authentication (UserId/Password) [Http]

http://localhost:9200

Optional Parameters
User Name (or Access Key)
Password (or Access Secret)
Ignore certificate related errors

Windows Authentication (No Password)

ElasticSearch authentication

No instructions available.

API Connection Manager configuration

Just perform these simple steps to finish authentication configuration:

Set Authentication Type to Windows Authentication (No Password) [Http]
Optional step. Modify API Base URL if needed (in most cases default will work).
Fill in all the required parameters and set optional parameters if needed.
Finally, hit OK button:

ElasticSearch

Windows Authentication (No Password) [Http]

http://localhost:9200

Optional Parameters
Ignore certificate related errors

Select the desired endpoint, change/pass the properties values, and go to the Mappings tab to map the columns.

API Destination - 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
Finally, map the desired columns:

API Destination - 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
That's it; we successfully configured the POST API Call. In a few clicks we configured the ElasticSearch API call using ZappySys ElasticSearch Connector

Load ElasticSearch data into SQL Server using Upsert Destination (Insert or Update)

Once you configured the data source, you can load ElasticSearch data into SQL Server using Upsert Destination.

Upsert Destination can merge or synchronize source data with the target table. It supports Microsoft SQL Server, PostgreSQL, and Redshift databases as targets. Upsert Destination also supports very fast bulk upsert operation along with bulk delete.

Upsert operation - a database operation which performs INSERT or UPDATE SQL commands based on record's existence condition in the target table. It inserts records that don't have matching records in the target table or updates them, if they do, by matching them by key columns.

Upsert Destination supports INSERT, UPDATE, and DELETE operations, so it is similar to SQL Server's MERGE command, except it can be used directly in SSIS package.

From the SSIS Toolbox drag-and-drop Upsert Destination component onto the Data Flow designer background.
Connect your SSIS source component to Upsert Destination.
Double-click on Upsert Destination component to open configuration window.
Start by selecting the Action from the list.
Next, select the desired target connection or create one by clicking <New [provider] Connection> menu item from the Target Connection dropdown.
Then select a table from the Target Table list or click New button to create a new table based on the source columns.
Continue by checking Insert and Update options according to your scenario (e.g. if Update option is unchecked, no updates will be made).
Finally, click Map All button to map all columns and then select the Key columns to match the columns on:
Click OK to save the configuration.
Run the package and ElasticSearch data will be merged with the target table in SQL Server, PostgreSQL, or Redshift:
Done!

Deploy and schedule SSIS package

After you are done creating SSIS package, most likely, you want to deploy it to SQL Server Catalog and run it periodically. Just follow the instructions in this article:

How to design, debug, deploy, schedule SSIS Package (In SQL Agent and Catalog)

Running SSIS package in Azure Data Factory (ADF)

To use SSIS PowerPack in ADF, you must first prepare Azure-SSIS Integration Runtime. Follow this link for detailed instructions:

Preparing ADF instance to use SSIS PowerPack

Actions supported by ElasticSearch Connector

Learn how to perform common ElasticSearch actions directly in SSIS with these how-to guides:

Centralized data access via Data Gateway

In some situations, you may need to provide ElasticSearch data access to multiple users or services. Configuring the data source on a Data Gateway creates a single, centralized connection point for this purpose.

This configuration provides two primary advantages:

Centralized data access
The data source is configured once on the gateway, eliminating the need to set it up individually on each user's machine or application. This significantly simplifies the management process.
Centralized access control
Since all connections route through the gateway, access can be governed or revoked from a single location for all users.

	Data Gateway	Local ODBC data source
Simple configuration
Installation	Single machine	Per machine
Connectivity	Local and remote	Local only
Connections limit	Limited by License	Unlimited
Central data access
Central access control
More flexible cost

If you need any of these requirements, you will have to create a data source in Data Gateway to connect to ElasticSearch, and to create an ODBC data source to connect to Data Gateway in SSIS.

Let's not wait and get going!

Creating ElasticSearch data source in Gateway

In this section we will create a data source for ElasticSearch in Data Gateway. Let's follow these steps to accomplish that:

Download and install ODBC PowerPack.
Search for gateway in Windows Start Menu and open ZappySys Data Gateway Configuration:
Go to Users tab and follow these steps to add a Data Gateway user:
- Click Add button
- In Login field enter username, e.g., john
- Then enter a Password
- Check Is Administrator checkbox
- Click OK to save
Now we are ready to add a data source:
- Click Add button
- Give Datasource a name (have it handy for later)
- Then select Native - ZappySys API Driver
- Finally, click OK
ElasticsearchDSN

ZappySys API Driver
When the ZappySys API Driver configuration window opens, configure the Data Source the same way you configured it in ODBC Data Sources (64-bit), in the beginning of this article.
Very important step. Now, after creating or modifying the data source make sure you:
- Click the Save button to persist your changes.
- Hit Yes, once asked if you want to restart the Data Gateway service.
This will ensure all changes are properly applied:

Skipping this step may result in the new settings not taking effect and, therefore you will not be able to connect to the data source.

Creating ODBC data source for Data Gateway

In this part we will create ODBC data source to connect to Data Gateway from SSIS. To achieve that, let's perform these steps:

Open ODBC Data Sources (x64):
Create a User data source (User DSN) based on ODBC Driver 17 for SQL Server:

ODBC Driver 17 for SQL Server

If you don't see ODBC Driver 17 for SQL Server driver in the list, choose a similar version driver.
Then set a Name of the data source (e.g. Gateway) and the address of the Data Gateway:

GatewayDSN

localhost,5000

Make sure you separate the hostname and port with a comma, e.g. localhost,5000.
Proceed with authentication part:
- Select SQL Server authentication
- In Login ID field enter the user name you used in Data Gateway, e.g., john
- Set Password to the one you configured in Data Gateway
Then set the default database property to ElasticsearchDSN (the one we used in Data Gateway):

ElasticsearchDSN
Continue by checking Trust server certificate option:
Once you do that, test the connection:
If connection is successful, everything is good:
Done!

We are ready to move to the final step. Let's do it!

Accessing data in SSIS via Data Gateway

Finally, we are ready to read data from ElasticSearch in SSIS via Data Gateway. Follow these final steps:

Go back to SSIS.
From the SSIS toolbox drag and drop ODBC Source on the dataflow designer surface:
Double-click on ODBC Source component to configure it.
Click on New... button, it will open Configure ODBC Connection Manager window. Once it opens, click on New... button to create a new ODBC connection to ElasticSearch ODBC data source:
Then choose the data source from the list and click Test Connection button. If the connection test is successful, close the window, and then click OK button to finish the configuration:

GatewayDSN
Read the data the same way we discussed at the beginning of this article.
That's it!

Now you can connect to ElasticSearch data in SSIS via the Data Gateway.

If you are asked for authentication details, use Database authentication or SQL Authentication option and enter credentials you used when configuring Data Gateway, e.g. john and your password.