Opened 6 years ago

Closed 6 years ago

Last modified 6 years ago

#29685 closed Cleanup/optimization (fixed)

Add a note about Queryset.explain() to the 'Database access optimization' documentation

Reported by: Tom Forbes Owned by: Tom Forbes
Component: Documentation Version: dev
Severity: Normal Keywords:
Cc: Triage Stage: Ready for checkin
Has patch: yes Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: no UI/UX: no

Description

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?

Change History (8)

comment:1 by Tim Graham, 6 years ago

Triage Stage: Unreviewed → Accepted
Type: New feature → Cleanup/optimization

comment:3 by Srinivas Reddy Thatiparthy, 6 years ago

How about giving an example? Let's say, run this explain() method on oracle , and add it to the documentation.

comment:4 by Tom Forbes, 6 years ago

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?

comment:5 by Tom Forbes, 6 years ago

Has patch: set
Owner: changed from nobody to Tom Forbes
Status: new → assigned

comment:6 by Tim Graham, 6 years ago

Triage Stage: Accepted → Ready for checkin

Looks okay to me. I pushed some light edits.

comment:7 by Tim Graham <timograham@…>, 6 years ago

Resolution: → fixed
Status: assigned → closed

In b042ab8:

Fixed #29685 -- Added QuerySet.explain() to the database optimization docs.

comment:8 by Tim Graham <timograham@…>, 6 years ago

In 77498db:

[2.1.x] Fixed #29685 -- Added QuerySet.explain() to the database optimization docs.

Backport of b042ab897636987701d3a35d6b566c6bef9d6ea2 from master

Note: See TracTickets for help on using tickets.
Back to Top