ElasticSearch Connector

ElasticSearch Connector

The high-performance ElasticSearch Connector provides read/write capabilities within your application, allowing you to perform numerous ElasticSearch operations with minimal coding or even no-coding at all. Integrate ElasticSearch data into applications such as SSIS, SQL Server, any ODBC-compatible application, or even directly within a programming language using this connector.

Download for SSIS Download for SQL Server and ODBC Documentation

Integrate ElasticSearch with these applications

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

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.

Download for SSIS Download for SQL Server and ODBC