ProjectionProgressUnion
PackageFCQRS
A read-model projection definition.
Where a projection keeps how far it has read.
Specification
Kind
Union
Members
4
Examples
0
IsNamedSignature
this.IsNamed
IsFromStartSignature
this.IsFromStart
FromStartSignature
FromStart
NamedSignature
Named string
Summary
| Name | Signature | Synopsis |
|---|---|---|
| IsNamed | this.IsNamed | No description available. |
| IsFromStart | this.IsFromStart | No description available. |
| FromStart | FromStart | In memory: the projection reads the whole journal each time it starts, then follows new events. |
| Named | Named string | Stored in the journal database under this name: the projection resumes where it stopped. |
In memory: the projection reads the whole journal each time it starts, then follows new
events. For a read model the process keeps in memory.
Returns
unit
Stored in the journal database under this name: the projection resumes where it stopped.
For a read model that outlives the process. A new name reads the whole journal once. The
position is stored after the handler returns, outside the handler, so the handler can wait for
a journal write such as a workflow start. A name that starts with `fcqrs-` is reserved for
FCQRS's own projections, and `Fcqrs.projection` raises `ArgumentException` for it.
Parameters
| Name | Type | Description |
|---|---|---|
| Item | string |
Returns
unit