#30419 closed Cleanup/optimization (fixed)
Minor improvements for docs related to Meta.indexes
| Reported by: | Akshesh Doshi | Owned by: | Akshesh Doshi |
|---|---|---|---|
| Component: | Documentation | Version: | 2.2 |
| Severity: | Normal | Keywords: | |
| Cc: | Triage Stage: | Accepted | |
| Has patch: | yes | Needs documentation: | no |
| Needs tests: | no | Patch needs improvement: | no |
| Easy pickings: | no | UI/UX: | no |
Description
I think a bit more details can be added to https://docs.djangoproject.com/en/2.1/ref/models/indexes/ about what functionalities (& extra advantages over index_together) the Index provides. This would help users to know more about what they can do with the Index class.
Also, Meta.indexes should also be added to the list of ways to create indexes over here - https://docs.djangoproject.com/en/2.1/topics/db/optimization/#use-standard-db-optimization-techniques.
Change History (7)
comment:1 by , 5 years ago
comment:2 by , 5 years ago
| Summary: | Minor improvements related to Meta.indexes → Minor improvements for docs related to Meta.indexes |
|---|
comment:3 by , 5 years ago
| Has patch: | set |
|---|---|
| Owner: | changed from to |
PR (assuming that the ticket gets accepted) - https://github.com/django/django/pull/11296
comment:4 by , 5 years ago
| Patch needs improvement: | set |
|---|---|
| Triage Stage: | Unreviewed → Accepted |
OK, accepting modulo comments on the PR. (Replacing the index_together usage to point to indexes is probably worth it.)
Thanks.
comment:5 by , 5 years ago
| Patch needs improvement: | unset |
|---|
Note:
See TracTickets
for help on using tickets.
On a second thought, I think it might be sensible to even remove
Meta.index_togetherfrom the https://docs.djangoproject.com/en/2.1/topics/db/optimization/#use-standard-db-optimization-techniques list. This is because Django officially says thatMeta.indexesis preferred over it over here - https://docs.djangoproject.com/en/2.1/ref/models/options/#django.db.models.Options.index_together