[Django] #30419: Minor improvements related to Meta.indexes

11 views
Skip to first unread message

Django

unread,
Apr 27, 2019, 12:41:24 PM4/27/19
to django-...@googlegroups.com
#30419: Minor improvements related to Meta.indexes
------------------------------------------------+--------------------------
Reporter: Akshesh Doshi | Owner: nobody
Type: Cleanup/optimization | Status: assigned
Component: Documentation | Version: 2.2
Severity: Normal | Keywords:
Triage Stage: Unreviewed | Has patch: 0
Needs documentation: 0 | Needs tests: 0
Patch needs improvement: 0 | Easy pickings: 0
UI/UX: 0 |
------------------------------------------------+--------------------------
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.

--
Ticket URL: <https://code.djangoproject.com/ticket/30419>
Django <https://code.djangoproject.com/>
The Web framework for perfectionists with deadlines.

Django

unread,
Apr 27, 2019, 12:43:53 PM4/27/19
to django-...@googlegroups.com
#30419: Minor improvements related to Meta.indexes
-------------------------------------+-------------------------------------

Reporter: Akshesh Doshi | Owner: nobody
Type: | Status: assigned
Cleanup/optimization |
Component: Documentation | Version: 2.2
Severity: Normal | Resolution:

Keywords: | Triage Stage:
| Unreviewed
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------

Comment (by Akshesh Doshi):

On a second thought, I think it might be sensible to even remove
`Meta.index_together` from the
https://docs.djangoproject.com/en/2.1/topics/db/optimization/#use-
standard-db-optimization-techniques list. This is because Django
officially says that `Meta.indexes` is preferred over it over here -
https://docs.djangoproject.com/en/2.1/ref/models/options/#django.db.models.Options.index_together

--
Ticket URL: <https://code.djangoproject.com/ticket/30419#comment:1>

Django

unread,
Apr 27, 2019, 12:44:49 PM4/27/19
to django-...@googlegroups.com
#30419: Minor improvements for docs related to Meta.indexes
-------------------------------------+-------------------------------------

Reporter: Akshesh Doshi | Owner: nobody
Type: | Status: assigned
Cleanup/optimization |
Component: Documentation | Version: 2.2
Severity: Normal | Resolution:

Keywords: | Triage Stage:
| Unreviewed
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------

--
Ticket URL: <https://code.djangoproject.com/ticket/30419#comment:2>

Django

unread,
Apr 27, 2019, 12:52:12 PM4/27/19
to django-...@googlegroups.com
#30419: Minor improvements for docs related to Meta.indexes
-------------------------------------+-------------------------------------
Reporter: Akshesh Doshi | Owner: Akshesh
Type: | Doshi

Cleanup/optimization | Status: assigned
Component: Documentation | Version: 2.2
Severity: Normal | Resolution:
Keywords: | Triage Stage:
| Unreviewed
Has patch: 1 | Needs documentation: 0

Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------
Changes (by Akshesh Doshi):

* owner: nobody => Akshesh Doshi
* has_patch: 0 => 1


Comment:

PR (assuming that the ticket gets accepted) -
https://github.com/django/django/pull/11296

--
Ticket URL: <https://code.djangoproject.com/ticket/30419#comment:3>

Django

unread,
Apr 30, 2019, 3:00:04 PM4/30/19
to django-...@googlegroups.com
#30419: Minor improvements for docs related to Meta.indexes
-------------------------------------+-------------------------------------
Reporter: Akshesh Doshi | Owner: Akshesh
Type: | Doshi
Cleanup/optimization | Status: assigned
Component: Documentation | Version: 2.2
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 1

Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------
Changes (by Carlton Gibson):

* needs_better_patch: 0 => 1
* stage: Unreviewed => Accepted


Comment:

OK, accepting modulo comments on the PR. (Replacing the `index_together`
usage to point to `indexes` is probably worth it.)

Thanks.

--
Ticket URL: <https://code.djangoproject.com/ticket/30419#comment:4>

Django

unread,
May 4, 2019, 11:57:34 AM5/4/19
to django-...@googlegroups.com
#30419: Minor improvements for docs related to Meta.indexes
-------------------------------------+-------------------------------------
Reporter: Akshesh Doshi | Owner: Akshesh
Type: | Doshi
Cleanup/optimization | Status: assigned
Component: Documentation | Version: 2.2
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Has patch: 1 | Needs documentation: 0

Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------
Changes (by Akshesh Doshi):

* needs_better_patch: 1 => 0


Comment:

https://github.com/django/django/pull/11296#discussion_r280985453

--
Ticket URL: <https://code.djangoproject.com/ticket/30419#comment:5>

Django

unread,
May 22, 2019, 1:55:00 AM5/22/19
to django-...@googlegroups.com
#30419: Minor improvements for docs related to Meta.indexes
-------------------------------------+-------------------------------------
Reporter: Akshesh Doshi | Owner: Akshesh
Type: | Doshi
Cleanup/optimization | Status: closed
Component: Documentation | Version: 2.2
Severity: Normal | Resolution: fixed
Keywords: | Triage Stage: Accepted
Has patch: 1 | Needs documentation: 0

Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------
Changes (by Mariusz Felisiak <felisiak.mariusz@…>):

* status: assigned => closed
* resolution: => fixed


Comment:

In [changeset:"888fdf182e164fa4b24aa82fa833c90a2b9bee7a" 888fdf1]:
{{{
#!CommitTicketReference repository=""
revision="888fdf182e164fa4b24aa82fa833c90a2b9bee7a"
Fixed #30419 -- Favored Meta.indexes over Meta.index_together in
optimization docs.
}}}

--
Ticket URL: <https://code.djangoproject.com/ticket/30419#comment:6>

Django

unread,
May 22, 2019, 1:56:44 AM5/22/19
to django-...@googlegroups.com
#30419: Minor improvements for docs related to Meta.indexes
-------------------------------------+-------------------------------------
Reporter: Akshesh Doshi | Owner: Akshesh
Type: | Doshi
Cleanup/optimization | Status: closed
Component: Documentation | Version: 2.2

Severity: Normal | Resolution: fixed
Keywords: | Triage Stage: Accepted
Has patch: 1 | Needs documentation: 0

Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------

Comment (by Mariusz Felisiak <felisiak.mariusz@…>):

In [changeset:"efb906cbe46e0eefe58d59bc068fe5221f39ca5e" efb906cb]:
{{{
#!CommitTicketReference repository=""
revision="efb906cbe46e0eefe58d59bc068fe5221f39ca5e"
[2.2.x] Fixed #30419 -- Favored Meta.indexes over Meta.index_together in
optimization docs.

Backport of 888fdf182e164fa4b24aa82fa833c90a2b9bee7a from master
}}}

--
Ticket URL: <https://code.djangoproject.com/ticket/30419#comment:7>

Reply all
Reply to author
Forward
0 new messages