couchdb-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From kxe...@apache.org
Subject [24/32] git commit: updated refs/heads/1781-reorganize-and-improve-docs to 11fd32a
Date Fri, 14 Jun 2013 08:25:21 GMT
Describe database_compaction config section.


Project: http://git-wip-us.apache.org/repos/asf/couchdb/repo
Commit: http://git-wip-us.apache.org/repos/asf/couchdb/commit/ba621926
Tree: http://git-wip-us.apache.org/repos/asf/couchdb/tree/ba621926
Diff: http://git-wip-us.apache.org/repos/asf/couchdb/diff/ba621926

Branch: refs/heads/1781-reorganize-and-improve-docs
Commit: ba6219265c5769a88cc9cdb2ac1cc407bd39fce5
Parents: 5a60ee7
Author: Alexander Shorin <kxepal@apache.org>
Authored: Wed Jun 12 16:20:04 2013 +0400
Committer: Alexander Shorin <kxepal@apache.org>
Committed: Fri Jun 14 12:10:19 2013 +0400

----------------------------------------------------------------------
 share/doc/build/Makefile.am                  |  3 ++
 share/doc/src/config/database-compaction.rst | 43 +++++++++++++++++++++++
 share/doc/src/config/index.rst               |  1 +
 3 files changed, 47 insertions(+)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/couchdb/blob/ba621926/share/doc/build/Makefile.am
----------------------------------------------------------------------
diff --git a/share/doc/build/Makefile.am b/share/doc/build/Makefile.am
index b8a6cd4..437d70f 100644
--- a/share/doc/build/Makefile.am
+++ b/share/doc/build/Makefile.am
@@ -60,6 +60,7 @@ html_files = \
     html/_sources/config/couch-httpd-auth.txt \
     html/_sources/config/couchdb.txt \
     html/_sources/config/daemons.txt \
+    html/_sources/config/database-compaction.txt \
     html/_sources/config/httpd.txt \
     html/_sources/config/index.txt \
     html/_sources/config/log.txt \
@@ -124,6 +125,7 @@ html_files = \
     html/config/couch-httpd-auth.html \
     html/config/couchdb.html \
     html/config/daemons.html \
+    html/config/database-compaction.html \
     html/config/httpd.html \
     html/config/index.html \
     html/config/log.html \
@@ -186,6 +188,7 @@ src_files = \
     ../src/config/couch-httpd-auth.rst \
     ../src/config/couchdb.rst \
     ../src/config/daemons.rst \
+    ../src/config/database-compaction.rst \
     ../src/config/httpd.rst \
     ../src/config/index.rst \
     ../src/config/log.rst \

http://git-wip-us.apache.org/repos/asf/couchdb/blob/ba621926/share/doc/src/config/database-compaction.rst
----------------------------------------------------------------------
diff --git a/share/doc/src/config/database-compaction.rst b/share/doc/src/config/database-compaction.rst
new file mode 100644
index 0000000..3ccadee
--- /dev/null
+++ b/share/doc/src/config/database-compaction.rst
@@ -0,0 +1,43 @@
+.. Licensed under the Apache License, Version 2.0 (the "License")you may not
+.. use this file except in compliance with the License. You may obtain a copy of
+.. the License at
+..
+..   http://www.apache.org/licenses/LICENSE-2.0
+..
+.. Unless required by applicable law or agreed to in writing, software
+.. distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+.. WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+.. License for the specific language governing permissions and limitations under
+.. the License.
+
+.. highlight:: ini
+
+.. _config/database_compaction:
+
+``[database_compaction]`` :: Database Compaction Options
+========================================================
+
+These options are under ``[database_compaction]`` section. 
+
+.. _config/database_compaction/doc_buffer_size:
+
+``doc_buffer_size`` :: Documents buffer size
+--------------------------------------------
+
+Specifies maximum copy buffer size in bytes::
+
+  [database_compaction]
+  doc_buffer_size = 524288
+
+
+.. _config/database_compaction/checkpoint_after:
+
+``checkpoint_after`` :: Checkpoint trigger
+------------------------------------------
+
+Triggers checkpoint after special amount of bytes was successfully copied to
+the compacted database::
+
+  [database_compaction]
+  checkpoint_after = 5242880
+

http://git-wip-us.apache.org/repos/asf/couchdb/blob/ba621926/share/doc/src/config/index.rst
----------------------------------------------------------------------
diff --git a/share/doc/src/config/index.rst b/share/doc/src/config/index.rst
index 45701fe..4d7bd3d 100644
--- a/share/doc/src/config/index.rst
+++ b/share/doc/src/config/index.rst
@@ -54,6 +54,7 @@ Content:
    couch-httpd-auth
    couchdb
    daemons
+   database-compaction
    httpd
    log
    native-query-servers


Mime
View raw message