aboutsummaryrefslogtreecommitdiff
path: root/docs/administration/CLI_tasks/database.md
diff options
context:
space:
mode:
authorEgor Kislitsyn <egor@kislitsyn.com>2020-06-04 13:28:00 +0400
committerEgor Kislitsyn <egor@kislitsyn.com>2020-06-04 13:28:00 +0400
commitb4d5bdd6f1c473280b8b9bbad96e9efecb45b298 (patch)
tree6d08f332f7bd1bc20f7bd3904987850173f90af0 /docs/administration/CLI_tasks/database.md
parent06f20e918129b1f434783b64d59b5ae6b4b4ed51 (diff)
parentd6693a91028ab3ee7865f530f3ad2532542fc2d2 (diff)
downloadpleroma-b4d5bdd6f1c473280b8b9bbad96e9efecb45b298.tar.gz
Merge branch 'develop' into openapi/admin/config
Diffstat (limited to 'docs/administration/CLI_tasks/database.md')
-rw-r--r--docs/administration/CLI_tasks/database.md29
1 files changed, 29 insertions, 0 deletions
diff --git a/docs/administration/CLI_tasks/database.md b/docs/administration/CLI_tasks/database.md
index ff400c8ed..647f6f274 100644
--- a/docs/administration/CLI_tasks/database.md
+++ b/docs/administration/CLI_tasks/database.md
@@ -69,3 +69,32 @@ mix pleroma.database update_users_following_followers_counts
```sh tab="From Source"
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.**
+
+```sh tab="OTP"
+./bin/pleroma_ctl database vacuum analyze
+```
+
+```sh tab="From Source"
+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.**
+
+```sh tab="OTP"
+./bin/pleroma_ctl database vacuum full
+```
+
+```sh tab="From Source"
+mix pleroma.database vacuum full
+``` \ No newline at end of file