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
You can use this connector to integrate ElasticSearch data inside SSIS and SQL Server. Let's take a look at the steps below to see how exactly to accomplish that.

Download  Help File 

Video Tutorial - Integrate ElasticSearch data in SSIS

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 ElasticSearch integration in SSIS
  • How to configure connection for ElasticSearch
  • Features about API Source (Authentication / Query Language / Examples / Driver UI)
  • Using ElasticSearch Connection in SSIS

Prerequisites

Before we perform steps listed in this article, you will need to make sure following prerequisites are met:
  1. SSIS designer installed. Sometimes it is referred as BIDS or SSDT (download it from Microsoft site).
  2. Basic knowledge of SSIS package development using Microsoft SQL Server Integration Services.
  3. Make sure ZappySys SSIS PowerPack is downloaded and installed (download it). Check Getting started section for more information.
  4. Optional (If you want to Deploy and Schedule ) - Deploy and Schedule SSIS Packages

How to read data from ElasticSearch in SSIS (Export data)

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

  1. Begin with opening Visual Studio and Create a New Project.

  2. Select Integration Service Project and in new project window set the appropriate name and location for project. And click OK.

  3. In the the new SSIS project screen you will find the following:

    1. SSIS ToolBox on left side bar
    2. Solution Explorer and Property Window on right bar
    3. Control flow, data flow, event Handlers, Package Explorer in tab windows
    4. Connection Manager Window in the bottom
    SSIS Project Screen
    Note: If you don't see ZappySys SSIS PowerPack Task or Components in SSIS Toolbox, please refer to this help link.

  4. Now, Drag and Drop SSIS Data Flow Task from SSIS Toolbox. Double click on the Data Flow Task to see Data Flow designer.
    SSIS Data Flow Task - Drag and Drop

  5. From the SSIS toolbox drag and API Source (Predefined Templates) on the data flow designer surface, and double click on it to edit it:
    SSIS API Source (Predefined Templates) - Drag and Drop

  6. Select New Connection to create a new connection:
    API Source - New Connection

  7. 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
    ElasticSearch Connector Selection

  8. 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.

    ElasticSearch
    Basic Authentication (UserId/Password) [Http]
    http://localhost:9200
    Required Parameters
    Optional Parameters
    UserName Fill in the parameter...
    Password Fill in the parameter...
    IgnoreSSLCertificateErrors Fill in the parameter...
    ZappySys Http Connection
    ElasticSearch
    Windows Authentication (No Password) [Http]
    http://localhost:9200
    Required Parameters
    Optional Parameters
    IgnoreSSLCertificateErrors Fill in the parameter...
    ZappySys Http Connection

  9. 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
    API Source - Select Endpoint

  10. That's it; we are done. In a few clicks we configured the call to ElasticSearch using ZappySys ElasticSearch Connector

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

Once you read data from the desired source, now let's see how to Load ElasticSearch data in SQL Server using Upsert Destination. Upsert Destination can Merge/Synchronize data from source to target for Microsoft SQL Server, PostgreSql and Redshift. It supports very fast Bulk Upsert (Update or Insert) operation along and Bulk delete.

  1. From the SSIS toolbox drag and drop Upsert Destination on the dataflow designer surface

  2. Connect our Source component to Upsert Destination

  3. Double click on Upsert Destination component to configure it.

  4. Select the desired Microsoft SQL Server/PostgreSql/Redshift Target Connection or click NEW to create new connection. Select Target Table or click NEW to create new table based on source columns.
    Configure SSIS Upsert Destination Connection - Loading data (REST / SOAP / JSON / XML /CSV) into SQL Server or other target using SSIS
    Configure SSIS Upsert Destination Connection - Loading data (REST / SOAP / JSON / XML /CSV) into SQL Server or other target using SSIS

  5. Set Action to Upsert => (insert if not matching in target else update). Select Target Connection and Target Table. Check on Insert and Update. Click on Map All to Mappings all columns and check on Only Primary Key columns.
    SSIS SQL Upsert option

  6. Click on OK to save Upsert Destination settings UI.

  7. That's it; we are done. Run the SSIS Package and it will read the data from the ElasticSearch and load the the data in the SQL Server/PostgreSql/Redshift.

Video Tutorial - Write or lookup data to ElasticSearch using SSIS

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

How to write or lookup data to ElasticSearch in SSIS (Import data)

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.

  1. Read the data from the source, being any desired source component. In example we will use ZappySys Dummy Data Source component.

  2. 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.
    SSIS API Destination (Predefined Templates) - Drag and Drop

  3. 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
    API Destination - New Connection

  4. 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
    ElasticSearch Connector Selection

  5. 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.

    ElasticSearch
    Basic Authentication (UserId/Password) [Http]
    http://localhost:9200
    Required Parameters
    Optional Parameters
    UserName Fill in the parameter...
    Password Fill in the parameter...
    IgnoreSSLCertificateErrors Fill in the parameter...
    ZappySys Http Connection
    ElasticSearch
    Windows Authentication (No Password) [Http]
    http://localhost:9200
    Required Parameters
    Optional Parameters
    IgnoreSSLCertificateErrors Fill in the parameter...
    ZappySys Http Connection

  6. 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
    API Destination - Select Endpoint

  7. Finally, map the 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
    API Destination - Columns Mapping

  8. That's it; we successfully configured the POST API Call. In a few clicks we configured the ElasticSearch API call using ZappySys ElasticSearch Connector

Conclusion

In this article we discussed how to connect to ElasticSearch in SSIS and integrate data without any coding. Click here to Download ElasticSearch Connector for SSIS 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 SSIS Documentation 

Actions supported by ElasticSearch Connector

ElasticSearch Connector 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.
 Create Index
