[Django] #29685: Add a note about Queryset.explain() to the 'Database access optimization' documentation
Django
documentation
-----------------------------------------+------------------------
Reporter: Tom Forbes | Owner: nobody
Type: New feature | Status: new
Component: Documentation | Version: master
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 |
-----------------------------------------+------------------------
It seems like it would be good to add a sentence or two to the profile
first section:
[https://docs.djangoproject.com/en/2.1/topics/db/optimization/#profile-
first]?
--
Ticket URL: <https://code.djangoproject.com/ticket/29685>
Django <https://code.djangoproject.com/>
The Web framework for perfectionists with deadlines.
Django
documentation
Reporter: Tom Forbes | Owner: nobody
Component: Documentation | Version: master
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
Changes (by Tim Graham):
* type: New feature => Cleanup/optimization
* stage: Unreviewed => Accepted
--
Ticket URL: <https://code.djangoproject.com/ticket/29685#comment:1>
Django
documentation
Reporter: Tom Forbes | Owner: nobody
Component: Documentation | Version: master
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
Comment (by Tom Forbes):
PR: https://github.com/django/django/pull/10310
--
Ticket URL: <https://code.djangoproject.com/ticket/29685#comment:2>
Django
documentation
Reporter: Tom Forbes | Owner: nobody
Component: Documentation | Version: master
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
Comment (by Srinivas Reddy Thatiparthy):
How about giving an example? Let's say, run this `explain()` method on
oracle , and add it to the documentation.
--
Ticket URL: <https://code.djangoproject.com/ticket/29685#comment:3>
Django
documentation
Reporter: Tom Forbes | Owner: nobody
Component: Documentation | Version: master
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
Comment (by Tom Forbes):
I did not want to duplicate the actual documentation for `.explain()` as
that already includes an example of the output, just direct people to it.
Perhaps it would not be too bad to include it?
--
Ticket URL: <https://code.djangoproject.com/ticket/29685#comment:4>
Django
documentation
Reporter: Tom Forbes | Owner: Tom
Type: | Forbes
Cleanup/optimization | Status: assigned
Component: Documentation | Version: master
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
Changes (by Tom Forbes):
* owner: nobody => Tom Forbes
* status: new => assigned
* has_patch: 0 => 1
--
Ticket URL: <https://code.djangoproject.com/ticket/29685#comment:5>
Django
documentation
Reporter: Tom Forbes | Owner: Tom
Type: | Forbes
Cleanup/optimization | Status: assigned
Severity: Normal | Resolution:
Keywords: | Triage Stage: Ready for
| checkin
Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
Changes (by Tim Graham):
* stage: Accepted => Ready for checkin
Comment:
Looks okay to me. I pushed some light edits.
--
Ticket URL: <https://code.djangoproject.com/ticket/29685#comment:6>
Django
documentation
Reporter: Tom Forbes | Owner: Tom
Type: | Forbes
Component: Documentation | Version: master
Severity: Normal | Resolution: fixed
Keywords: | Triage Stage: Ready for
| checkin
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
Changes (by Tim Graham <timograham@…>):
* status: assigned => closed
* resolution: => fixed
Comment:
In [changeset:"b042ab897636987701d3a35d6b566c6bef9d6ea2" b042ab8]:
{{{
#!CommitTicketReference repository=""
revision="b042ab897636987701d3a35d6b566c6bef9d6ea2"
Fixed #29685 -- Added QuerySet.explain() to the database optimization
docs.
}}}
--
Ticket URL: <https://code.djangoproject.com/ticket/29685#comment:7>
Django
documentation
Reporter: Tom Forbes | Owner: Tom
Type: | Forbes
Cleanup/optimization | Status: closed
Severity: Normal | Resolution: fixed
Keywords: | Triage Stage: Ready for
| checkin
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
Comment (by Tim Graham <timograham@…>):
In [changeset:"77498db196fede2cb4dbee9e7cd7762a99c5ded8" 77498db]:
{{{
#!CommitTicketReference repository=""
revision="77498db196fede2cb4dbee9e7cd7762a99c5ded8"
[2.1.x] Fixed #29685 -- Added QuerySet.explain() to the database
optimization docs.
Backport of b042ab897636987701d3a35d6b566c6bef9d6ea2 from master
}}}
--
Ticket URL: <https://code.djangoproject.com/ticket/29685#comment:8>