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
| Name | Signature | Synopsis |
|---|---|---|
| ``.ctor`` | TransactionalProjectionOptions(name, store) | No description available. |
| LateWriteWindow | this.LateWriteWindow | How long after taking its journal number a write may commit and still be found by the next query, which reads only recent writes. |
| Entities | this.Entities | The entity names whose events this projection reads: an aggregate's, saga's, or workflow's name, as registered. |
| BatchSize | this.BatchSize | Maximum number of events fetched for one persistence ID per query. |
| CatchUpTimeout | this.CatchUpTimeout | Bound for the entire catch-up call, including snapshot capture. |
| Store | this.Store | Authoritative journal connection and transactional read-model store. |
| Name | this.Name | Stable identity of the read model and its durable progress. |
| FullScanInterval | this.FullScanInterval | How often a query reads every persistence ID's position instead of only recent writes. |
| PollInterval | this.PollInterval | Delay between background journal-head queries, after the previous batch finishes. |
Parameters
| Name | Type | Description |
|---|---|---|
| name | string | |
| store | SqlProjectionStore |
Returns
TransactionalProjectionOptions
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
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
Maximum number of events fetched for one persistence ID per query. Default: 500.
Returns
int
Bound for the entire catch-up call, including snapshot capture. Default: 30 seconds.
Returns
TimeSpan
Authoritative journal connection and transactional read-model store.
Returns
SqlProjectionStore
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