summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorrinpatch <rinpatch@sdf.org>2019-11-15 19:38:52 +0000
committerrinpatch <rinpatch@sdf.org>2019-11-15 19:38:52 +0000
commit9e3868425ae023760f93485e109da083d5f68b8d (patch)
treef7a271c11697e03cdb07221f60de8ff05fe46118
parent22554ac5ca056c2db627fc2daa5ffc8710be5c89 (diff)
parent234c27cb2024e49f49ac6e82f9963752e92103ee (diff)
Merge branch 'mix-task-warning' into 'develop'
Documentation: Add warning about database mix tasks. See merge request pleroma/pleroma!1984
-rw-r--r--docs/administration/CLI_tasks/database.md3
1 files changed, 3 insertions, 0 deletions
diff --git a/docs/administration/CLI_tasks/database.md b/docs/administration/CLI_tasks/database.md
index 484639231..3011646c8 100644
--- a/docs/administration/CLI_tasks/database.md
+++ b/docs/administration/CLI_tasks/database.md
@@ -2,6 +2,9 @@
Every command should be ran with a prefix, in case of OTP releases it is `./bin/pleroma_ctl database` and in case of source installs it's `mix pleroma.database`.
+!!! danger
+ These mix tasks can take a long time to complete. Many of them were written to address specific database issues that happened because of bugs in migrations or other specific scenarios. Do not run these tasks "just in case" if everything is fine your instance.
+
## Replace embedded objects with their references
Replaces embedded objects with references to them in the `objects` table. Only needs to be ran once if the instance was created before Pleroma 1.0.5. The reason why this is not a migration is because it could significantly increase the database size after being ran, however after this `VACUUM FULL` will be able to reclaim about 20% (really depends on what is in the database, your mileage may vary) of the db size before the migration.