TransactionalProjectionOptionsType

PackageFCQRS
Options for a named transactional projection. Use a distinct name for each read model. Reusing a name resumes its stored progress; do not reuse it for an empty or different model.

Specification

Kind
Type
Members
8
Examples
0
``.ctor``Signature
TransactionalProjectionOptions(name, store)
PollIntervalSignature
this.PollInterval
BatchSizeSignature
this.BatchSize
CatchUpTimeoutSignature
this.CatchUpTimeout
FullScanIntervalSignature
this.FullScanInterval

Summary

NameSignatureSynopsis
``.ctor``TransactionalProjectionOptions(name, store)No description available.
PollIntervalthis.PollIntervalDelay between background journal-head queries, after the previous batch finishes.
BatchSizethis.BatchSizeMaximum number of events fetched for one persistence ID per query.
CatchUpTimeoutthis.CatchUpTimeoutBound for the entire catch-up call, including snapshot capture.
FullScanIntervalthis.FullScanIntervalHow often a query reads every persistence ID's position instead of only recent writes.
Storethis.StoreAuthoritative journal connection and transactional read-model store.
LateWriteWindowthis.LateWriteWindowHow long after taking its journal number a write may commit and still be found by the next query, which reads only recent writes.
Namethis.NameStable identity of the read model and its durable progress.

``.ctor``

TransactionalProjectionOptions(name, store)
Member

Parameters

NameTypeDescription
namestring
storeSqlProjectionStore

Returns

TransactionalProjectionOptions

PollInterval

this.PollInterval
Member
Delay between background journal-head queries, after the previous batch finishes. An aggregate on this node that stores an event starts the next query at once, and CatchUpAsync captures its own snapshot immediately. Default: one second.

Returns

TimeSpan

BatchSize

this.BatchSize
Member
Maximum number of events fetched for one persistence ID per query. Default: 500.

Returns

int

CatchUpTimeout

this.CatchUpTimeout
Member
Bound for the entire catch-up call, including snapshot capture. Default: 30 seconds.

Returns

TimeSpan

FullScanInterval

this.FullScanInterval
Member
How often a query reads every persistence ID's position instead of only recent writes. The full scan also finds a write that committed after LateWriteWindow. Default: five minutes.

Returns

TimeSpan

Store

this.Store
Member
Authoritative journal connection and transactional read-model store.

Returns

SqlProjectionStore

LateWriteWindow

this.LateWriteWindow
Member
How long after taking its journal number a write may commit and still be found by the next query, which reads only recent writes. A write that commits later is found by the next full scan. Default: 30 seconds.

Returns

TimeSpan

Name

this.Name
Member
Stable identity of the read model and its durable progress.

Returns

string