silverstripe / silverstripe/developer-docs

Include more information about optimising ORM performance

Open
#202 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

affects/v5 impact/medium type/docs
Dominant language
No language data
Stars
7
Forks
74
Avg merge
1d 14m
Merged PRs (30d)
6

Description

https://github.com/silverstripe/developer-docs/pull/201 adds a new section about ORM performance. It doesn't have much in it right now, but there's probably a lot that we can include in here.
Examples:

  • using PartialMatch filters makes indexes effectively useless for that column in that query - so for things like searching for pages in the CMS site tree, swapping to use ExactMatch on title only and adding an index on title will make that query way faster
  • dnadesign/silverstripe-elemental overrides how sitetree search works and adds a super un-optimised filterByCallback() to that query (though its debatable whether elemental docs should be part of the main docs)

We should seek feedback from the community about what they're doing to improve performance of the ORM specifically and include good examples in the ORM performance section (pssst if you're reading this and have any suggestions of what we could add, please add a comment below).

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 reading pull request 201 and its new ORM performance section. Review the listed PartialMatch, ExactMatch, indexing, and filterByCallback examples, then seek community feedback for additional ORM performance practices. Done means the section contains useful, vetted examples and clearly addresses the agreed scope, including whether Elemental documentation belongs there.

Written by the indexing model from the issue text.

Assessment

Domain
backend, documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.