Document limitations of interrupting a query
Nobody has claimed this yet.
- Dominant language
- CSS
- Stars
- 118
- Forks
- 161
- PR merge metrics
- No merged PRs in 30d
Description
http://rethinkdb.com/docs/system-jobs/ briefly mentions terminating queries:
The jobs table [...] allows you to kill query jobs by deleting them from the table.
I think we should elaborate on that a little bit and note that not all queries will terminate immediately. Specifically, many queries will only get terminated the next time they emit a result, but not earlier.
A typical example is r.table(...).count(), which will never get terminated before its done, since it only emits a single result at the end.
See https://github.com/rethinkdb/rethinkdb/issues/5197 for another example.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Open the system-jobs documentation at rethinkdb.com/docs/system-jobs/ and inspect how query termination is currently described. Update that section to explain that some queries stop only when they emit a result, including the count() example, and verify the rendered documentation accurately reflects the limitation.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 55/100