Create a new index    [Read more...]
Parameter Description
New Index Name
 Delete Index
Delete an exising index    [Read more...]
Parameter Description
Index to delete
 List indexes
Lists indexes    [Read more...]
 List aliases
Lists aliases    [Read more...]
Parameter Description
 Get index metadata
Gets index metadata    [Read more...]
Parameter Description
Index Enter index name. If you set alias then select underlying alias Index here.
Alias
 Get documents from Index or Alias
Gets documents from Index or Alias    [Read more...]
 Get document by ID from Index or Alias
   [Read more...]
Parameter Description
Index Enter index name. If you set alias then select underlying alias Index here.
Alias
Enter Document ID
 Search / Query documents
Gets documents (Using JSON Query Language)    [Read more...]
 Count documents
   [Read more...]
Parameter Description
Index or Alias Name (choose one --OR-- enter * --OR-- comma seperated names) You can enter index name(s) for which you like to perform document count. Enter * (asterisk) to perform search across all indices or comma seperate list (i.e. myidx1,myidx2) or select one from the populated list.
Enter Query (JSON Format)
Option Value
All Records {"match_all": { } }
Record where comment or name contains TV word {"query_string": {"query": "comment:TV OR name:TV"} }
Record with comment field (attribute exists) {"query_string": {"query": "_exists_:comment"} }
 Insert documents
Insert documents    [Read more...]
Parameter Description
Index
Alias
 Update documents
Update documents    [Read more...]
Parameter Description
Index
Alias
 Upsert documents
Upserts documents    [Read more...]
Parameter Description
Index
Alias
 Delete documents
Deletes documents    [Read more...]
Parameter Description
Index
 Generic Request
This is generic endpoint. Use this endpoint when some actions are not implemented by connector. Just enter partial URL (Required), Body, Method, Header etc. Most parameters are optional except URL.    [Read more...]
Parameter Description
Url API URL goes here. You can enter full URL or Partial URL relative to Base URL. If it is full URL then domain name must be part of ServiceURL or part of TrustedDomains
Body Request Body content goes here
IsMultiPart Check this option if you want to upload file(s) (i.e. POST RAW file data) or send data using Multi-Part encoding method (i.e. Content-Type: multipart/form-data). Multi-Part request allows you to mix key/value and upload files in same request. On the other hand raw upload allows only single file upload (without any key/value) ==== Raw Upload (Content-Type: application/octet-stream) ===== To upload single file in raw mode check this option and specify full file path starting with @ sign in the Body (e.g. @c:\data\myfile.zip ) ==== Form-Data / Multipart Upload (Content-Type: multipart/form-data) ===== To treat your Request data as multi part fields you must specify key/value pairs separated by new lines into RequestData field (i.e. Body). Each key value pair is entered on new-line and key/value are separated using equal sign (=). Preceding and trailing spaces are ignored also blank lines are ignored. If field value has some any special character(s) then use escape sequence (e.g. For NewLine: \r\n, For Tab: \t, For at (@): \@). When value of any field starts with at sign (@) its automatically treated as File you want to upload. By default file content type is determined based on extension however you can supply content type manually for any field using this way [ YourFileFieldName.Content-Type=some-content-type ]. By default File Upload Field always includes Content-Type in the request (non file fields do not have content-type by default unless you supply manually). For some reason if you dont want to use Content-Type header in your request then supply blank Content-Type to exclude this header altogather [e.g. SomeFieldName.Content-Type= ]. In below example we have supplied Content-Type for file2 and SomeField1, all other fields are using default content-type. See below Example of uploading multiple files along with additional fields. If some API requires you to pass Content-Type: multipart/form-data rather than multipart/form-data then manually set Request Header => Content-Type: multipart/mixed (it must starts with multipart/ else will be ignored). file1=@c:\data\Myfile1.txt file2=@c:\data\Myfile2.json file2.Content-Type=application/json SomeField1=aaaaaaa SomeField1.Content-Type=text/plain SomeField2=12345 SomeFieldWithNewLineAndTab=This is line1\r\nThis is line2\r\nThis is \ttab \ttab \ttab SomeFieldStartingWithAtSign=\@MyTwitterHandle
Filter Enter filter to extract array from response. Example: $.rows[*] --OR-- $.customers[*].orders[*]. Check your response document and find out hierarchy you like to extract
Headers Headers for Request. To enter multiple headers use double pipe or new line after each {header-name}:{value} pair

Other App Integration scenarios for ElasticSearch

Other Connectors for SSIS


Download ElasticSearch Connector for SSIS Documentation 

  • How to connect ElasticSearch in SSIS?

  • How to get ElasticSearch data in SSIS?

  • How to read ElasticSearch data in SSIS?

  • How to load ElasticSearch data in SSIS?

  • How to import ElasticSearch data in SSIS?

  • How to pull ElasticSearch data in SSIS?

  • How to push data to ElasticSearch in SSIS?

  • How to write data to ElasticSearch in SSIS?

  • How to POST data to ElasticSearch in SSIS?

  • Call ElasticSearch API in SSIS

  • Consume ElasticSearch API in SSIS

  • ElasticSearch SSIS Automate

  • ElasticSearch SSIS Integration

  • Integration ElasticSearch in SSIS

  • Consume real-time ElasticSearch data in SSIS

  • Consume realtime ElasticSearch API data in SSIS

  • ElasticSearch ODBC Driver | ODBC Driver for ElasticSearch | ODBC ElasticSearch Driver | SSIS ElasticSearch Source | SSIS ElasticSearch Destination

  • Connect ElasticSearch in SSIS

  • Load ElasticSearch in SSIS

  • Load ElasticSearch data in SSIS

  • Read ElasticSearch data in SSIS

  • ElasticSearch API Call in SSIS