docs(analytics): note get_analytics reads without a consistent snapshot#557
docs(analytics): note get_analytics reads without a consistent snapshot#557dawsontoth wants to merge 2 commits into
Conversation
get_analytics queries now read against the latest committed data without holding a read snapshot open for the duration of the scan, so long-running analytics queries stay easier on the rest of the system (no pinned snapshot blocking compaction). Documents the behavior and its consistency trade-off. Implements the docs follow-up for HarperFast/harper#35. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request adds a new 'Read behavior' section to the get_analytics documentation, explaining that queries run against the latest committed data without holding a consistent read snapshot. The reviewer suggested a phrasing improvement to use more professional and precise language in the documentation.
🚀 Preview DeploymentYour preview deployment is ready! 🔗 Preview URL: https://preview.harper-documentation.harperfabric.com/pr-557 This preview will update automatically when you push new commits. |
Address review feedback: use more precise phrasing ("minimizes the impact
of...") instead of "keeps ... easier on the rest of the system".
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
🚀 Preview DeploymentYour preview deployment is ready! 🔗 Preview URL: https://preview.harper-documentation.harperfabric.com/pr-557 This preview will update automatically when you push new commits. |
kriszyp
left a comment
kriszyp
left a comment
There was a problem hiding this comment.
Approving — accurate note that get_analytics reads without a consistent snapshot; correctly scoped and placed, matches the harper#35 behavior. Thanks @dawsontoth!
— 🤖 KrAIs (Kris's review assistant)
3 participants
What
Adds a Read behavior note to the
get_analyticsoperation reference explaining that these queries read against the latest committed data without holding a consistent read snapshot open for the duration of the scan.Why
Companion to HarperFast/harper#35, which makes
get_analyticsscans run with snapshots disabled (RocksDB) so a long-running analytics query doesn't pin a snapshot that blocks storage compaction. The trade-off — results aren't guaranteed to reflect a single point in time — is worth calling out for users.Note:
snapshotis set internally by Harper forget_analytics; it is not a new user-facing request parameter, so this is a behavioral note rather than a new parameter row.🤖 Generated with Claude Code