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

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:

  1. SSIS designer installed. Sometimes it is referred as BIDS or SSDT (download it from Microsoft).
  2. Basic knowledge of SSIS package development using Microsoft SQL Server Integration Services.
  3. 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.

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

    Steps how to get and use ElasticSearch credentials

    For Local / Hosted Instance by you

    1. 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
    1. Go to https://app.bonsai.io/clusters/{your-instance-id}/tokens
    2. Copy Access Key and Access Secret and enter on the connection UI. Click Test connection.
    3. 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

    Configuring authentication parameters
    ElasticSearch
    Basic Authentication (UserId/Password) [Http]
    http://localhost:9200
    Optional Parameters
    User Name (or Access Key)
    Password (or Access Secret)
    Ignore certificate related errors
    ZappySys Http Connection

    Configuring authentication parameters
    ElasticSearch
    Windows Authentication (No Password) [Http]
    http://localhost:9200
    Optional Parameters
    Ignore certificate related errors
    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! 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)

    Execute Package - Reading data from ElasticSearch and load into target

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.

  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.

    Steps how to get and use ElasticSearch credentials

    For Local / Hosted Instance by you

    1. 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
    1. Go to https://app.bonsai.io/clusters/{your-instance-id}/tokens
    2. Copy Access Key and Access Secret and enter on the connection UI. Click Test connection.
    3. 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

    Configuring authentication parameters
    ElasticSearch
    Basic Authentication (UserId/Password) [Http]
    http://localhost:9200
    Optional Parameters
    User Name (or Access Key)
    Password (or Access Secret)
    Ignore certificate related errors
    ZappySys Http Connection

    Configuring authentication parameters
    ElasticSearch
    Windows Authentication (No Password) [Http]
    http://localhost:9200
    Optional Parameters
    Ignore certificate related errors
    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 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

    Execute Package - Reading data from API Source and load into target

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.

  1. From the SSIS Toolbox drag-and-drop Upsert Destination component onto the Data Flow designer background.

  2. Connect your SSIS source component to Upsert Destination.

  3. Double-click on Upsert Destination component to open configuration window.

  4. Start by selecting the Action from the list.

  5. Next, select the desired target connection or create one by clicking <New [provider] Connection> menu item from the Target Connection dropdown.

  6. Then select a table from the Target Table list or click New button to create a new table based on the source columns.

  7. Continue by checking Insert and Update options according to your scenario (e.g. if Update option is unchecked, no updates will be made).

  8. Finally, click Map All button to map all columns and then select the Key columns to match the columns on:

    Configure SSIS Upsert Destination component to merge data with SQL Server, PostgreSQL, or Redshift table
  9. Click OK to save the configuration.

  10. Run the package and ElasticSearch data will be merged with the target table in SQL Server, PostgreSQL, or Redshift:

    Execute Package - Reading data from API Source and load into target
  11. 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:

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:

Actions supported by ElasticSearch Connector

ElasticSearch Connector supports following actions for REST API integration:

Count documents

Description

Not available.

Parameters

You can provide the following parameters to this action:

  • Index (choose one --OR-- enter * --OR-- comma seperated names)
  • Enter Query (JSON Format)

Input Fields

You can provide the following fields to this action:

  • N/A

Output Fields

The following fields are returned after calling this action:

  • count

Visit documentation for more information.

Create Index

Description

Create a new index.

Parameters

You can provide the following parameters to this action:

  • New Index Name

Input Fields

You can provide the following fields to this action:

  • N/A

Output Fields

The following fields are returned after calling this action:

  • Acknowledged
  • Name
  • ShardsAcknowledged
  • Index

Visit documentation for more information.

Delete documents

Description

Deletes documents.

Parameters

You can provide the following parameters to this action:

  • Index

Input Fields

You can provide the following fields to this action:

  • _id

Output Fields

