diff options
author | rinpatch <rinpatch@sdf.org> | 2019-10-03 11:17:29 +0300 |
---|---|---|
committer | rinpatch <rinpatch@sdf.org> | 2019-10-03 11:17:29 +0300 |
commit | 6baa037903e06c80a5b5f1c34b2cfdd471ba2f8f (patch) | |
tree | ddcef34f150cb8bed9f398deff003277ef750318 /docs/administration/CLI_tasks | |
parent | 8e08d5b2336bdb6108ec5df15b7b642e0bc2acad (diff) | |
download | pleroma-6baa037903e06c80a5b5f1c34b2cfdd471ba2f8f.tar.gz |
Move database maintenance tasks docs to a separate file
Diffstat (limited to 'docs/administration/CLI_tasks')
-rw-r--r-- | docs/administration/CLI_tasks/database.md | 48 |
1 files changed, 48 insertions, 0 deletions
diff --git a/docs/administration/CLI_tasks/database.md b/docs/administration/CLI_tasks/database.md new file mode 100644 index 000000000..484639231 --- /dev/null +++ b/docs/administration/CLI_tasks/database.md @@ -0,0 +1,48 @@ +# Database maintenance tasks + +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`. + +## 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. + +```sh +$PREFIX remove_embedded_objects [<options>] +``` + +### Options +- `--vacuum` - run `VACUUM FULL` after the embedded objects are replaced with their references + +## Prune old remote posts from the database + +This will prune remote posts older than 90 days (configurable with [`config :pleroma, :instance, remote_post_retention_days`](../../configuration/cheatsheet.md#instance)) from the database, they will be refetched from source when accessed. + +!!! note + The disk space will only be reclaimed after `VACUUM FULL` + +```sh +$PREFIX pleroma.database prune_objects [<options>] +``` + +### Options +- `--vacuum` - run `VACUUM FULL` after the objects are pruned + +## Create a conversation for all existing DMs + +Can be safely re-run + +```sh +$PREFIX bump_all_conversations +``` + +## Remove duplicated items from following and update followers count for all users + +```sh +$PREFIX update_users_following_followers_counts +``` + +## Fix the pre-existing "likes" collections for all objects + +```sh +$PREFIX fix_likes_collections +``` |