Table of Contents

Class GlobalStreamProjectionOptions

Namespace
Excalibur.EventSourcing.Projections
Assembly
Excalibur.EventSourcing.dll

Configuration options for global stream projection processing.

public sealed class GlobalStreamProjectionOptions
Inheritance
GlobalStreamProjectionOptions
Inherited Members

Fields

DefaultProjectionName

The default logical subscription name.

public const string DefaultProjectionName = "AsyncProjectionProcessingHost"

Field Value

string

Remarks

Cooperating built-in processors may share it only with an identical bound definition. Choose an explicit stable name for each independent subscription.

Properties

BatchSize

Gets or sets the maximum number of events to read per batch.

[Range(1, 100000)]
public int BatchSize { get; set; }

Property Value

int

The batch size. Default is 500.

CheckpointInterval

Gets or sets the event interval between checkpoint writes for custom global-stream hosts.

[Range(1, 100000)]
public int CheckpointInterval { get; set; }

Property Value

int

The interval for GlobalStreamProjectionHost implementations; default is 100.

Remarks

The built-in asynchronous projection processor ignores this interval and checkpoints every finite page after all required folds settle. A crash can redeliver that page, up to BatchSize events per attempt. Repeated failures can repeat effects again; there is no bound on the total number of attempts. Custom global-stream hosts using this threshold can overshoot it by a page and have a different replay window. External handler effects must be idempotent in either case because their commit and the checkpoint commit are separate operations.

IdlePollingInterval

Gets or sets the polling interval when no new events are available.

public TimeSpan IdlePollingInterval { get; set; }

Property Value

TimeSpan

The idle polling interval. Default is 1 second.

ProjectionName

Gets or sets the stable subscription name used for checkpoint and definition binding.

public string ProjectionName { get; set; }

Property Value

string

Defaults to DefaultProjectionName.

Remarks

API and Jobs processes processing the same work use the same name, scope, revision and projection set. A different definition under this name is refused before effects. To deploy changed projection semantics, choose a new subscription name and deliberately rebuild or cut over its destination.

SubscriptionRevision

Gets or sets the consumer's projection-definition revision.

public string SubscriptionRevision { get; set; }

Property Value

string

Remarks

Change this when fold logic, routing, dependencies, or destination semantics change; use a new subscription and rebuild.

SubscriptionScope

Gets or sets the stable logical identity of the event source and projection destination.

public string SubscriptionScope { get; set; }

Property Value

string

Remarks

All cooperating processes must use the same value. Required for asynchronous projection processing.