Say in the docs that a seek never reaches the rows whose ordered property is null

Open Beginner friendly
#529 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
1/5
Estimated time
Under an hour
Newbie friendliness
90/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Active
Tech stack
neo4j, postgresql, python

Research direction

Update docs/06-object-manager.md beside the seek documentation. Read the existing seek explanation and compare it with the example and Drivine4j paragraph cited in the issue. Document that ordered properties must be non-null for rows to be reached on later pages, and that users can filter nulls in where or order by a property that always has a value.

Written by the indexing model from the issue text.

Description

The docs don't say that a seek drops every row whose ordered property is null from each page after the first, as drivine4j's do (docs/06-object-manager.md, "The ordered properties must be non-null in the data").

await gom.save_all([S(id="a", rank=1), S(id="b", rank=2), S(id="c"), S(id="d")])
q = refs(S)
await gom.load_all(S, order_by=[q.rank.asc(), q.id.asc()])                      # a, b, c, d
await gom.load_all(S, order_by=[q.rank.asc(), q.id.asc()], limit=2,
                   seek=[q.rank.after(2), q.id.after("b")])                     # []: c and d are never reached

Seen on SQLite. A null sort key satisfies no comparison on any store, the graph engines' Cypher included, so this is how keyset paging works, not a bug: an order that places its nulls is already refused with seek. But a user paging over an optional property loses rows without a word.

The fix is docs: say, beside seek, that its ordered properties must be non-null in the data, and that a user should filter nulls out in where or order by a property that always has a value. drivine4j's paragraph can be taken as it is.

Dominant language
Python
Stars
2
Forks
0
Avg merge
3h 40m
Merged PRs (30d)
219

Getting set up

This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from liberation-data/drivine-python

All issues in liberation-data/drivine-python

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.