make it absolutely clear that Purge History API does not remove all traces of events and message contents

because this topic pops up too often

#890 #1621 #1730 #2260 #2315 and so on
pull/2540/head
Ander Punnar 2017-10-14 13:25:42 +03:00 committed by GitHub
parent 6c1bb1601e
commit b2e02084b8
1 changed files with 2 additions and 0 deletions

View File

@ -4,6 +4,8 @@ Purge History API
The purge history API allows server admins to purge historic events from their The purge history API allows server admins to purge historic events from their
database, reclaiming disk space. database, reclaiming disk space.
**NB!** This will not delete local events (locally sent messages content etc) from the database, but will remove lots of the metadata about them and does dramatically reduce the on disk space usage
Depending on the amount of history being purged a call to the API may take Depending on the amount of history being purged a call to the API may take
several minutes or longer. During this period users will not be able to several minutes or longer. During this period users will not be able to
paginate further back in the room from the point being purged from. paginate further back in the room from the point being purged from.