Merge pull request #843 from mattcarabine/DOC-1857

DOC-1857: Update index settings parameters
couchbase · Nov 1, 2016 · 96a297f · 96a297f
2 parents 28bbc01 + 5c2bff6
commit 96a297f
Showing 1 changed file with 28 additions and 16 deletions.
diff --git a/content/rest-api/rest-index-settings.dita b/content/rest-api/rest-index-settings.dita
@@ -11,25 +11,39 @@
       <dl>
         <dlentry>
           <dt><codeph>indexerThreads</codeph></dt>
-          <dd>Number of dedicated threads the indexer uses. 
-            On multi-core machines increasing this number increases the amount of CPU available to the indexer. 
-            Default: 4</dd>
+          <dd>Number of dedicated threads the indexer uses. On multi-core machines increasing this
+            number increases the amount of CPU available to the indexer. Default: 4</dd>
+        </dlentry>
+        <dlentry>
+          <dt><codeph>logLevel</codeph></dt>
+          <dd>
+            <p>The log level for the index service. Valid options are <codeph>debug</codeph>,
+                <codeph>silent</codeph>, <codeph>fatal</codeph>, <codeph>error</codeph>,
+                <codeph>warn</codeph>, <codeph>info</codeph>, <codeph>verbose</codeph>,
+                <codeph>timing</codeph> and <codeph>trace</codeph>. Default:
+              <codeph>info</codeph>.</p>
+          </dd>
         </dlentry>
         <dlentry>
           <dt><codeph>maxRollbackPoints</codeph></dt>
           <dd>The maximum number of committed rollback points. Default: 5</dd>
         </dlentry>
         <dlentry>
           <dt><codeph>memorySnapshotInterval</codeph></dt>
-          <dd>Specifies the frequency of in-memory snapshots. 
-            This determines the earliest possibility of a scan seeing a given KV mutation. 
-          Specified in milliseconds (ms). Default: 200</dd>
+          <dd>Specifies the frequency of in-memory snapshots. This determines the earliest
+            possibility of a scan seeing a given KV mutation. Specified in milliseconds (ms).
+            Default: 200</dd>
         </dlentry>
         <dlentry>
           <dt><codeph>stableSnapshotInterval</codeph></dt>
-          <dd>Specifies the frequency of persisted snapshots for recovery. Specified in seconds (sec). Default: 30000</dd>
+          <dd>Specifies the frequency of persisted snapshots for recovery. Specified in seconds
+            (sec). Default: 30000</dd>
+        </dlentry>
+        <dlentry>
+          <dt><codeph>storageMode</codeph></dt>
+          <dd>Specifies the index storage mode to use. Valid options are <codeph>forestdb</codeph>
+            and <codeph>memory_optimized</codeph>. Default: <codeph>forestdb</codeph></dd>
         </dlentry>
-
       </dl>
 
 
@@ -55,16 +69,14 @@ POST /settings/indexes      </codeblock>
     <section><title>Response</title>
       <p>Example response:</p>
 
-        <codeblock>
-  % Total    % Received % Xferd  Average Speed   Time    Time     Time  Current
-                                 Dload  Upload   Total   Spent    Left  Speed
-102   102  102   102    0     0  52550      0 --:--:-- --:--:-- --:--:--   99k
-{
-    "indexerThreads": 4,
+        <codeblock>{
+    "indexerThreads": 0,
+    "logLevel": "info",
     "maxRollbackPoints": 5,
     "memorySnapshotInterval": 200,
-    "stableSnapshotInterval": 30000
-}    </codeblock>
+    "stableSnapshotInterval": 5000,
+    "storageMode": "forestdb"
+}</codeblock>
     </section>
 
   </refbody>