aboutsummaryrefslogtreecommitdiff
path: root/docs/administration/CLI_tasks
diff options
context:
space:
mode:
authorRoman Chvanikov <chvanikoff@pm.me>2020-05-30 17:12:23 +0300
committerRoman Chvanikov <chvanikoff@pm.me>2020-05-30 17:12:23 +0300
commit32f0bd9a50e298b008b601683286e2b75edad93b (patch)
tree52147eb250548391f5007511f79ecf1975857400 /docs/administration/CLI_tasks
parentfddba6739de7e5f07f14338ccf5310a143a498cd (diff)
parentbeeeed5b58193069798c5b754863244e97e68756 (diff)
downloadpleroma-32f0bd9a50e298b008b601683286e2b75edad93b.tar.gz
Merge branch 'develop' into refactor/fe-bundles
Diffstat (limited to 'docs/administration/CLI_tasks')
-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