Materials-Consortia / Materials-Consortia/optimade-python-tools
Add optimisation for `included` references for MongoDB
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 91
- Forks
- 54
- PR merge metrics
- No merged PRs in 30d
Description
In the many-to-many case of relationships between entries (e.g., every structure has a distinct reference), our way of resolving relationships can be quite slow (we currently hook into the OPTIMADE ID filter and just do a bit chained OR). Ideally, this is something that should be handled directly by join queries in the backend. For MongoDB, this should be straight forward but will need some profiling on "real" databases first.
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
No files, tests, or entry points are named. Start by profiling the current OPTIMADE ID filter and chained OR relationship resolution on realistic MongoDB databases, then compare it with direct backend join queries; done means included references are resolved with a validated MongoDB optimization.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- mongodb, python
- Domain
- backend-api-design, databases
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100