Documentation
Learn the actor and event model, then choose the integrations and operational contracts your application needs.
Choose a path
Start
Get started
Requirements, installation, and the first steps for a Troolio host.
Read guide →STARTHow Troolio works
A visual tour of commands, events, state, projections, and routes.
Read guide →STARTModel a command
Turn a domain rule into a command, event, and actor handler.
Read guide →STARTBuild your first actor
A counter actor example with commands, events, and state replay.
Read guide →STARTBuild a workshop workflow
Follow an original application example from command through orchestration, SQL views, and queries.
Read guide →STARTConfigure a host
Register packages, actor assemblies, stores, and Orleans services.
Read guide →STARTClient calls and routing
Send actor messages and configure a cluster client.
Read guide →Foundations
Actors and commands
Actor roles, typed commands, queries, and dispatch.
Read guide →FOUNDATIONSEvents and state
Event history, state replay, and lifecycle.
Read guide →FOUNDATIONSStores and serialization
Persistence contracts and event formats.
Read guide →FOUNDATIONSStreams and subscriptions
Event streams, subscriptions, and queues.
Read guide →FOUNDATIONSProjections and read models
Asynchronous views over committed events.
Read guide →FOUNDATIONSReliable jobs
Queue-backed jobs and reminder boundaries.
Read guide →FOUNDATIONSMessage metadata
Understand every Metadata field, identity lifetime, and the current dispatch behavior.
Read guide →FOUNDATIONSCorrelation and causation
Follow a branching workflow and distinguish diagnostics from durable retry identity.
Read guide →FOUNDATIONSActor boundaries and identity
Choose actor keys and place invariants with the state that decides them.
Read guide →FOUNDATIONSCQRS in practice
Separate business decisions from query-shaped views and explain consistency to callers.
Read guide →FOUNDATIONSReplay and live events
Keep state restoration pure and give projection repair its own bounded pipeline.
Read guide →Patterns
Orchestration workflows
Design event-to-command workflows, durable long-running work, and explicit failure outcomes.
Read guide →PATTERNSDesign a durable projection
Map live committed events into indexed SQL views with recoverable, idempotent writes.
Read guide →PATTERNSDesign read models
Choose immutable event-folded views or durable SQL models and enforce the current caller’s scope.
Read guide →PATTERNSIdempotency and ordering
Choose durable source identities, handle duplicates, and distinguish snapshot from delta projections.
Read guide →PATTERNSRealtime read-model updates
Notify clients after projection commit and refresh through an authorized query.
Read guide →PATTERNSNotifications and background work
Separate notification facts, durable provider effects, scheduled jobs, and actor replay.
Read guide →Transactions
Selected command route
Admission and planning for atomic command execution.
Read guide →TRANSACTIONSAtomic commit
Closed event transactions and completion receipts.
Read guide →TRANSACTIONSRoute authority
Deployment fences, admission, and trust.
Read guide →TRANSACTIONSOrchestration
Event-only planning and durable subscriber delivery.
Read guide →TRANSACTIONSExternal effects
Durable intents, idempotency, and reminders.
Read guide →TRANSACTIONSRecovery
Retries and pending work across providers.
Read guide →Integrations
Agents package
Agent definition and run actors.
Read guide →INTEGRATIONSSQL Server integration
SQL Server transactions, queues, routes, and recovery.
Read guide →INTEGRATIONSKurrentDB integration
KurrentDB append and selected-route integration.
Read guide →INTEGRATIONSKurrentDB with SQL Server
SQL journals and broker coordination for KurrentDB.
Read guide →Operations
Security and retention
Ingress trust, credentials, erasure, and evidence lifetime.
Read guide →OPERATIONSTesting applications
Test actor logic, provider guarantees, and recovery.
Read guide →OPERATIONSUpgrade and migration
Move a host to 10.0.6 with replay, schema, and route checks.
Read guide →OPERATIONSTroubleshooting
Investigate conflicts, pending work, and uncertain outcomes.
Read guide →OPERATIONSDeployment checklist
Checks for a production host and providers.
Read guide →OPERATIONSProjection catch-up and rebuilds
Recover missed deliveries and evolve views with bounded background work and durable progress.
Read guide →OPERATIONSTracing and observability
Connect business correlation, causation, source positions, and .NET trace spans.
Read guide →Reference
Packages and compatibility
NuGet packages, versions, and compatibility.
Read guide →REFERENCEAPI map
Public contracts by framework area.
Read guide →REFERENCEGlossary
Terms used across Troolio guides.
Read guide →REFERENCERelease notes: 10.0.6
What changed in the public 10.0.6 package release.
Read guide →Samples
Run the Calculator sample
Start with commands, events and a query through a real actor.
Read guide →SAMPLESBuild the ToDo API
Follow HTTP commands, pure replay and durable SQLite read models.
Read guide →SAMPLESExplore Shopping List
Learn collaboration, orchestration, authorized catalog queries and tracing.
Read guide →Extensions
EF Core projections
Map live actor events to relational read models with EF Core 10.
Read guide →EXTENSIONSRedis projections
Build derived hashes, partitions and bounded change-feed readers.
Read guide →EXTENSIONSMarten event storage
Store ordinary actor events and snapshots in PostgreSQL.
Read guide →EXTENSIONSOrdinary gRPC event storage
Use the EventStore extension with current KurrentDB transport.
Read guide →