Software Heritage Storage tools.
swh storage [OPTIONS] COMMAND [ARGS]...
- -C, --config-file <config_file>
- --check-config <check_config>
Check the configuration of the storage at startup for read or write access; if set, override the value present in the configuration file if any. Defaults to ‘read’ for the ‘backfill’ command, and ‘write’ for ‘rpc-server’ and ‘replay’ commands.
no | read | write
Run the backfiller
The backfiller list objects from a Storage and produce journal entries from there.
Typically used to rebuild a journal or compensate for missing objects in a journal (eg. due to a downtime of this later).
The configuration file requires the following entries:
brokers: a list of kafka endpoints (the journal) in which entries will be added.
storage_dbconn: URL to connect to the storage DB.
prefix: the prefix of the topics (topics will be <prefix>.<object_type>).
client_id: the kafka client ID.
swh storage backfill [OPTIONS] OBJECT_TYPE
- --start-object <start_object>
- --end-object <end_object>
Fill a Storage by reading a Journal.
There can be several ‘replayers’ filling a Storage as long as they use the same group-id.
swh storage replay [OPTIONS]
- -n, --stop-after-objects <stop_after_objects>
Stop after processing this many objects. Default is to run forever.
Software Heritage Storage RPC server.
Do NOT use this in a production environment.
swh storage rpc-serve [OPTIONS]
- --host <IP>
Host ip address to bind the server on
- --port <PORT>
Binding port of the server
- --debug, --no-debug
Indicates if the server should run in debug mode