couchdb-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
Subject documentation commit: updated refs/heads/master to 2cec875
Date Fri, 07 Oct 2016 03:07:02 GMT
Repository: couchdb-documentation
Updated Branches:
  refs/heads/master d0b3f5940 -> 2cec875f2

Update max_document_size description with correct semantics

`max_document_size` is a misnomer and is actually implemented as the equivalent
of `max_http_recv_body_size`. That is, it checks the total HTTP request body
size. In case of multiple documents (_bulk_docs) or attachments, there could be
a large discrepancy between the two which can be surprising for users.

In the future we could deprecate this setting, rename it, or have an actual
check for individual document sizes, however for now it is better to inform
users of current behavior.



Branch: refs/heads/master
Commit: 2cec875f2449dc0f747aa4759471da762d49ca85
Parents: d0b3f59
Author: Nick Vatamaniuc <>
Authored: Thu Oct 6 17:58:44 2016 -0400
Committer: Nick Vatamaniuc <>
Committed: Thu Oct 6 22:59:50 2016 -0400

 src/config/couchdb.rst | 24 +++++++++++++++---------
 1 file changed, 15 insertions(+), 9 deletions(-)
diff --git a/src/config/couchdb.rst b/src/config/couchdb.rst
index 2eb9cac..cf58acf 100644
--- a/src/config/couchdb.rst
+++ b/src/config/couchdb.rst
@@ -105,15 +105,21 @@ Base CouchDB Options
             max_dbs_open = 100
-    .. config:option:: max_document_size :: Maximum document size
-        .. versionchanged:: 1.3 This option now actually works.
-        Defines a maximum size for JSON documents, in bytes. This limit does
-        not apply to attachments, since they are transferred as a stream of
-        chunks. If you set this to a small value, you might be unable to modify
-        configuration options, database security and other larger documents
-        until a larger value is restored by editing the configuration file. ::
+    .. config:option:: max_document_size :: Maximum HTTP request body size
+        .. versionchanged:: 2.0.1
+        Even though this setting is named `max_document_size`, currently it is
+        implemented by checking HTTP request body size. For single document
+        requests the approximation is close enough, however, when multiple
+        documents are updated in a single request the discrepancy between
+        document sizes and request body size could be large. Setting this to a
+        small value might prevent replicator from writing some documents to
+        the target database or checkpointing progress. It can also prevent
+        configuring database security options. Note: up until and including
+        version 2.0 this setting was not applied to `PUT` requests with
+        multipart/related content type, which is how attachments can be
+        uploaded together with document bodies in the same request. ::
             max_document_size = 4294967296 ; 4 GB

View raw message