summary refs log tree commit diff
path: root/synapse/storage/schema
diff options
context:
space:
mode:
authorErik Johnston <erik@matrix.org>2017-01-26 16:30:37 +0000
committerErik Johnston <erik@matrix.org>2017-01-26 16:33:21 +0000
commitfbfad76c03afe7538c67205ceb30825d9ce4fb07 (patch)
treee55a45bf12542f968fa1099af8fdd368a24331b5 /synapse/storage/schema
parentImplement device key caching over federation (diff)
downloadsynapse-fbfad76c03afe7538c67205ceb30825d9ce4fb07.tar.xz
Add comments
Diffstat (limited to 'synapse/storage/schema')
-rw-r--r--synapse/storage/schema/delta/40/device_list_streams.sql8
1 files changed, 7 insertions, 1 deletions
diff --git a/synapse/storage/schema/delta/40/device_list_streams.sql b/synapse/storage/schema/delta/40/device_list_streams.sql
index d1051c6ddf..8348c143c3 100644
--- a/synapse/storage/schema/delta/40/device_list_streams.sql
+++ b/synapse/storage/schema/delta/40/device_list_streams.sql
@@ -13,7 +13,7 @@
  * limitations under the License.
  */
 
-
+-- Cache of remote devices.
 CREATE TABLE device_lists_remote_cache (
     user_id TEXT NOT NULL,
     device_id TEXT NOT NULL,
@@ -23,6 +23,8 @@ CREATE TABLE device_lists_remote_cache (
 CREATE INDEX device_lists_remote_cache_id ON device_lists_remote_cache(user_id, device_id);
 
 
+-- The last update we got for a user. Empty if we're not receiving updates for
+-- that user.
 CREATE TABLE device_lists_remote_extremeties (
     user_id TEXT NOT NULL,
     stream_id TEXT NOT NULL
@@ -31,6 +33,7 @@ CREATE TABLE device_lists_remote_extremeties (
 CREATE INDEX device_lists_remote_extremeties_id ON device_lists_remote_extremeties(user_id, stream_id);
 
 
+-- Stream of device lists updates. Includes both local and remotes
 CREATE TABLE device_lists_stream (
     stream_id BIGINT NOT NULL,
     user_id TEXT NOT NULL,
@@ -40,6 +43,9 @@ CREATE TABLE device_lists_stream (
 CREATE INDEX device_lists_stream_id ON device_lists_stream(stream_id, user_id);
 
 
+-- The stream of updates to send to other servers. We keep at least one row
+-- per user that was sent so that the prev_id for any new updates can be
+-- calculated
 CREATE TABLE device_lists_outbound_pokes (
     destination TEXT NOT NULL,
     stream_id BIGINT NOT NULL,