tortoise / tortoise/tortoise-orm

Difference Between `.select_related()`, `.fetch_related()` and `.prefetch_related()`

Open
#1,064 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
5.6k
Forks
516
Avg merge
2d 21h
Merged PRs (30d)
9

Description

I couldn't find the difference or the use cases for .select_related(), .fetch_related() and .prefetch_related() in the documentation. It would be really helpful to have it documented.

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

Start by reviewing the existing documentation and the entry points for .select_related(), .fetch_related(), and .prefetch_related(). Compare their behavior and use cases, then document the distinctions and verify that each method’s guidance is clear to ORM users.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.