You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@couchdb.apache.org by ko...@apache.org on 2020/01/29 02:36:21 UTC
[couchdb-documentation] branch master updated: Document
enable_database_recovery (#482)
This is an automated email from the ASF dual-hosted git repository.
kocolosk pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/couchdb-documentation.git
The following commit(s) were added to refs/heads/master by this push:
new 1224d9b Document enable_database_recovery (#482)
1224d9b is described below
commit 1224d9b7b8a1dde0e1a96b7030e3ca3a351283b1
Author: Will Holley <wi...@apache.org>
AuthorDate: Wed Jan 29 02:36:12 2020 +0000
Document enable_database_recovery (#482)
Also do a quick drive-by indenting fix, and reorder all settings alphabetically.
Co-authored-by: Adam Kocoloski <ko...@apache.org>
---
src/config/couchdb.rst | 113 +++++++++++++++++++++++++++----------------------
1 file changed, 63 insertions(+), 50 deletions(-)
diff --git a/src/config/couchdb.rst b/src/config/couchdb.rst
index 67061c0..bb0e78a 100644
--- a/src/config/couchdb.rst
+++ b/src/config/couchdb.rst
@@ -50,6 +50,19 @@ Base CouchDB Options
[couchdb]
default_security = admin_local
+ .. config:option:: enable_database_recovery :: Enable database recovery
+
+ Enable this to only "soft-delete" databases when
+ :ref:`DELETE /{db} <api/db>` DELETE requests are made. This will place
+ a ``.recovery`` directory in your data directory and move deleted
+ databases/shards there instead. You can then manually delete these
+ files later, as desired.
+
+ Default is ``false``. ::
+
+ [couchdb]
+ enable_database_recovery = false
+
.. config:option:: file_compression :: Compression method for documents
.. versionchanged:: 1.2 Added `Google Snappy`_ compression algorithm.
@@ -71,6 +84,27 @@ Base CouchDB Options
.. _Google Snappy: http://code.google.com/p/snappy/
+ .. config:option:: maintenance_mode :: Maintenance mode
+
+ A CouchDB node may be put into two distinct maintenance modes by setting
+ this configuration parameter.
+
+ * ``true``: The node will not respond to clustered requests from other
+ nodes and the /_up endpoint will return a 404 response.
+ * ``nolb``: The /_up endpoint will return a 404 response.
+ * ``false``: The node responds normally, /_up returns a 200 response.
+
+ It is expected that the administrator has configured a load balancer
+ in front of the CouchDB nodes in the cluster. This load balancer should
+ use the /_up endpoint to determine whether or not to send HTTP requests
+ to any particular node. For HAProxy, the following config is
+ appropriate:
+
+ .. code-block:: none
+
+ http-check disable-on-404
+ option httpchk GET /_up
+
.. config:option:: max_dbs_open :: Limit of simultaneously opened databases
This option places an upper bound on the number of databases that can
@@ -82,6 +116,34 @@ Base CouchDB Options
[couchdb]
max_dbs_open = 100
+ .. config:option:: max_document_size :: Limit maximum document body size
+
+ .. versionchanged:: 2.1.0
+
+ Limit maximum document body size. Size is calculated based on the
+ serialized Erlang representation of the JSON document body, because
+ that reflects more accurately the amount of storage consumed on disk.
+ In particular, this limit does not include attachments.
+
+ HTTP requests which create or update documents will fail with error
+ code 413 if one or more documents is larger than this configuration
+ value.
+
+ In case of `_update` handlers, document size is checked after the
+ transformation and right before being inserted into the database. ::
+
+ [couchdb]
+ max_document_size = 4294967296 ; 4 GB
+
+ .. warning::
+ Before version 2.1.0 this setting was implemented by simply checking
+ http request body sizes. For individual document updates via `PUT`
+ that approximation was close enough, however that is not the case
+ for `_bulk_docs` endpoint. After 2.1.0 a separate configuration
+ parameter was defined: :config:option:`httpd/max_http_request_size`,
+ which can be used to limit maximum http request sizes. After upgrade,
+ it is advisable to review those settings and adjust them accordingly.
+
.. config:option:: os_process_timeout :: External processes time limit
If an external process, such as a query server or external process,
@@ -106,7 +168,7 @@ Base CouchDB Options
.. _URI: http://en.wikipedia.org/wiki/URI
- .. config:option:: users_db_suffix :: Users database suffix
+ .. config:option:: users_db_suffix :: Users database suffix
Specifies the suffix (last component of a name) of the system database
for storing CouchDB users. ::
@@ -145,52 +207,3 @@ Base CouchDB Options
[couchdb]
view_index_dir = /var/lib/couchdb
-
- .. config:option:: maintenance_mode :: Maintenance mode
-
- A CouchDB node may be put into two distinct maintenance modes by setting
- this configuration parameter.
-
- * ``true``: The node will not respond to clustered requests from other
- nodes and the /_up endpoint will return a 404 response.
- * ``nolb``: The /_up endpoint will return a 404 response.
- * ``false``: The node responds normally, /_up returns a 200 response.
-
- It is expected that the administrator has configured a load balancer
- in front of the CouchDB nodes in the cluster. This load balancer should
- use the /_up endpoint to determine whether or not to send HTTP requests
- to any particular node. For HAProxy, the following config is
- appropriate:
-
- .. code-block:: none
-
- http-check disable-on-404
- option httpchk GET /_up
-
- .. config:option:: max_document_size :: Limit maximum document body size
-
- .. versionchanged:: 2.1.0
-
- Limit maximum document body size. Size is calculated based on the
- serialized Erlang representation of the JSON document body, because
- that reflects more accurately the amount of storage consumed on disk.
- In particular, this limit does not include attachments.
-
- HTTP requests which create or update documents will fail with error
- code 413 if one or more documents is larger than this configuration
- value.
-
- In case of `_update` handlers, document size is checked after the
- transformation and right before being inserted into the database. ::
-
- [couchdb]
- max_document_size = 4294967296 ; 4 GB
-
- .. warning::
- Before version 2.1.0 this setting was implemented by simply checking
- http request body sizes. For individual document updates via `PUT`
- that approximation was close enough, however that is not the case
- for `_bulk_docs` endpoint. After 2.1.0 a separate configuration
- parameter was defined: :config:option:`httpd/max_http_request_size`,
- which can be used to limit maximum http request sizes. After upgrade,
- it is advisable to review those settings and adjust them accordingly.