Table of Contents

Class IndexTemplateManagerExtensions

Namespace
Excalibur.Data.ElasticSearch.IndexManagement
Assembly
Excalibur.Data.ElasticSearch.dll

Extension methods for IIndexTemplateManager.

public static class IndexTemplateManagerExtensions
Inheritance
IndexTemplateManagerExtensions
Inherited Members

Methods

CreateOrUpdateComponentTemplateAsync(IIndexTemplateManager, string, ComponentTemplateConfiguration, CancellationToken)

Creates or updates a component template in Elasticsearch.

public static Task<bool> CreateOrUpdateComponentTemplateAsync(this IIndexTemplateManager manager, string templateName, ComponentTemplateConfiguration template, CancellationToken cancellationToken)

Parameters

manager IIndexTemplateManager
templateName string
template ComponentTemplateConfiguration
cancellationToken CancellationToken

Returns

Task<bool>

DeleteComponentTemplateAsync(IIndexTemplateManager, string, CancellationToken)

Deletes a component template from Elasticsearch.

public static Task<bool> DeleteComponentTemplateAsync(this IIndexTemplateManager manager, string templateName, CancellationToken cancellationToken)

Parameters

manager IIndexTemplateManager
templateName string
cancellationToken CancellationToken

Returns

Task<bool>

MigrateTemplateAsync(IIndexTemplateManager, string, IndexTemplateConfiguration, TemplateMigrationOptions, CancellationToken)

Migrates an index template to a new version with zero-downtime support.

public static Task<TemplateMigrationResult> MigrateTemplateAsync(this IIndexTemplateManager manager, string templateName, IndexTemplateConfiguration newTemplate, TemplateMigrationOptions migrationOptions, CancellationToken cancellationToken)

Parameters

manager IIndexTemplateManager
templateName string
newTemplate IndexTemplateConfiguration
migrationOptions TemplateMigrationOptions
cancellationToken CancellationToken

Returns

Task<TemplateMigrationResult>