aboutsummaryrefslogtreecommitdiff
path: root/docs/administration/CLI_tasks/database.md
diff options
context:
space:
mode:
authorEgor Kislitsyn <egor@kislitsyn.com>2020-06-02 18:50:37 +0400
committerEgor Kislitsyn <egor@kislitsyn.com>2020-06-02 18:50:37 +0400
commit68cb152a0861618035ac48a0e0b455f74d9b767c (patch)
treecb2f14ed088efa0ab5b6952ee7d74d69f524387a /docs/administration/CLI_tasks/database.md
parentcbcd592300673582e38d0bf539dcdb9a2c1985a1 (diff)
parent879304dcd94c778b3cdaa2b82f69fccf2b37090c (diff)
downloadpleroma-68cb152a0861618035ac48a0e0b455f74d9b767c.tar.gz
Merge branch 'develop' into openapi/admin/relay
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