summaryrefslogtreecommitdiff
path: root/docs/administration/CLI_tasks
diff options
context:
space:
mode:
authorMark Felder <feld@FreeBSD.org>2020-05-29 10:17:06 -0500
committerMark Felder <feld@FreeBSD.org>2020-05-29 10:17:06 -0500
commit1b586ff3aece21d277e40f95cc5c60fc15818a87 (patch)
tree0f84501e716bece20a06d1b31857cfc8f5fdc1c6 /docs/administration/CLI_tasks
parent92fba24c743a5d2d9ed78df7499fd3123a6ad6ac (diff)
downloadpleroma-1b586ff3aece21d277e40f95cc5c60fc15818a87.tar.gz
pleroma-1b586ff3aece21d277e40f95cc5c60fc15818a87.zip
Document new database vacuum tasks
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