DOC Document default_sort composite indexes #755
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2 tasks
GuySartorelli
commented
Jun 3, 2025
| this index is present on the associative entity). | ||
| - All fields used in `default_sort` configuration | ||
| - All fields used in `default_sort` configuration (see [`default_sort` index mode](#default-sort-index-mode) below for additional options) | ||
| - Some built-in models (such as [`Member`](api:SilverStripe\Security\Member)) have specific indexes added |
Member
Author
There was a problem hiding this comment.
Added this last note for completion's sake
GuySartorelli
commented
Jun 3, 2025
| class MyObject extends DataObject | ||
| { | ||
| private static $indexes = [ | ||
| private static array $indexes = [ |
Member
Author
There was a problem hiding this comment.
Unrelated - just updating the config references in this page to follow latest best practice
GuySartorelli
commented
Jun 3, 2025
| ``` | ||
|
|
||
| ## Complex/Composite indexes | ||
| ### Complex/Composite indexes |
Member
Author
There was a problem hiding this comment.
Makes sense as a subheading of "Defining an index"
GuySartorelli
commented
Jun 3, 2025
Comment on lines
93
to
114
| - index (col1) - `WHERE col1 = ?` | ||
| - index (col1, col2) = `WHERE (col1 = ? AND col2 = ?)` | ||
| - index (col1, col2, col3) = `WHERE (col1 = ? AND col2 = ? AND col3 = ?)` | ||
| ```php | ||
| namespace App\Model; | ||
|
|
||
| The index would not be used for a query `WHERE col2 = ?` or for `WHERE col1 = ? OR col2 = ?` | ||
| use SilverStripe\ORM\DataObject; | ||
|
|
||
| class MyTestObject extends DataObject | ||
| { | ||
| // ... | ||
| private static array $indexes = [ | ||
| 'MyCompositeIndex' => ['MyField', 'MyOtherField', 'MyThirdField'], | ||
| ]; | ||
| } | ||
| ``` | ||
|
|
||
| Composite indexes can be used for any query that uses the fields in this specific order, include queries that omit columns from later in the index. For example, the index would be used for these queries: | ||
|
|
||
| - `WHERE MyField = ?` | ||
| - `WHERE (MyField = ? AND MyOtherField = ?)` | ||
| - `WHERE (MyField = ? AND MyOtherField = ? AND MyThirdField = ?)` | ||
|
|
||
| The index would not be used for a query `WHERE MyOtherField = ?` (because the first column is not used in this query) or for `WHERE MyField = ? OR MyOtherField = ?` (because the database has to check all rows to see if the `MyOtherField` column matches on its own). |
Member
Author
There was a problem hiding this comment.
Updated this to be clearer - it wasn't really obvious what index (col1, col2) meant - was that a separate index or just showing that only col1 and col2 of the 3-column index were being used?
GuySartorelli
force-pushed
the
pulls/6/default-sort-index
branch
2 times, most recently
from
cf37906 to
ef8177c
Compare
Member
Author
|
Conflict resolved |
GuySartorelli
force-pushed
the
pulls/6/default-sort-index
branch
from
ef8177c to
d54bab7
Compare
emteknetnz
approved these changes
Jun 4, 2025
emteknetnz
pushed a commit
to creative-commoners/developer-docs
that referenced
this pull request
Jul 22, 2025
…efault-sort-index DOC Document default_sort composite indexes
lozcalver
pushed a commit
to lozcalver/developer-docs
that referenced
this pull request
Nov 14, 2025
…efault-sort-index DOC Document default_sort composite indexes
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Issue
default_sortwith multiple columns silverstripe-framework#11674