Table of Contents

Class ElasticsearchPersistenceOptions

Namespace
Excalibur.Data.ElasticSearch.Persistence
Assembly
Excalibur.Data.ElasticSearch.dll

Configuration options for the Elasticsearch persistence provider.

public sealed class ElasticsearchPersistenceOptions
Inheritance
ElasticsearchPersistenceOptions
Inherited Members

Properties

IndexPrefix

Gets or sets the prefix for index names created by this provider.

public string IndexPrefix { get; set; }

Property Value

string

The index name prefix. Defaults to "excalibur-".

MaxResultCount

Gets or sets the maximum number of results returned per query.

[Range(1, 10000)]
public int MaxResultCount { get; set; }

Property Value

int

The maximum result count. Defaults to 1000.

Name

Gets or sets the provider name. This is the consumer-configured instance name, reported as Name on the provider and in its metrics. It identifies which configured instance answered, and is distinct from the engine identity reported under the Provider metrics key, which is a fixed literal. When unset it defaults to "elasticsearch".

public string? Name { get; set; }

Property Value

string

The provider name, or null to use the default.

NumberOfReplicas

Gets or sets the number of replica shards for new indices.

[Range(0, 10)]
public int NumberOfReplicas { get; set; }

Property Value

int

The number of replica shards. Defaults to 1.

NumberOfShards

Gets or sets the number of primary shards for new indices.

[Range(1, 1024)]
public int NumberOfShards { get; set; }

Property Value

int

The number of primary shards. Defaults to 1.

RefreshPolicy

Gets or sets the refresh policy to apply after write operations.

public ElasticsearchRefreshPolicy RefreshPolicy { get; set; }

Property Value

ElasticsearchRefreshPolicy

The refresh policy. Defaults to WaitFor.