summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorChristian Kruse <cjk@defunct.ch>2023-02-24 22:11:05 +0100
committerNick Vatamaniuc <nickva@users.noreply.github.com>2023-02-24 17:07:28 -0500
commitac600d1bb9c9b5335abecc954abf9dd496a2f846 (patch)
tree0ebcac274b7f213aa3d7f64eb423a5a676153129
parent8f519ba04f90ab32c19109034c584e966c7633eb (diff)
downloadcouchdb-ac600d1bb9c9b5335abecc954abf9dd496a2f846.tar.gz
add a notice that purge documents are only visible with `include_system=true`
-rw-r--r--src/docs/src/cluster/purging.rst6
1 files changed, 4 insertions, 2 deletions
diff --git a/src/docs/src/cluster/purging.rst b/src/docs/src/cluster/purging.rst
index 2d8f00ed5..cc9087d89 100644
--- a/src/docs/src/cluster/purging.rst
+++ b/src/docs/src/cluster/purging.rst
@@ -66,8 +66,10 @@ Local Purge Checkpoint Documents
Indexes and internal replications of the database with purges create and
periodically update local checkpoint purge documents:
``_local/purge-{type}-{hash}``. These documents report the last ``purge_seq``
-processed by them and the timestamp of the last processing. An example of a
-local checkpoint purge document:
+processed by them and the timestamp of the last processing. These documents
+are only visible in ``_local_docs`` when you add a ``include_system=true``
+parameter, so e.g. ``/test-db/_local_docs?include_system=true``. An example
+of a local checkpoint purge document:
.. code-block:: json