git.squeep.com Git - akkoma/blob - docs/administration/CLI_tasks/database.md

   1 # Database maintenance tasks
   2
   3 {! backend/administration/CLI_tasks/general_cli_task_info.include !}
   4
   5 !!! danger
   6     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.
   7
   8 ## Replace embedded objects with their references
   9
  10 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.
  11
  12 ```sh tab="OTP"
  13 ./bin/pleroma_ctl database remove_embedded_objects [<options>]
  14 ```
  15
  16 ```sh tab="From Source"
  17 mix pleroma.database remove_embedded_objects [<options>]
  18 ```
  19
  20 ### Options
  21 - `--vacuum` - run `VACUUM FULL` after the embedded objects are replaced with their references
  22
  23 ## Prune old remote posts from the database
  24
  25 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.
  26
  27 !!! danger
  28     The disk space will only be reclaimed after `VACUUM FULL`. You may run out of disk space during the execution of the task or vacuuming if you don't have about 1/3rds of the database size free.
  29
  30 ```sh tab="OTP"
  31 ./bin/pleroma_ctl database prune_objects [<options>]
  32 ```
  33
  34 ```sh tab="From Source"
  35 mix pleroma.database prune_objects [<options>]
  36 ```
  37
  38 ### Options
  39 - `--vacuum` - run `VACUUM FULL` after the objects are pruned
  40
  41 ## Create a conversation for all existing DMs
  42
  43 Can be safely re-run
  44
  45 ```sh tab="OTP"
  46 ./bin/pleroma_ctl database bump_all_conversations
  47 ```
  48
  49 ```sh tab="From Source"
  50 mix pleroma.database bump_all_conversations
  51 ```
  52
  53 ## Remove duplicated items from following and update followers count for all users
  54
  55 ```sh tab="OTP"
  56 ./bin/pleroma_ctl database update_users_following_followers_counts
  57 ```
  58
  59 ```sh tab="From Source"
  60 mix pleroma.database update_users_following_followers_counts
  61 ```
  62
  63 ## Fix the pre-existing "likes" collections for all objects
  64
  65 ```sh tab="OTP"
  66 ./bin/pleroma_ctl database fix_likes_collections
  67 ```
  68
  69 ```sh tab="From Source"
  70 mix pleroma.database fix_likes_collections
  71 ```