MirrorHub/construct
0
0
Fork 0
mirror of https://github.com/matrix-construct/construct synced 2024-11-21 17:31:21 +01:00
Code Issues Releases Wiki Activity

Updated Events dump and rebuild (markdown)

Jason Volk 2023-02-09 13:44:54 -08:00
parent 3e0e8b016b
commit daffcf50f4
1 changed files with 1 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
Events-dump-and-rebuild.md

@ -2,9 +2,7 @@
#### Dumping Events To File
All events stored in the database may be written to a single regular file. The format is a Matrix-canonical JSON array of Matrix event objects. Issue the following console command to dump events; progress updates will be logged at the INFO level and should be visible by default on standard output.
> 👉 While it is safe to dump events during normal service, we make no guarantee for whether new events processed after the start of the dump will be included. For optimal performance and results, conduct the dump in single-user mode by employing the `-single` program option.
The entire database can be written to a single regular file. The format is a canonical JSON array of Matrix event objects. Issue the following console command to dump events; progress updates will be logged at the INFO level and should be visible by default on standard output.
1. `events dump <path>`