Skip to content

Database maintenance tasks

Every command should be ran as the pleroma user from it's home directory. For example if you are superuser, you would have to wrap the command in su pleroma -s $SHELL -lc "$COMMAND".

From source note about MIX_ENV

The mix command should be prefixed with the name of environment your Pleroma server is running in, usually it's MIX_ENV=prod

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.

./bin/pleroma_ctl database remove_embedded_objects [option ...]
mix pleroma.database remove_embedded_objects [option ...]

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) from the database, they will be refetched from source when accessed.

Danger

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.

./bin/pleroma_ctl database prune_objects [option ...]
mix pleroma.database prune_objects [option ...]

Options

  • --vacuum - run VACUUM FULL after the objects are pruned

Create a conversation for all existing DMs

Can be safely re-run

./bin/pleroma_ctl database bump_all_conversations
mix pleroma.database bump_all_conversations

Remove duplicated items from following and update followers count for all users

./bin/pleroma_ctl database update_users_following_followers_counts
mix pleroma.database update_users_following_followers_counts

Fix the pre-existing "likes" collections for all objects

./bin/pleroma_ctl database fix_likes_collections
mix pleroma.database fix_likes_collections

Vacuum the database

Analyze

Running an analyze vacuum job can improve performance by updating statistics used by the query planner. It is safe to cancel this.

./bin/pleroma_ctl database vacuum analyze
mix pleroma.database vacuum analyze

Full

Running a full vacuum job rebuilds your entire database by reading all of the data and rewriting it into smaller and more compact files with an optimized layout. This process will take a long time and use additional disk space as it builds the files side-by-side the existing database files. It can make your database faster and use less disk space, but should only be run if necessary. It is safe to cancel this.

./bin/pleroma_ctl database vacuum full
mix pleroma.database vacuum full

Add expiration to all local statuses

./bin/pleroma_ctl database ensure_expiration
mix pleroma.database ensure_expiration