diff options
| author | Erik Johnston <erikj@jki.re> | 2017-04-12 10:21:42 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2017-04-12 10:21:42 +0100 |
| commit | bf9060156a18a747adb23589d124370d378d38a0 (patch) | |
| tree | dcab6af4131b8c3a61620225bb537cb594ed815c /docs/replication.rst | |
| parent | Merge pull request #2118 from matrix-org/erikj/no_devices (diff) | |
| parent | Remove last reference to worker_replication_url (diff) | |
| download | synapse-bf9060156a18a747adb23589d124370d378d38a0.tar.xz | |
Merge pull request #2117 from matrix-org/erikj/remove_http_replication
Remove HTTP replication APIs
Diffstat (limited to 'docs/replication.rst')
| -rw-r--r-- | docs/replication.rst | 26 |
1 files changed, 4 insertions, 22 deletions
diff --git a/docs/replication.rst b/docs/replication.rst index 7e37e71987..310abb3488 100644 --- a/docs/replication.rst +++ b/docs/replication.rst @@ -26,28 +26,10 @@ expose the append-only log to the readers should be fairly minimal. Architecture ------------ -The Replication API -~~~~~~~~~~~~~~~~~~~ - -Synapse will optionally expose a long poll HTTP API for extracting updates. The -API will have a similar shape to /sync in that clients provide tokens -indicating where in the log they have reached and a timeout. The synapse server -then either responds with updates immediately if it already has updates or it -waits until the timeout for more updates. If the timeout expires and nothing -happened then the server returns an empty response. - -However unlike the /sync API this replication API is returning synapse specific -data rather than trying to implement a matrix specification. The replication -results are returned as arrays of rows where the rows are mostly lifted -directly from the database. This avoids unnecessary JSON parsing on the server -and hopefully avoids an impedance mismatch between the data returned and the -required updates to the datastore. - -This does not replicate all the database tables as many of the database tables -are indexes that can be recovered from the contents of other tables. - -The format and parameters for the api are documented in -``synapse/replication/resource.py``. +The Replication Protocol +~~~~~~~~~~~~~~~~~~~~~~~~ + +See ``tcp_replication.rst`` The Slaved DataStore |