EndPoint Get Index or Alias metadata
Parameters
Parameter | Label | Required | Options | Description |
---|---|---|---|---|
Index | Index | YES | ||
Alias | Alias (Deprecated - Use Index instead) | NO |
Output Columns
Label | Data Type (SSIS) | Data Type (SQL) | Length | Raw | Description |
---|---|---|---|---|---|
Path |
DT_WSTR
|
nvarchar(4000)
|
4000 | False |
|
Name |
DT_WSTR
|
nvarchar(4000)
|
4000 | False |
|
Type |
DT_WSTR
|
nvarchar(4000)
|
4000 | False |
|
Length |
DT_I4
|
int
|
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 Index or Alias metadata using API Source
ElasticSearch
Get Index or Alias metadata

Get Index or Alias metadata using API Destination
ElasticSearch
Get Index or Alias metadata

ODBC application
Use these SQL queries in your ODBC application data source:
Get index metadata
Gets index metadata
SELECT * FROM get_index_metadata WITH (Index='my_index_name')
SQL Server
Use these SQL queries in SQL Server after you create a data source in Data Gateway:
Get index metadata
Gets index metadata
DECLARE @MyQuery NVARCHAR(MAX) = 'SELECT * FROM get_index_metadata WITH (Index=''my_index_name'')';
EXEC (@MyQuery) AT [LINKED_SERVER_TO_ELASTICSEARCH_IN_DATA_GATEWAY];