Reference

Endpoint Get Index or Alias metadata

Name

get_index_metadata

Description

Gets index or alias metadata

Related Tables

Metadata

Parameters

Parameter Required Options
Name: Index

Label: Index

 YES
Name: Alias

Label: Alias (Deprecated - Use Index instead)

Output Columns

Label Data Type (SSIS) Data Type (SQL) Length Description
Path DT_WSTR nvarchar(4000) 4000
Name DT_WSTR nvarchar(4000) 4000
Type DT_WSTR nvarchar(4000) 4000
Length DT_I4 int
If the column you are looking for is missing, consider customizing ElasticSearch Connector.

Input Columns

Label Data Type (SSIS) Data Type (SQL) Length 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 or in API Destination SSIS Data Flow components to read or write data.

API Source

This Endpoint belongs to the Metadata table, therefore it is better to use it, instead of accessing the endpoint directly:

API Source - ElasticSearch
Read / write ElasticSearch data inside your app; perform many ElasticSearch operations without coding, just use easy to use high performance API Connector for ElasticSearch
ElasticSearch
Metadata
Optional Parameters
EnablePivot True
IncludePivotPath True
EnablePivotPathSearchReplace True
PivotPathSearchFor -
PivotPathReplaceWith
SSIS API Source - Read from table or endpoint

API Destination

This Endpoint belongs to the Metadata table, therefore it is better to use it, instead of accessing the endpoint directly. Use this table and table-operation pair to get index or alias metadata:

API Destination - ElasticSearch
Read / write ElasticSearch data inside your app; perform many ElasticSearch operations without coding, just use easy to use high performance API Connector for ElasticSearch
ElasticSearch
Metadata
Select
Optional Parameters
EnablePivot True
IncludePivotPath True
EnablePivotPathSearchReplace True
PivotPathSearchFor -
PivotPathReplaceWith
SSIS API Destination - Access table operation

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')

Get Metadata 

SELECT * FROM Metadata

get_index_metadata endpoint belongs to Metadata 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 index metadata

Gets index metadata 

DECLARE @MyQuery NVARCHAR(MAX) = 'SELECT * FROM get_index_metadata WITH (Index=''my_index_name'')';

EXEC (@MyQuery) AT [LS_TO_ELASTICSEARCH_IN_GATEWAY];

Get Metadata 

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

EXEC (@MyQuery) AT [LS_TO_ELASTICSEARCH_IN_GATEWAY];

get_index_metadata endpoint belongs to Metadata table(s), and can therefore be used via those table(s).