rethinkdb / rethinkdb/docs

Driver spec - Talk about cursors

Open
#393 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
CSS
Stars
118
Forks
161
PR merge metrics
No merged PRs in 30d

Description

We don't really explain how cursors work.

If a driver get a SUCCESS_PARTIAL response, he can get back more data by sending CONTINUE.
We should also mention that

  • a cursor should always use the same connection
  • having more than one CONTINUE query going on is "dangerous"

Contributor guide

Open the contributing guide

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.

Research direction

Locate the driver documentation section covering cursors and the SUCCESS_PARTIAL response. Read the surrounding cursor guidance first, then document that CONTINUE retrieves more data, cursors must use the same connection, and multiple CONTINUE queries are dangerous. Done when these behaviors are clearly explained in the relevant documentation.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.