docs: $retract DTL flag for history pruning (IS-17887)#1332
Open
Ole-Morten wants to merge 6 commits intomasterfrom
Open
docs: $retract DTL flag for history pruning (IS-17887)#1332Ole-Morten wants to merge 6 commits intomasterfrom
Ole-Morten wants to merge 6 commits intomasterfrom
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
IS-17887 — Retract as history prune
What changed
Documents the new
$retractspecial field on entities in three places:hub/changelog.rst— Changelog entry dated 2026-03-17.hub/documentation/data-management/entity-data-model.rst— New row in the Special fields table and a dedicated Retract as history prune subsection with a configuration example.hub/quick-reference.rst—$retractadded to the Special fields list.Feature summary
$retract: trueis a DTL output flag. When a pipe sets it on an output entity, the dataset sink writes that entity as the new latest version and permanently removes all earlier versions of that entity id. Deletion state is unaffected.Typical use case: removing PII from version history once it is no longer needed — e.g. a customer's SSN is present while they are active, but once offboarded the pipe emits a sanitised entity with
$retract: true, dropping all history that contained the SSN.The operation is idempotent.