innov
/
django1
1
0
Fork 0
Code Issues Pull Requests 1 Projects Releases Wiki Activity

Refs #30897 -- Made cosmetic edits to QuerySet.explain() documentation.

This commit is contained in:
Carlton Gibson 2019-10-24 15:16:25 +02:00 committed by Mariusz Felisiak
parent 55df1750be
commit cabf1fe37e
1 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
docs/ref/models/querysets.txt
View File

@ -2569,12 +2569,12 @@ The output differs significantly between databases.
``explain()`` is supported by all built-in database backends except Oracle
because an implementation there isn't straightforward.
The ``format`` parameter changes the output format from the databases's default,
usually text-based. PostgreSQL supports ``'TEXT'``, ``'JSON'``, ``'YAML'``, and
``'XML'`` formats. MariaDB and MySQL support ``'TEXT'`` (also called
``'TRADITIONAL'``) and ``'JSON'`` formats. MySQL 8.0.16+ also supports an
improved ``'TREE'`` format, which is similar to PostgreSQL's ``'TEXT'`` output
and is used by default, if supported.
The ``format`` parameter changes the output format from the databases's
default, which is usually text-based. PostgreSQL supports ``'TEXT'``,
``'JSON'``, ``'YAML'``, and ``'XML'`` formats. MariaDB and MySQL support
``'TEXT'`` (also called ``'TRADITIONAL'``) and ``'JSON'`` formats. MySQL
8.0.16+ also supports an improved ``'TREE'`` format, which is similar to
PostgreSQL's ``'TEXT'`` output and is used by default, if supported.
Some databases accept flags that can return more information about the query.
Pass these flags as keyword arguments. For example, when using PostgreSQL::