wip

Author: calmh

advanced/option-database-tuning.rst

@@ -8,8 +8,6 @@ STTRACE
     Main and operational facilities:
         config
             Configuration loading and saving.
-        db
-            The database layer.
         main
             Main package.
         model
@@ -51,6 +49,8 @@ STTRACE
            REST API.
         sha256
             SHA256 hashing package (this facility currently unused).
+        sqlite
+            The SQLite database
         stats
             Persistent device and folder statistics.
         sync
@@ -113,14 +113,8 @@ STPERFSTATS
     Write running performance statistics to ``perf-$pid.csv``. Not supported on
     Windows.
 
-STRECHECKDBEVERY
-    Time before folder statistics (file, dir, ... counts) are recalculated from
-    scratch. The given duration must be parseable by Go's ``time.ParseDuration``. If
-    missing or not parseable, the default value of 1 month is used. To force
-    recalculation on every startup, set it to ``1s``.
-
-STGCINDIRECTEVERY
-    Sets the time interval in between database garbage collection runs.  The
+STDBMAINTINTERVAL
+    Sets the time interval in between database maintenance runs.  The
     given duration must be parseable by Go's ``time.ParseDuration``.
 
 GOMAXPROCS

includes/env-vars.rst

@@ -171,7 +171,6 @@ Returns the current configuration.
 	"stunServers": [
 	  "default"
 	],
-	"databaseTuning": "auto",
 	"maxConcurrentIncomingRequestKiB": 0,
 	"announceLANAddresses": true,
 	"sendFullIndexOnUpgrade": false,

rest/system-config-get.rst

@@ -16,7 +16,7 @@ and others.
       "certFile": "/home/user/.config/syncthing/cert.pem",
       "config": "/home/user/.config/syncthing/config.xml",
       "csrfTokens": "/home/user/.config/syncthing/csrftokens.txt",
-      "database": "/home/user/.local/share/syncthing/index-v0.14.0.db",
+      "database": "/home/user/.local/share/syncthing/index-v2.db",
       "defFolder": "/home/user/Sync",
       "guiAssets": "/home/user/src/syncthing/gui",
       "httpsCertFile": "/home/user/.config/syncthing/https-cert.pem",

rest/system-paths-get.rst

@@ -64,8 +64,8 @@ corresponding environment variables (``$STDATADIR`` or ``STHOMEDIR``).
 The database directory contains the following files, among others:
 
 :file:`index-{*}.db`
-    A directory holding the database with metadata and hashes of the files
-    currently on disk and available from peers.
+    The database with metadata and hashes of the files currently on disk and
+    available from peers.
 
 :file:`syncthing.log`
     Log output, on some systems.
@@ -188,7 +188,6 @@ The following shows an example of a default configuration file (IDs will differ)
             <stunKeepaliveStartS>180</stunKeepaliveStartS>
             <stunKeepaliveMinS>20</stunKeepaliveMinS>
             <stunServer>default</stunServer>
-            <databaseTuning>auto</databaseTuning>
             <maxConcurrentIncomingRequestKiB>0</maxConcurrentIncomingRequestKiB>
             <announceLANAddresses>true</announceLANAddresses>
             <sendFullIndexOnUpgrade>false</sendFullIndexOnUpgrade>
@@ -1046,7 +1045,6 @@ Options Element
         <stunKeepaliveStartS>180</stunKeepaliveStartS>
         <stunKeepaliveMinS>20</stunKeepaliveMinS>
         <stunServer>default</stunServer>
-        <databaseTuning>auto</databaseTuning>
         <maxConcurrentIncomingRequestKiB>0</maxConcurrentIncomingRequestKiB>
         <announceLANAddresses>true</announceLANAddresses>
         <sendFullIndexOnUpgrade>false</sendFullIndexOnUpgrade>
@@ -1306,13 +1304,6 @@ The ``options`` element contains all other global configuration options.
     feature. Set ``false`` to keep Syncthing from sending panic logs on serious
     troubles.  Defaults to ``true``, to help the developers troubleshoot.
 
-.. option:: options.databaseTuning
-
-    Controls how Syncthing uses the backend key-value database that stores the
-    index data and other persistent data it needs.  The available options and
-    implications are explained in a :doc:`separate chapter
-    </advanced/option-database-tuning>`.
-
 .. option:: options.maxConcurrentIncomingRequestKiB
 
     This limits how many bytes we have "in the air" in the form of response data

users/config.rst

@@ -69,8 +69,8 @@ version of the file. This version is called the *global* version and is the
 one that each device strives to be up to date with.
 
 This information is kept in the *index database*, which is stored in the
-configuration directory and called ``index-vx.y.z.db`` (for some version
-x.y.z which may not be exactly the version of Syncthing you're running).
+configuration or data directory and called ``index-*.db``, with some version
+number in place of the asterisk.
 
 When new index data is received from other devices Syncthing recalculates
 which version for each file should be the global version, and compares this

users/syncing.rst

@@ -32,11 +32,6 @@ is on an SSD. First some general options:
     performance. If the underlying storage is a large array of disk,
     then syncing many folders concurrently may be beneficial.
 
-- :opt:`databaseTuning`
-    Set to ``large``. Regardless of the size of the actual database, this
-    increases a number of buffers and settings to optimize for higher
-    throughput.
-
 - :opt:`maxConcurrentIncomingRequestKiB`
     This sets the maximum amount of data being processed (loaded from
     disk and transmitted over the network) concurrently at any given
@@ -152,11 +147,6 @@ General options:
 - :opt:`maxFolderConcurrency`
     Set to 1 to sync folders sequentially, reducing the peak memory usage.
 
-- :opt:`databaseTuning`
-    Set to ``small``. Regardless of the size of the actual database size,
-    this reduces the size of a number of buffers to optimize for reduced
-    memory usage.
-
 - :opt:`maxConcurrentIncomingRequestKiB`
     Set to 32 MiB to reduce the amount of memory used for buffering
     responses to incoming requests.