ElasticSearch Connector
Documentation
Version: 5
Documentation
Home » API Integration Hub » ElasticSearch Connector » EndPoints > Get documents from Index or Alias

EndPoint Get documents from Index or Alias

Name

get_documents

Description

Gets documents from Index or Alias [API reference]

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

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.