Skip to content

Commit f790a42

Browse files
committed
docs: remove global retract setting ref, clarify keep_versions override (IS-17887)
1 parent 58cb7f6 commit f790a42

1 file changed

Lines changed: 2 additions & 3 deletions

File tree

‎hub/features/compaction-feature.rst‎

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -107,8 +107,6 @@ Properties
107107
- If ``true``, the pipe will honour the :ref:`$retract <dollar_retract>` field on output entities.
108108
When an entity with ``$retract: true`` is written to the sink dataset, all earlier versions of that
109109
entity are permanently removed while the current version is retained.
110-
Can be enabled globally via :ref:`global_defaults.compaction_retract <service_metadata_global_defaults_compaction_retract>`
111-
in the :ref:`node metadata <service_metadata_section>`.
112110
- ``false``
113111
- No
114112

@@ -123,7 +121,8 @@ is retained. Deletion state is unaffected. The operation is idempotent.
123121

124122
.. WARNING::
125123

126-
Retract is irreversible. Pruned versions cannot be recovered.
124+
Retract is irreversible. Pruned versions cannot be recovered. Enabling retract will override the
125+
``compaction.keep_versions`` setting on a per-entity basis.
127126

128127
- Only the pipe's sink dataset is affected. Upstream datasets and external consumers are unchanged.
129128
- ``$retract`` propagates like any other field but may be dropped by :ref:`merge sources <merge_source>`

0 commit comments

Comments
 (0)