rethinkdb / rethinkdb/docs

Add a document on query performance trade-offs

Open
#649 0 comments 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

Some queries can be rewritten in different ways to take advantage of parallelization or to optimize performance (e.g. reordering terms can change the latency / performance of a query).

A good example of this is rethinkdb/rethinkdb#3756.

Since we don't have an optimizer, it would be good to document some of these details on a case-by-case basis for advanced users who are trying to understand why some queries are slower / faster.

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

No file, test, or entry point is named. Start by reviewing rethinkdb/rethinkdb#3756 and the existing query documentation, then identify concrete query-performance trade-offs and examples that should be documented for advanced users. Done means the relevant cases and their parallelization or latency implications are explained clearly.

Written by the indexing model from the issue text.

Assessment

Domain
databases, documentation, performance
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.