Table of Contents

Class MigrationOptions

Namespace
Excalibur.Dispatch.Serialization
Assembly
Excalibur.Dispatch.dll

Options for configuring serializer migration behavior.

public sealed class MigrationOptions
Inheritance
MigrationOptions
Inherited Members
Extension Methods

Remarks

These options control batch processing, verification, and error handling during migration operations.

Properties

BatchSize

Gets or sets the number of records to process in each batch.

public int BatchSize { get; set; }

Property Value

int

Remarks

Smaller batches reduce memory pressure but increase database round-trips. Larger batches are more efficient but may cause memory issues with large payloads. Default: 1000 records per batch.

ContinueOnFailure

Gets or sets whether to continue migration after encountering failures.

public bool ContinueOnFailure { get; set; }

Property Value

bool

Remarks

When true, migration continues even if some records fail. When false, the first failure aborts the entire operation. Default: true (continue on failure).

DelayBetweenBatchesMs

Gets or sets the delay between batches in milliseconds.

public int DelayBetweenBatchesMs { get; set; }

Property Value

int

Remarks

Adding a delay between batches can reduce database load during migration. Set to 0 for maximum throughput. Default: 0 (no delay).

EnableReadBackVerification

Gets or sets whether to verify each migrated record by reading it back.

public bool EnableReadBackVerification { get; set; }

Property Value

bool

Remarks

When enabled, each migrated record is read back and deserialized to verify the migration was successful. This adds overhead but provides stronger guarantees. Default: false (for performance).

MaxConsecutiveFailures

Gets or sets the maximum number of consecutive failures before aborting.

public int MaxConsecutiveFailures { get; set; }

Property Value

int

Remarks

If this many consecutive records fail migration, the operation is aborted. Set to 0 to disable this check and continue regardless of failures. Default: 100 consecutive failures.