ElasticSearch Connector
Documentation
Version: 5
Documentation
Endpoint

Get documents from Index or Alias

Name

get_documents

Description

Gets documents from Index or Alias [API reference]

Related Tables

[Dynamic Table] , [Dynamic Table]

Parameters

Parameter Label Required Options Description
Index Index YES
Query Enter Query (JSON Format) NO
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"} }
[API reference]
CursorTimeout CursorTimeout (Minutes) NO
Option Value
1 1
2 2
5 5
10 10
60 60
180 180
Enter this value carefully. Do not enter very long timeout else it will hold cursor longer on server memory space
PageSize How many Record to fetch per request NO Do not enter very large number or too small number to avoid performance issues.
Alias Alias (Deprecated - Use Index instead) NO

Output Columns

Label Data Type (SSIS) Data Type (SQL) Length Raw Description
_id DT_WSTR nvarchar(150) 150 False
_score DT_R8 float False
[$parent.Pivot_Path$] DT_WSTR nvarchar(4000) 4000 False
[$parent.Pivot_Path$].lat DT_R8 float False
[$parent.Pivot_Path$].lon DT_R8 float False
[$parent.Pivot_Path$].type DT_WSTR nvarchar(30) 30 False
[$parent.Pivot_Path$].coordinates DT_TEXT varchar(MAX) False
If the column you are looking for is missing, consider customizing ElasticSearch Connector.

Input Columns

Label Data Type (SSIS) Data Type (SQL) Length Raw Description
There are no Static columns defined for this endpoint. This endpoint detects columns dynamically at runtime.

Examples

SSIS

Use ElasticSearch Connector in API Source component to read data or in API Destination component to read/write data:

Read from [Dynamic Table] table using API Destination

This Endpoint belongs to [Dynamic Table] table, therefore you cannot work with it directly. Use this table and table-operation pair instead:

ElasticSearch
[Dynamic Table]
Select
SSIS API Destination - Access table operation

ODBC application

Use these SQL queries in your ODBC application data source:

Get documents from index or alias 

SELECT * FROM get_documents

get_documents endpoint belongs to [Dynamic Table] , [Dynamic Table] table(s), and can therefore be used via those table(s).

SQL Server

Use these SQL queries in SQL Server after you create a data source in Data Gateway:

Get documents from index or alias 

DECLARE @MyQuery NVARCHAR(MAX) = 'SELECT * FROM get_documents';

EXEC (@MyQuery) AT [LS_TO_ELASTICSEARCH_IN_GATEWAY];

get_documents endpoint belongs to [Dynamic Table] , [Dynamic Table] table(s), and can therefore be used via those table(s).