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. A name that starts with `fcqrs-` is reserved for FCQRS's own projections: starting a projection with one raises `ArgumentException`.

Specification

Kind
Type
Members
9
Examples
0
``.ctor``Signature
TransactionalProjectionOptions(name, store)
LateWriteWindowSignature
this.LateWriteWindow
EntitiesSignature
this.Entities
BatchSizeSignature
this.BatchSize
CatchUpTimeoutSignature
this.CatchUpTimeout

Summary

NameSignatureSynopsis
``.ctor``TransactionalProjectionOptions(name, store)No description available.
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.
Entitiesthis.EntitiesThe entity names whose events this projection reads: an aggregate's, saga's, or workflow's name, as registered.
BatchSizethis.BatchSizeMaximum number of events fetched for one persistence ID per query.
CatchUpTimeoutthis.CatchUpTimeoutBound for the entire catch-up call, including snapshot capture.
Storethis.StoreAuthoritative journal connection and transactional read-model store.
Namethis.NameStable identity of the read model and its durable progress.
FullScanIntervalthis.FullScanIntervalHow often a query reads every persistence ID's position instead of only recent writes.
PollIntervalthis.PollIntervalDelay between background journal-head queries, after the previous batch finishes.

``.ctor``

TransactionalProjectionOptions(name, store)
Member

Parameters

NameTypeDescription
namestring
storeSqlProjectionStore

Returns

TransactionalProjectionOptions

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

Entities

this.Entities
Member
The entity names whose events this projection reads: an aggregate's, saga's, or workflow's name, as registered. A name selects the persistence IDs that start with it, escaped as Akka escapes a sharding region's name (Uri.EscapeDataString), and "/". The journal queries select those rows in SQL, so other entities' events are not fetched or deserialized, and the projection stores progress only for the named entities. On SQLite and SQL Server the full scan reads only the names' range of the journal's persistence-ID index, and the queries bounded by a journal number read every row above it; PostgreSQL reads other entities' rows in every query. A pass reads each persistence ID's events with a query of its own. Empty, the default, reads every entity. A pass applies the named entities' events in journal order, as without a filter.

Returns

string seq

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

Store

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

Returns

SqlProjectionStore

Name

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

Returns

string

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

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