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

Add information on running options to README and --help output (#51)

Browse Source
This commit is contained in:
Azrenbeth
2021-09-06 09:59:04 +01:00
committed by GitHub
parent 0f7f2c2660
commit 3b5d7fd176
2 changed files with 86 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

23
src/lib.rs
View File

@@ -120,7 +120,10 @@ impl Config {
Arg::with_name("postgres-url")
.short("p")
.value_name("URL")
.help("The url for connecting to the postgres database")
.help("The url for connecting to the postgres database.")
.long_help(concat!(
"The url for connecting to the postgres database.This should be of",
" the form \"postgresql://username:password@mydomain.com/database\""))
.takes_value(true)
.required(true),
).arg(
@@ -128,6 +131,10 @@ impl Config {
.short("r")
.value_name("ROOM_ID")
.help("The room to process")
.long_help(concat!(
"The room to process. This is the value found in the rooms table of the database",
" not the common name for the room - is should look like: \"!wOlkWNmgkAZFxbTaqj:matrix.org\""
))
.takes_value(true)
.required(true),
).arg(
@@ -142,13 +149,17 @@ impl Config {
.short("m")
.value_name("COUNT")
.help("Abort if fewer than COUNT rows would be saved")
.long_help("If the compressor cannot save this many rows from the database then it will stop early")
.takes_value(true)
.required(false),
).arg(
Arg::with_name("groups_to_compress")
.short("n")
.value_name("GROUPS_TO_COMPRESS")
.help("How many groups to load into memory to compress")
.help("How many groups to load into memory to compress")
.long_help(concat!(
"How many groups to load into memory to compress (starting from",
" the 1st group in the room or the group specified by -s)"))
.takes_value(true)
.required(false),
).arg(
@@ -188,11 +199,17 @@ impl Config {
Arg::with_name("transactions")
.short("t")
.help("Whether to wrap each state group change in a transaction")
.long_help(concat!("If this flag is set then then each change to a particular",
" state group is wrapped in a transaction. This should be done if you wish to",
" apply the changes while synapse is still running."))
.requires("output_file"),
).arg(
Arg::with_name("graphs")
.short("g")
.help("Whether to produce graphs of state groups before and after compression instead of SQL")
.help("Output before and after graphs")
.long_help(concat!("If this flag is set then output the node and edge information for",
" the state_group directed graph built up from the predecessor state_group links.",
" These can be looked at in something like Gephi (https://gephi.org)"))
).get_matches();
let db_url = matches