The following fields are returned after calling this action:

  • ErrorFound
  • Result
  • HttpStatus
  • Id
  • Index
  • Type
  • IndexUuid
  • Reason
  • ErrorType
  • ErrorCausedByType
  • ErrorCausedByreason
  • Version
  • SequenceNo
  • PrimaryTerm
  • ShardsFailed
  • ShardsSuccessful
  • ShardsTotal
  • Took

Visit documentation for more information.

Delete Index

Description

Delete an exising index.

Parameters

You can provide the following parameters to this action:

  • Index to delete

Input Fields

You can provide the following fields to this action:

  • N/A

Output Fields

The following fields are returned after calling this action:

  • Acknowledged
  • Name
  • ErrorStatus
  • ErrorReason
  • ErrorType
  • ErrorId
  • ErrorIndex

Visit documentation for more information.

Get document by ID from Index or Alias

Description

Not available.

Parameters

You can provide the following parameters to this action:

  • Enter Document ID
  • Index
  • Alias (Deprecated - Use Index instead)

Input Fields

You can provide the following fields to this action:

  • N/A

Output Fields

The following fields are returned after calling this action:

  • _id
  • _score
  • [Dynamic Column]
  • [Dynamic Column].lat
  • [Dynamic Column].lon
  • [Dynamic Column].type
  • [Dynamic Column].coordinates

Visit documentation for more information.

Get documents from Index or Alias

Description

Gets documents from Index or Alias.

Parameters

You can provide the following parameters to this action:

  • Index
  • Enter Query (JSON Format)
  • CursorTimeout (Minutes)
  • How many Record to fetch per request
  • Alias (Deprecated - Use Index instead)

Input Fields

You can provide the following fields to this action:

  • N/A

Output Fields

The following fields are returned after calling this action:

  • _id
  • _score
  • [Dynamic Column]
  • [Dynamic Column].lat
  • [Dynamic Column].lon
  • [Dynamic Column].type
  • [Dynamic Column].coordinates

Visit documentation for more information.

Get Index or Alias metadata

Description

Gets index or alias metadata.

Parameters

You can provide the following parameters to this action:

  • Index
  • Alias (Deprecated - Use Index instead)

Input Fields

You can provide the following fields to this action:

  • N/A

Output Fields

The following fields are returned after calling this action:

  • Path
  • Name
  • Type
  • Length

Visit documentation for more information.

Insert documents

Description

Insert documents.

Parameters

You can provide the following parameters to this action:

  • Index
  • Alias (Deprecated - Use Index instead)

Input Fields

You can provide the following fields to this action:

  • _id
  • [Dynamic Column]
  • [Dynamic Column].lat
  • [Dynamic Column].lon
  • [Dynamic Column].type
  • [Dynamic Column].coordinates

Output Fields

The following fields are returned after calling this action:

  • ErrorFound
  • Result
  • HttpStatus
  • Id
  • Index
  • Type
  • IndexUuid
  • Reason
  • ErrorType
  • ErrorCausedByType
  • ErrorCausedByreason
  • Version
  • SequenceNo
  • PrimaryTerm
  • ShardsFailed
  • ShardsSuccessful
  • ShardsTotal
  • Took

Visit documentation for more information.

List aliases

Description

Lists aliases.

Parameters

You can provide the following parameters to this action:

  • N/A

Input Fields

You can provide the following fields to this action:

  • N/A

Output Fields

The following fields are returned after calling this action:

  • Name
  • Index
  • Type

Visit documentation for more information.

List indexes

Description

Lists indexes.

Parameters

You can provide the following parameters to this action:

  • N/A

Input Fields

You can provide the following fields to this action:

  • N/A

Output Fields

The following fields are returned after calling this action:

  • Name
  • Uuid
  • Status
  • Health
  • Pri
  • Rep
  • DocsCount
  • DocsDeleted
  • StoreSize
  • PriStoreSize
  • Type

Visit documentation for more information.

Search / Query documents

Description

