Skip to content

Commit

Permalink
add a notice that purge documents are only visible with `include_syst…
Browse files Browse the repository at this point in the history
…em=true`
  • Loading branch information
Christian Kruse authored and nickva committed Feb 24, 2023
1 parent 8f519ba commit ac600d1
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions src/docs/src/cluster/purging.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit ac600d1

Please sign in to comment.