summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorlain <lain@soykaf.club>2019-11-15 14:30:59 +0100
committerlain <lain@soykaf.club>2019-11-15 14:30:59 +0100
commit234c27cb2024e49f49ac6e82f9963752e92103ee (patch)
tree408b6765bfbc5832514594d16bf04a4d23a7e8fd
parent09b4f7269e5307f29fc8ca7b548e93cd93836dc5 (diff)
Documentation: Add warning about database mix tasks.
-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.