Skip to content
This repository has been archived by the owner on Apr 26, 2024. It is now read-only.

Add notes describing Synapse's streams #16015

Merged
merged 9 commits into from
Aug 7, 2023
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/development/synapse_architecture/streams.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,13 +14,13 @@ Only "writers" can add facts to a stream, and there may be multiple writers.
Each fact has an ID, called its "stream ID".
Readers should only process facts in ascending stream ID order.

Roughly speaking\[*\], each stream is backed by a database table.
DMRobertson marked this conversation as resolved.
Show resolved Hide resolved
Roughly speaking, each stream is backed by a database table.
It should have a `stream_id` column holding stream IDs, plus additional columns
as necessary to describe the fact.
(Note that it may take multiple rows (with the same `stream_id`) to describe that fact.)
Stream IDs are globally unique (enforced by Postgres sequences).

>\[*\]: Some additional notes on streams' backing tables.
> _Aside_. Less roughly speaking, here are some additional notes on streams' backing tables.
DMRobertson marked this conversation as resolved.
Show resolved Hide resolved
>
> 1. Rich would like to [ditch the backing tables](https://github.com/matrix-org/synapse/issues/13456).
> 2. The backing tables may have other uses.
Expand Down
Loading