1 # Database maintenance tasks
3 {! backend/administration/CLI_tasks/general_cli_task_info.include !}
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.
8 ## Replace embedded objects with their references
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.
15 ./bin/pleroma_ctl database remove_embedded_objects [option ...]
21 mix pleroma.database remove_embedded_objects [option ...]
26 - `--vacuum` - run `VACUUM FULL` after the embedded objects are replaced with their references
28 ## Prune old remote posts from the database
30 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.
33 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.
38 ./bin/pleroma_ctl database prune_objects [option ...]
44 mix pleroma.database prune_objects [option ...]
48 - `--vacuum` - run `VACUUM FULL` after the objects are pruned
50 ## Create a conversation for all existing DMs
57 ./bin/pleroma_ctl database bump_all_conversations
63 mix pleroma.database bump_all_conversations
66 ## Remove duplicated items from following and update followers count for all users
71 ./bin/pleroma_ctl database update_users_following_followers_counts
77 mix pleroma.database update_users_following_followers_counts
80 ## Fix the pre-existing "likes" collections for all objects
85 ./bin/pleroma_ctl database fix_likes_collections
91 mix pleroma.database fix_likes_collections
94 ## Vacuum the database
98 Running an `analyze` vacuum job can improve performance by updating statistics used by the query planner. **It is safe to cancel this.**
103 ./bin/pleroma_ctl database vacuum analyze
109 mix pleroma.database vacuum analyze
114 Running a `full` vacuum job rebuilds your entire database by reading all of the data and rewriting it into smaller
115 and more compact files with an optimized layout. This process will take a long time and use additional disk space as
116 it builds the files side-by-side the existing database files. It can make your database faster and use less disk space,
117 but should only be run if necessary. **It is safe to cancel this.**
122 ./bin/pleroma_ctl database vacuum full
128 mix pleroma.database vacuum full
131 ## Add expiration to all local statuses
136 ./bin/pleroma_ctl database ensure_expiration
142 mix pleroma.database ensure_expiration
145 ## Change Text Search Configuration
147 Change `default_text_search_config` for database and (if necessary) text_search_config used in index, then rebuild index (it may take time).
152 ./bin/pleroma_ctl database set_text_search_config english
158 mix pleroma.database set_text_search_config english
161 See [PostgreSQL documentation](https://www.postgresql.org/docs/current/textsearch-configuration.html) and `docs/configuration/howto_search_cjk.md` for more detail.