ElasticSearch Connector
Documentation
Version: 5
Documentation
Endpoint

Get Index or Alias metadata


Name

get_index_metadata

Description

Gets index or alias metadata

Related Tables

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
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 Metadata table using API Destination

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

ElasticSearch
Metadata
Select
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_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_index_metadata endpoint belongs to Metadata table(s), and can therefore be used via those table(s).