tortoise / tortoise/tortoise-orm
Graphical drawings to understand the relationships in the database.
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 5.6k
- Forks
- 516
- Avg merge
- 2d 21h
- Merged PRs (30d)
- 9
Description
Problem
Beginners don't understand the relationship when they use tortoise-orm for the first time.
For example One-to-one, One-to-many, Many-to-many connections.
Solution
Most engineers use draw.io (or similar) for database design.
I think database diagram designs should also be added to the examples for tortoise.github.io.
I drew a design in draw.io for tortoise-orm relations.
Above, FK is the foreign key, PK is the primary key.
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
Start with the relations section at examples/basic.html#relations and the examples page, then compare the existing relationship examples with the linked draw.io design. Done means the documentation includes understandable diagrams for one-to-one, one-to-many, and many-to-many relationships, with the key labels explained.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- databases, documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100