search

matrix-org / rust-synapse-compress-state

A tool to compress some state in a Synapse instance's database
https://pypi.org/project/synapse-auto-compressor/
Apache License 2.0
142 stars 32 forks source link

Incorrect example usage in README #125

Closed PaarthShah closed 11 months ago

PaarthShah commented 11 months ago

As of compiling the current latest, I'm seeing the following in --help:

Usage: synapse_compress_state [OPTIONS] -p <POSTGRES_LOCATION> -r <ROOM_ID>

Which is inconsistent with an example usage shown in the README (which is missing the required -r parameter): https://github.com/matrix-org/rust-synapse-compress-state/blob/8dc70fec8df33639bab1733bc88a40c1ed0f20b3/README.md#example-usage

synapse_auto_compressor -p postgresql://user:pass@localhost/synapse -c 500 -n 100
reivilibre commented 11 months ago

I believe synapse_compress_state and synapse_auto_compressor are different tools both packaged in this repository — if I remember properly, the auto compressor automatically finds rooms that could benefit from optimisation and then applies the compressor on those automatically, whereas the synapse_compress_state tool wants you to specify a room yourself.

PaarthShah commented 11 months ago

That makes a lot of sense, oops!