summary refs log tree commit diff
path: root/docs
diff options
context:
space:
mode:
authorreivilibre <oliverw@matrix.org>2022-07-07 11:08:04 +0100
committerGitHub <noreply@github.com>2022-07-07 10:08:04 +0000
commitfb7d24ab6de870ab21f83d49d9f1db569eff4b56 (patch)
treefbb0c79e009364d999e0d26ff93b82e7eb81c8bf /docs
parentMake `_get_state_map_for_room` not break when room state events don't contain... (diff)
downloadsynapse-fb7d24ab6de870ab21f83d49d9f1db569eff4b56.tar.xz
Check that `auto_vacuum` is disabled when porting a SQLite database to Postgres, as `VACUUM`s must not be performed between runs of the script. (#13195)
Diffstat (limited to 'docs')
-rw-r--r--docs/postgres.md8
1 files changed, 8 insertions, 0 deletions
diff --git a/docs/postgres.md b/docs/postgres.md
index cbc32e1836..f2519f6b0a 100644
--- a/docs/postgres.md
+++ b/docs/postgres.md
@@ -143,6 +143,14 @@ to do step 2.
 
 It is safe to at any time kill the port script and restart it.
 
+However, under no circumstances should the SQLite database be `VACUUM`ed between
+multiple runs of the script. Doing so can lead to an inconsistent copy of your database
+into Postgres.
+To avoid accidental error, the script will check that SQLite's `auto_vacuum` mechanism
+is disabled, but the script is not able to protect against a manual `VACUUM` operation
+performed either by the administrator or by any automated task that the administrator
+may have configured.
+
 Note that the database may take up significantly more (25% - 100% more)
 space on disk after porting to Postgres.