Skip to content

Commit 00169c9

Browse files
authored
DOC-8444 -- document conpact_interval_days config item (couchbase#508)
https://issues.couchbase.com/browse/DOC-8444 document databases.{db}.compact_interval_days config option, missing since introduction at 2.6
1 parent e5df83c commit 00169c9

File tree

1 file changed

+16
-4
lines changed
  • modules/ROOT/assets/attachments

1 file changed

+16
-4
lines changed

modules/ROOT/assets/attachments/sg.yaml

Lines changed: 16 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
type: object
21
properties:
32
adminInterface:
43
description: Port or TCP network address (IP address and the port) that the Admin REST API listens on. The loopback address prefix before the port (`127.0.0.1`) means the interface will not be reachable from other hosts. To make it reachable, change it to ":4985".
@@ -86,13 +85,26 @@ properties:
8685
default: the database name
8786
bucket_op_timeout_ms:
8887
type: integer
89-
description: |+
90-
Configures how long Sync Gateway should wait for a bucket operation to complete before timing out and trying again. The value can be increased in scenarios where there is a heavy load on Couchbase Server and operations are likely to take more than 2.5 seconds to complete. The default value is 2500 milliseconds.
9188
default: 2500
89+
description: |+
90+
The ```bucket_op_timeout_ms``` value defines the period (in milliseconds) that Sync Gateway should wait for a bucket operation to complete before timing-out and trying again.
91+
92+
You can increase the period when there is a heavy load on Couchbase Server and operations are likely to take more than 2.5 seconds to complete.
93+
94+
The default value is 2500 milliseconds.
95+
compact_interval_days:
96+
type: integer
97+
description: |+
98+
The ```compact_interval_days``` value defines the interval (in days) between scheduled compaction runs.
99+
It is a decimal number -- float32
100+
- A Zero value means do not run compaction
101+
- Minimum non-zero value -- 0.04 (approximately 1 hour)
102+
- Maximum value -- 60 days
103+
- Default -- 1 day
92104
delta_sync:
93105
type: object
94106
description: |+
95-
*NOTE:* Delta Sync is an Enterprise Edition feature on Sync Gateway and Couchbase Lite.
107+
NOTE: Delta Sync is an Enterprise Edition feature on Sync Gateway and Couchbase Lite.
96108
97109
Delta Sync is the ability to replicate only parts of the Couchbase mobile document that have changed. This can result in significant savings in bandwidth consumption as well as throughput improvements, especially when network bandwidth is typically constrained.
98110

0 commit comments

Comments
 (0)