1 # Database maintenance tasks
3 {! 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. Pruned posts may be refetched in some cases.
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 ...]
49 - `--keep-threads` - don't prune posts when they are part of a thread where at least one post has seen local interaction (e.g. one of the posts is a local post, or is favourited by a local user, or has been repeated by a local user...)
50 - `--keep-non-public` - keep non-public posts like DM's and followers-only, even if they are remote
51 - `--vacuum` - run `VACUUM FULL` after the objects are pruned
53 ## Create a conversation for all existing DMs
60 ./bin/pleroma_ctl database bump_all_conversations
66 mix pleroma.database bump_all_conversations
69 ## Remove duplicated items from following and update followers count for all users
74 ./bin/pleroma_ctl database update_users_following_followers_counts
80 mix pleroma.database update_users_following_followers_counts
83 ## Fix the pre-existing "likes" collections for all objects
88 ./bin/pleroma_ctl database fix_likes_collections
94 mix pleroma.database fix_likes_collections
97 ## Vacuum the database
101 Running an `analyze` vacuum job can improve performance by updating statistics used by the query planner. **It is safe to cancel this.**
106 ./bin/pleroma_ctl database vacuum analyze
112 mix pleroma.database vacuum analyze
117 Running a `full` vacuum job rebuilds your entire database by reading all of the data and rewriting it into smaller
118 and more compact files with an optimized layout. This process will take a long time and use additional disk space as
119 it builds the files side-by-side the existing database files. It can make your database faster and use less disk space,
120 but should only be run if necessary. **It is safe to cancel this.**
125 ./bin/pleroma_ctl database vacuum full
131 mix pleroma.database vacuum full
134 ## Add expiration to all local statuses
139 ./bin/pleroma_ctl database ensure_expiration
145 mix pleroma.database ensure_expiration
148 ## Change Text Search Configuration
150 Change `default_text_search_config` for database and (if necessary) text_search_config used in index, then rebuild index (it may take time).
155 ./bin/pleroma_ctl database set_text_search_config english
161 mix pleroma.database set_text_search_config english
164 See [PostgreSQL documentation](https://www.postgresql.org/docs/current/textsearch-configuration.html) and `docs/configuration/howto_search_cjk.md` for more detail.
166 ## Pruning old activities
168 Over time, transient `Delete` activities and `Tombstone` objects
169 can accumulate in your database, inflating its size. This is not ideal.
170 There is a periodic task to prune these transient objects,
171 but on first run this may take a while on older instances to catch up
177 ./bin/pleroma_ctl database prune_task
183 mix pleroma.database prune_task