diff options
| author | Richard van der Hoff <1389908+richvdh@users.noreply.github.com> | 2019-11-04 12:40:18 +0000 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2019-11-04 12:40:18 +0000 |
| commit | cc6243b4c08bfae77c9ff29d23c40568ab284924 (patch) | |
| tree | 11ede90138ce8740735cc098407306f0d4393aac /docs | |
| parent | Merge pull request #6301 from matrix-org/babolivier/msc2326 (diff) | |
| download | synapse-cc6243b4c08bfae77c9ff29d23c40568ab284924.tar.xz | |
document the REPLICATE command a bit better (#6305)
since I found myself wonder how it works
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/tcp_replication.md | 15 |
1 files changed, 14 insertions, 1 deletions
diff --git a/docs/tcp_replication.md b/docs/tcp_replication.md index e099d8a87b..ba9e874d07 100644 --- a/docs/tcp_replication.md +++ b/docs/tcp_replication.md @@ -199,7 +199,20 @@ client (C): #### REPLICATE (C) - Asks the server to replicate a given stream +Asks the server to replicate a given stream. The syntax is: + +``` + REPLICATE <stream_name> <token> +``` + +Where `<token>` may be either: + * a numeric stream_id to stream updates since (exclusive) + * `NOW` to stream all subsequent updates. + +The `<stream_name>` is the name of a replication stream to subscribe +to (see [here](../synapse/replication/tcp/streams/_base.py) for a list +of streams). It can also be `ALL` to subscribe to all known streams, +in which case the `<token>` must be set to `NOW`. #### USER_SYNC (C) |