heimoshuiyu/rust-synapse-compress-state
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update readme

Browse Source
This commit is contained in:
Erik Johnston
2018-09-18 15:50:10 +01:00
parent 096467853d
commit 78549a76b6
1 changed files with 8 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
README.md
View File

@@ -8,7 +8,10 @@ This tool currently *does not* write to the database in any way, so should be
safe to run. If the `-o` option is specified then SQL will be written to the
given file that would change the tables to match the calculated state. (Note
that if `-t` is given then each change to a particular state group is wrapped
in a transaction)
in a transaction).
The tool will also ensure that the generated state deltas do give the same state
as the existing state deltas.
## Algorithm
@@ -26,6 +29,10 @@ L2 <-------------------- L2 <---------- ...
The sizes and number of levels used can be controlled via `-l`.
**Note**: Increasing the sum of the sizes of levels will increase the time it
takes for to query the full state of a given state group. By default Synapse
attempts to keep this below 100.
## Example