Skip to content

PARITY.md: link kNN fallback to tracking issue MobilityDB#840#93

Closed
estebanzimanyi wants to merge 1 commit intodoc/parityfrom
update-knn-tracking-link
Closed

PARITY.md: link kNN fallback to tracking issue MobilityDB#840#93
estebanzimanyi wants to merge 1 commit intodoc/parityfrom
update-knn-tracking-link

Conversation

@estebanzimanyi
Copy link
Copy Markdown
Member

Summary

Updates the kNN paragraph in `doc/PARITY.md` to point at the new tracking issue `MobilityDB#840`, which lays out the four-stage plan to add an `RTreeNNCursor` API to MEOS and replace the seq-scan fallback in MobilityDuck once the API lands.

What changed

```diff
The kNN operator `|=|` works syntactically (`ORDER BY col |=| q LIMIT k`
-gives correct results), but currently falls back to seq-scan + sort +
-limit because MEOS' R-tree doesn't yet expose a priority-queue scan.
-Output is correct; throughput on large tables isn't.
+gives correct results), but falls back to seq-scan + sort + limit
+because MEOS' R-tree does not yet expose a priority-queue scan.
+Output is correct; throughput on large tables is not. Tracked in
+MobilityDB#840,
+which lays out the four-stage plan to add a `RTreeNNCursor` API to
+MEOS and replace the fallback in MobilityDuck once the API lands.
```

Why

Future visitors of `PARITY.md` can follow progress and decision points on the gap rather than just reading a description of it. The tracking issue carries the API design, sequencing relative to PR #740 (SP-GiST), and the five decision points for @mschoema and @nhungoc1508 to settle.

Editorial tweaks made in passing

  • Removed "currently" (the gap is the present state, not a recent regression).
  • Expanded "doesn't" → "does not" and "isn't" → "is not" to match the surrounding formal documentation style.

🤖 Generated with Claude Code

The R-tree kNN fallback (seq-scan + sort + limit) is now formally
tracked in MobilityDB#840, which lays out the four-stage plan:

1. Box-to-box minimum-distance primitive in MEOS
2. Priority-queue R-tree traversal
3. Public RTreeNNCursor API
4. MobilityDuck consumes the API to replace the fallback

The PARITY.md paragraph now points readers at the tracking issue so
future visitors can follow progress and decision points instead of
just seeing a description of the gap.

Also tightened the prose: removed "currently" (the gap is the
present state, not a recent regression) and expanded the contractions
("doesn't" → "does not", "isn't" → "is not") to match the surrounding
formal documentation style.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@estebanzimanyi
Copy link
Copy Markdown
Member Author

Superseded by the consolidated PR branch consolidate/docs. All changes from this PR are included in that branch as a single squashed commit. Please review and merge the consolidated branch instead.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant