Materials-Consortia / Materials-Consortia/optimade-python-tools
Automatically disable sorting on un-indexed fields
Open
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 91
- Forks
- 54
- PR merge metrics
- No merged PRs in 30d
Description
It can be quite easy to waste a lot of cycles by sorting on unindexed fields in the default MongoDB implementation. There should be a config option to prevent such sorts at the API level, or to explicitly list fields that are available for sorting.
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 by locating the default MongoDB implementation and the API-level sorting and configuration paths. Determine whether the project should reject unindexed sorts or accept an explicit list of sortable fields, then add tests showing the selected behavior is enforced.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- mongodb, python
- Domain
- api, databases
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100