Table of Contents

Class ElasticSearchMaterializedViewStoreOptions

Namespace
Excalibur.Data.ElasticSearch.MaterializedViews
Assembly
Excalibur.Data.ElasticSearch.dll

Configuration options for ElasticSearchMaterializedViewStore.

public sealed class ElasticSearchMaterializedViewStoreOptions
Inheritance
ElasticSearchMaterializedViewStoreOptions
Inherited Members

Fields

DefaultPositionsIndexName

Default positions index name.

public const string DefaultPositionsIndexName = "materialized-view-positions"

Field Value

string

DefaultViewsIndexName

Default views index name.

public const string DefaultViewsIndexName = "materialized-views"

Field Value

string

Properties

Auth

Gets or sets the authentication options.

public ElasticSearchAuthOptions Auth { get; set; }

Property Value

ElasticSearchAuthOptions

The authentication options for basic auth or API key auth.

CreateIndexOnInitialize

Gets or sets a value indicating whether to create indices on initialization.

public bool CreateIndexOnInitialize { get; set; }

Property Value

bool

Defaults to true.

EnableDebugMode

Gets or sets a value indicating whether to enable debug mode.

public bool EnableDebugMode { get; set; }

Property Value

bool

Defaults to false.

NodeUri

Gets or sets the Elasticsearch node URI.

public string NodeUri { get; set; }

Property Value

string

Defaults to "http://localhost:9200".

NumberOfReplicas

Gets or sets the number of replicas for new indices.

public int NumberOfReplicas { get; set; }

Property Value

int

Defaults to 0.

NumberOfShards

Gets or sets the number of shards for new indices.

public int NumberOfShards { get; set; }

Property Value

int

Defaults to 1.

PositionsIndexName

Gets or sets the index name for position tracking.

public string PositionsIndexName { get; set; }

Property Value

string

Defaults to "materialized-view-positions".

RefreshInterval

Gets or sets the refresh interval for the indices.

public string RefreshInterval { get; set; }

Property Value

string

Defaults to "1s".

RefreshPolicy

Gets or sets the refresh policy applied to per-document write operations (view and position saves).

public string RefreshPolicy { get; set; }

Property Value

string

One of "wait_for", "true", or "false". Defaults to "wait_for", which blocks the write until the affected shards have refreshed without forcing an immediate segment flush. Use "false" for the highest throughput during projection rebuilds, or "true" only when an immediate, per-write refresh is genuinely required (this is a throughput killer at volume).

RequestTimeoutSeconds

Gets or sets the request timeout in seconds.

public int RequestTimeoutSeconds { get; set; }

Property Value

int

Defaults to 30 seconds.

ViewsIndexName

Gets or sets the index name for materialized views.

public string ViewsIndexName { get; set; }

Property Value

string

Defaults to "materialized-views".

Methods

Validate()

Validates the options and throws if invalid.

public void Validate()

Exceptions

InvalidOperationException

Thrown when required options are missing.