summary refs log tree commit diff
path: root/docs/sample_config.yaml
diff options
context:
space:
mode:
authorShay <hillerys@element.io>2022-03-11 10:46:45 -0800
committerGitHub <noreply@github.com>2022-03-11 10:46:45 -0800
commitef3619e61d84493d98470eb2a69131d15eb1166b (patch)
tree726cb8f378cb0d0352f751c98f181c6e7aa32051 /docs/sample_config.yaml
parentImplement a Jinja2 filter to extract localparts from email addresses (#12212) (diff)
downloadsynapse-ef3619e61d84493d98470eb2a69131d15eb1166b.tar.xz
Add config settings for background update parameters (#11980)
Diffstat (limited to 'docs/sample_config.yaml')
-rw-r--r--docs/sample_config.yaml32
1 files changed, 32 insertions, 0 deletions
diff --git a/docs/sample_config.yaml b/docs/sample_config.yaml
index d634fd8ff5..36c6c56e58 100644
--- a/docs/sample_config.yaml
+++ b/docs/sample_config.yaml
@@ -2735,3 +2735,35 @@ redis:
   # Optional password if configured on the Redis instance
   #
   #password: <secret_password>
+
+
+## Background Updates ##
+
+# Background updates are database updates that are run in the background in batches.
+# The duration, minimum batch size, default batch size, whether to sleep between batches and if so, how long to
+# sleep can all be configured. This is helpful to speed up or slow down the updates.
+#
+background_updates:
+    # How long in milliseconds to run a batch of background updates for. Defaults to 100. Uncomment and set
+    # a time to change the default.
+    #
+    #background_update_duration_ms: 500
+
+    # Whether to sleep between updates. Defaults to True. Uncomment to change the default.
+    #
+    #sleep_enabled: false
+
+    # If sleeping between updates, how long in milliseconds to sleep for. Defaults to 1000. Uncomment
+    # and set a duration to change the default.
+    #
+    #sleep_duration_ms: 300
+
+    # Minimum size a batch of background updates can be. Must be greater than 0. Defaults to 1. Uncomment and
+    # set a size to change the default.
+    #
+    #min_batch_size: 10
+
+    # The batch size to use for the first iteration of a new background update. The default is 100.
+    # Uncomment and set a size to change the default.
+    #
+    #default_batch_size: 50