Gets documents (Using JSON Query Language).

Parameters

You can provide the following parameters to this action:

  • Index
  • Enter Query (JSON Format)
  • CursorTimeout (Minutes)
  • How many Record to fetch per request
  • Alias (Deprecated - Use Index instead)

Input Fields

You can provide the following fields to this action:

  • N/A

Output Fields

The following fields are returned after calling this action:

  • _id
  • _score
  • [Dynamic Column]
  • [Dynamic Column].lat
  • [Dynamic Column].lon
  • [Dynamic Column].type
  • [Dynamic Column].coordinates

Visit documentation for more information.

Update documents

Description

Update documents.

Parameters

You can provide the following parameters to this action:

  • Index
  • Alias (Deprecated - Use Index instead)

Input Fields

You can provide the following fields to this action:

  • _id
  • [Dynamic Column]
  • [Dynamic Column].lat
  • [Dynamic Column].lon
  • [Dynamic Column].type
  • [Dynamic Column].coordinates

Output Fields

The following fields are returned after calling this action:

  • ErrorFound
  • Result
  • HttpStatus
  • Id
  • Index
  • Type
  • IndexUuid
  • Reason
  • ErrorType
  • ErrorCausedByType
  • ErrorCausedByreason
  • Version
  • SequenceNo
  • PrimaryTerm
  • ShardsFailed
  • ShardsSuccessful
  • ShardsTotal
  • Took

Visit documentation for more information.

Upsert documents

Description

Insert Or Update (Upserts) documents. If _id column not supplied then this acts like INSERT call. If _id column supplied and its found then UPDATE action happens else INSERT. Look at the Result column in the output to see if document was created or updated.

Parameters

You can provide the following parameters to this action:

  • Index
  • Alias (Deprecated - Use Index instead)

Input Fields

You can provide the following fields to this action:

  • _id
  • [Dynamic Column]
  • [Dynamic Column].lat
  • [Dynamic Column].lon
  • [Dynamic Column].type
  • [Dynamic Column].coordinates

Output Fields

The following fields are returned after calling this action:

  • ErrorFound
  • Result
  • HttpStatus
  • Id
  • Index
  • Type
  • IndexUuid
  • Reason
  • ErrorType
  • ErrorCausedByType
  • ErrorCausedByreason
  • Version
  • SequenceNo
  • PrimaryTerm
  • ShardsFailed
  • ShardsSuccessful
  • ShardsTotal
  • Took

Visit documentation for more information.

Make Generic API Request

Description

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.

Parameters

You can provide the following parameters to this action:

  • Url
  • Body
  • IsMultiPart
  • Filter
  • Headers

Input Fields

You can provide the following fields to this action:

  • N/A

Output Fields

The following fields are returned after calling this action:

  • N/A

Visit documentation for more information.

Make Generic API Request (Bulk Write)

Description

This is a generic endpoint for bulk write purpose. 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.

Parameters

You can provide the following parameters to this action:

  • Url
  • IsMultiPart
  • Filter
  • Headers

Input Fields

You can provide the following fields to this action:

  • N/A

Output Fields

The following fields are returned after calling this action:

  • N/A

Visit documentation for more information.

Conclusion

In this article we showed you how to connect to ElasticSearch in SSIS and integrate data without any coding, saving you time and effort.

We encourage you to download ElasticSearch Connector for SSIS and see how easy it is to use it for yourself or your team.

If you have any questions, feel free to contact ZappySys support team. You can also open a live chat immediately by clicking on the chat icon below.

Download ElasticSearch Connector for SSIS Documentation

More integrations

Other connectors for SSIS

All
Big Data & NoSQL
Database
CRM & ERP
Marketing
Collaboration
Cloud Storage
Reporting
Commerce
API & Files

Other application integration scenarios for ElasticSearch

All
Data Integration
Database
BI & Reporting
Productivity
Programming Languages
Automation & Scripting
ODBC applications