git.squeep.com Git - akkoma/blob - docs/docs/administration/CLI_tasks/database.md

   1 # Database maintenance tasks
   2
   3 {! administration/CLI_tasks/general_cli_task_info.include !}
   4
   5 !!! danger
   6     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.
   7
   8 ## Replace embedded objects with their references
   9
  10 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.
  11
  12 === "OTP"
  13
  14     ```sh
  15     ./bin/pleroma_ctl database remove_embedded_objects [option ...]
  16     ```
  17
  18 === "From Source"
  19
  20     ```sh
  21     mix pleroma.database remove_embedded_objects [option ...]
  22     ```
  23
  24
  25 ### Options
  26 - `--vacuum` - run `VACUUM FULL` after the embedded objects are replaced with their references
  27
  28 ## Prune old remote posts from the database
  29
  30 This will prune remote posts older than 90 days (configurable with [`config :pleroma, :instance, remote_post_retention_days`](../../configuration/cheatsheet.md#instance)) from the database. Pruned posts may be refetched in some cases.
  31
  32 !!! danger
  33     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.
  34
  35 === "OTP"
  36
  37     ```sh
  38     ./bin/pleroma_ctl database prune_objects [option ...]
  39     ```
  40
  41 === "From Source"
  42
  43     ```sh
  44     mix pleroma.database prune_objects [option ...]
  45     ```
  46
  47 ### Options
  48
  49 - `--keep-threads` - don't prune posts when they are part of a thread where at least one post has seen local interaction (e.g. one of the posts is a local post, or is favourited by a local user, or has been repeated by a local user...)
  50 - `--keep-non-public` - keep non-public posts like DM's and followers-only, even if they are remote
  51 - `--vacuum` - run `VACUUM FULL` after the objects are pruned
  52
  53 ## Create a conversation for all existing DMs
  54
  55 Can be safely re-run
  56
  57 === "OTP"
  58
  59     ```sh
  60     ./bin/pleroma_ctl database bump_all_conversations
  61     ```
  62
  63 === "From Source"
  64
  65     ```sh
  66     mix pleroma.database bump_all_conversations
  67     ```
  68
  69 ## Remove duplicated items from following and update followers count for all users
  70
  71 === "OTP"
  72
  73     ```sh
  74     ./bin/pleroma_ctl database update_users_following_followers_counts
  75     ```
  76
  77 === "From Source"
  78
  79     ```sh
  80     mix pleroma.database update_users_following_followers_counts
  81     ```
  82
  83 ## Fix the pre-existing "likes" collections for all objects
  84
  85 === "OTP"
  86
  87     ```sh
  88     ./bin/pleroma_ctl database fix_likes_collections
  89     ```
  90
  91 === "From Source"
  92
  93     ```sh
  94     mix pleroma.database fix_likes_collections
  95     ```
  96
  97 ## Vacuum the database
  98
  99 ### Analyze
 100
 101 Running an `analyze` vacuum job can improve performance by updating statistics used by the query planner. **It is safe to cancel this.**
 102
 103 === "OTP"
 104
 105     ```sh
 106     ./bin/pleroma_ctl database vacuum analyze
 107     ```
 108
 109 === "From Source"
 110
 111     ```sh
 112     mix pleroma.database vacuum analyze
 113     ```
 114
 115 ### Full
 116
 117 Running a `full` vacuum job rebuilds your entire database by reading all of the data and rewriting it into smaller
 118 and more compact files with an optimized layout. This process will take a long time and use additional disk space as
 119 it builds the files side-by-side the existing database files. It can make your database faster and use less disk space,
 120 but should only be run if necessary. **It is safe to cancel this.**
 121
 122 === "OTP"
 123
 124     ```sh
 125     ./bin/pleroma_ctl database vacuum full
 126     ```
 127
 128 === "From Source"
 129
 130     ```sh
 131     mix pleroma.database vacuum full
 132     ```
 133
 134 ## Add expiration to all local statuses
 135
 136 === "OTP"
 137
 138     ```sh
 139     ./bin/pleroma_ctl database ensure_expiration
 140     ```
 141
 142 === "From Source"
 143
 144     ```sh
 145     mix pleroma.database ensure_expiration
 146     ```
 147
 148 ## Change Text Search Configuration
 149
 150 Change `default_text_search_config` for database and (if necessary) text_search_config used in index, then rebuild index (it may take time).
 151
 152 === "OTP"
 153
 154     ```sh
 155     ./bin/pleroma_ctl database set_text_search_config english
 156     ```
 157
 158 === "From Source"
 159
 160     ```sh
 161     mix pleroma.database set_text_search_config english
 162     ```
 163
 164 See [PostgreSQL documentation](https://www.postgresql.org/docs/current/textsearch-configuration.html) and `docs/configuration/howto_search_cjk.md` for more detail.
 165
 166 ## Pruning old activities
 167
 168 Over time, transient `Delete` activities and `Tombstone` objects
 169 can accumulate in your database, inflating its size. This is not ideal.
 170 There is a periodic task to prune these transient objects,
 171 but on first run this may take a while on older instances to catch up
 172 to the current day.
 173
 174 === "OTP"
 175
 176     ```sh
 177     ./bin/pleroma_ctl database prune_task
 178     ```
 179
 180 === "From Source"
 181
 182     ```sh
 183     mix pleroma.database prune_task
 184     ```