-
Notifications
You must be signed in to change notification settings - Fork 0
chore(docs): document projection runtime boundary #416
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
yordis
merged 1 commit into
master
from
yordis/chore-document-projection-runtime-boundary
Jul 1, 2026
+85
−0
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,64 @@ | ||
| --- | ||
| title: Architecture direction | ||
| --- | ||
|
|
||
| # Architecture direction | ||
|
|
||
| TrogonEventStore keeps the database node focused on the durable event log and | ||
| the operational work required to keep that log correct, available, and | ||
| observable. | ||
|
|
||
| The core node owns: | ||
|
|
||
| - Appending events to streams | ||
| - Reading events from streams and `$all` | ||
| - Replication and cluster membership | ||
| - Storage, scavenging, and archive recovery | ||
| - Authentication, authorization, diagnostics, and health | ||
| - Native indexes only when they are part of core database read semantics | ||
|
|
||
| This boundary keeps stream ownership simple and leaves room for future storage | ||
| and sharding work. Features that need their own compute model, query model, or | ||
| serving model should be separate components that consume the database through | ||
| subscriptions or reads. | ||
|
|
||
| ## Projection execution | ||
|
|
||
| Projection execution is future external component work by default. | ||
|
|
||
| User-defined projection runtimes, rich read models, custom query models, and | ||
| parallel projection engines should run outside the database process unless they | ||
| become an explicitly accepted native database capability. | ||
|
|
||
| This keeps the node from coupling append/read correctness to user code, | ||
| scripting runtimes, read-model storage, or projection-specific checkpoint | ||
| semantics. External projection components can scale independently, own their | ||
| checkpoint and read-model storage, and fail without taking the database node | ||
| with them. | ||
|
|
||
| ## System projections | ||
|
|
||
| Built-in system projections are different from a general projection execution | ||
| platform. | ||
|
|
||
| System projections such as `$streams`, `$by_category`, `$by_event_type`, | ||
| `$by_correlation_id`, and `$stream_by_category` exist for compatibility and | ||
| query convenience. They may remain as optional in-node behavior while clients | ||
| still depend on those streams. | ||
|
|
||
| New work should avoid expanding system projections into a broader in-node query | ||
| or read-model platform. If a capability can be implemented as an external | ||
| projection or subscription component, prefer the external boundary. | ||
|
|
||
| ## Multi-stream append | ||
|
|
||
| Multi-stream append is not required for the current system projection model. | ||
|
|
||
| Any future design that needs atomic writes across unrelated streams must be | ||
| reviewed as a core database semantics decision, not as projection plumbing. That | ||
| decision has consequences for stream independence, storage layout, and future | ||
| sharding. | ||
|
|
||
| Projection engines that need atomic checkpoint, state, and emitted-event writes | ||
| should prefer external checkpointing or component-owned storage unless the core | ||
| database explicitly accepts cross-stream write semantics. | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.