FCQRS
Get started
Task guides
API
GitHub
7.2.3
7.2.3
light
dark
FCQRS
Payload
Module
Package
FCQRS.Workflows
Converts step values to and from their stored form.
Summary
Name
Signature
Synopsis
encode
encode t value
Stores `value` as the type `t`.
decode
decode t payload
Reads a stored value as the type `t`.
ofValue
ofValue value
Stores a typed value.
toValue
toValue payload
Reads a typed value.
encode
encode t value
Member
Stores `value` as the type `t`.
Parameters
Name
Type
Description
t
Type
value
obj
Returns
Payload
decode
decode t payload
Member
Reads a stored value as the type `t`.
Parameters
Name
Type
Description
t
Type
payload
Payload
Returns
obj
ofValue
ofValue value
Member
Stores a typed value.
Parameters
Name
Type
Description
value
'T
Returns
Payload
toValue
toValue payload
Member
Reads a typed value.
Parameters
Name
Type
Description
payload
Payload
Returns
'T
FCQRS
Filter
Overview
Home
API Reference
Docs
Overview
Tutorial: CQRS
1. Open an account
2. Withdraw money
3. Restart the bank
4. Show a statement
5. Transfer money
6. Add a memo
Tutorial: Workflows
1. Place an order
2. Retry the warehouse
3. Read the clock
4. Wait for approval
5. Restart during shipping
6. Charge the customer
7. When a step fails for good
8. Add a step
9. Guard the change
10. Feed orders from a stream
Concepts
Concepts
CQRS and event sourcing
Aggregates and the write side
The read side
Correlation IDs and read-your-writes
Sagas
Deferring, snapshots, and passivation
Consistency and recovery
When FCQRS stops the process
C# interop and serialization
Workflows
How To
Task guide index
Define an aggregate
Send at an expected version
Add a projection
Read your writes
Catch up projections
Write a saga
Write a workflow
Run scheduled jobs
Test your domain
Evolve persisted events
Rebuild a read model
Dispatch a best-effort async effect
Configure the database
Observe your system
Use FCQRS from C#
Serve an aggregate over HTTP
Configuration
Schedules reference
API Reference
FCQRS
Actor
Connection
DBType
ActorSerialization
ConditionalCommandSerializer
STJSerializer
ShardEnvelopeSerializer
AkkaTimeProvider
Internal
CSharp
ActorApi
ActorWiring
Aggregate<'TState, 'TCommand, 'TEvent>
AggregateFactory
AggregateRefs<'TCommand, 'TEvent>
Describe
EventActions
Expectations
FSharpResults
Handler<'TCmd, 'TEvent>
JournalTypeMapBuilder
PrefixConversions
QueryApi
RetrySchedules
Saga<'TData, 'TState, 'TEvent>
SagaCommands
SagaDefinition
SagaEventActions
SagaSideEffectResult<'TState>
SagaStates
SagaTransitions
TestEnvelope
Values
Common
CommandHandler
Internal
State<'Command, 'Event>
Command<'Command, 'Event>
CommandDetails<'Command, 'Event>
SagaBuilder
SagaStateWrapper<'UserState, 'TEvent>
SagaStarter
Internal
SagaStartingEvent<'T>
AggregateVersionConflictException
AkkaLogLevel
Command<'CommandDetails>
Event<'EventDetails>
EventAction<'T>
ExecuteCommand
Expectation
ExpectationExhausted
FactoryAndName
IActor
IConfigurationWrapper
IEnvelope
ILoggerFactoryWrapper
ISerializable
JournalTypes
Notify
PassivationPolicy
PrefixConversion
RetrySchedule
SagaAlreadyStartedException
SagaState<'SagaData, 'State>
SagaTransition<'State>
SnapshotPolicy
TargetActor
TargetName
Telemetry
DynamicConfig
Internal
ConfigExtension
EventUpcasting
FSharp
Fcqrs
Projection
Aggregate<'State, 'Command, 'Event>
AggregateFactory
AggregateHandle<'Command, 'Event>
Handler<'Command, 'Event>
Projection
ProjectionProgress
Saga<'Data, 'State, 'OriginatorEvent>
SagaHandle
ProjectionStorage
ProjectionSqlDialect
SqlProjectionStore
Projections
IProjection
JournalHistoryException
TransactionalProjectionOptions
Query
IAwaitable
IAwaitableDisposable
ISubscribe<'TDataEvent>
ISubscribe
Saga
Scheduler
ObservingScheduler
ShiftedScheduler
SchedulerController
AsyncTaskExtensions
FcqrsBuilder
FcqrsBuilderExtensions
FcqrsRuntime
FcqrsServiceCollectionExtensions
SubscribeExtensions
FCQRS.Model
Aether
Compose
AsyncValidatedLens
ValidatedLens
ValidatedPrism
Lens
Prism
Lens
Operators
Optic
Get
Map
Set
Optics
Array
Choice
List
Map
Option
Result
Prism
AsyncValidatedLens<'a, 'b, 'e>
Epimorphism<'a, 'b>
Isomorphism<'a, 'b>
Lens<'a, 'b>
Prism<'a, 'b>
ValidatedLens<'a, 'b, 'e>
ValidatedPrism<'a, 'b, 'e>
CSharp
Helpers
Results
StringTypes
Data
Result
AggregateId
CID
IMessage
IMessageWithCID
LongString
MessageId
ModelError
Predicate
ShortString
ValueLens
ValueLensResultType<'Wrapped, 'Inner, 'Error>
ValueLensType<'Wrapped, 'Inner>
Version
FreeMonad
Eff
Free
Free<'Instruction, 'Result>
FreeBuilder
FreeResultBuilder
Validation
ValidateRegexes
FieldInfo<'T, 'T0, 'E>
ValidateResult<'T>
Validator<'E>
FCQRS.Serialization
Serialization
UnionConverter<'T>
UnionConverterFactory
FCQRS.SqlProvider
Query
FCQRS.ExpectoTickSpec
FeatureTest
Pending
Covers
Entry
FCQRS.Workflows
ChildSteps
Payload
Retry
Schedule
ScheduleRule
ScheduledWorkflow
Schedules
Workflow
WorkflowSteps
Workflows
AcceptedDue
AttemptContext
CatchUp
ChildHandle<'Result>
ErrorKind
Payload
RetryPolicy
ScheduleCommand
ScheduleEvent
ScheduleHandle
ScheduleRule
ScheduleSpec
ScheduleState
ScheduleView
ScheduledRun<'Input>
ScheduledWorkflow
StartResult
StepError
StepKind
Workflow<'T>
WorkflowBuilder
WorkflowDefinition<'Input, 'Result>
WorkflowDivergedException
WorkflowEnded<'Result>
WorkflowFlow
WorkflowHandle<'Input, 'Result>
WorkflowOutcome<'Result>
WorkflowRecord
WorkflowStatus
WorkflowStepFailedException
WorkflowTelemetry
CSharp
IWorkflowClient<'TInput, 'TResult>
RetryPolicyExtensions
ScheduleClient
ScheduleHost
SignalOutcome<'T>
Step<'T>
Step
StepAwaiter<'T>
StepAwaiter
Workflow<'TInput, 'TResult>
WorkflowCancelledException
WorkflowClient<'TWorkflow, 'TInput, 'TResult>
WorkflowContext
WorkflowFaultedException
WorkflowHost
WorkflowServiceExtensions
WorkflowTaskMethodBuilder<'T>