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 |
|
[API reference] | ||||||||||||||
CursorTimeout | CursorTimeout (Minutes) | NO |
|
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. |
Examples
SSIS
Use ElasticSearch Connector in API Source component to read data or in API Destination component to read/write data:
Get documents from Index or Alias using API Source
ElasticSearch
Get documents from Index or Alias

Get documents from Index or Alias using API Destination
ElasticSearch
Get documents from Index or Alias
