diff options
| author | Nick Pope <nick.pope@flightdataservices.com> | 2019-10-21 17:32:56 +0100 |
|---|---|---|
| committer | Mariusz Felisiak <felisiak.mariusz@gmail.com> | 2019-10-24 15:13:23 +0200 |
| commit | 742961332e1e2221e6fb9506c7254164e0c2cb5a (patch) | |
| tree | 72520ec3e86c5676ad7d6d43308f8808f920a333 /docs | |
| parent | 37f02c47f8eb4d6e7b3c22401dba57b00780dc5d (diff) | |
Refs #30897 -- Added support for TREE format to Queryset.explain() on MySQL 8.0.16+.
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/ref/models/querysets.txt | 10 | ||||
| -rw-r--r-- | docs/releases/3.1.txt | 2 |
2 files changed, 10 insertions, 2 deletions
diff --git a/docs/ref/models/querysets.txt b/docs/ref/models/querysets.txt index d4a922f3dc..136674be2a 100644 --- a/docs/ref/models/querysets.txt +++ b/docs/ref/models/querysets.txt @@ -2571,8 +2571,10 @@ 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'``. MySQL supports ``'TEXT'`` (also called ``'TRADITIONAL'``) and -``'JSON'``. +``'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:: @@ -2589,6 +2591,10 @@ adverse effects on your database. For example, PostgreSQL's ``ANALYZE`` flag could result in changes to data if there are triggers or if a function is called, even for a ``SELECT`` query. +.. versionchanged:: 3.1 + + Support for the ``'TREE'`` format on MySQL 8.0.16+ was added. + .. _field-lookups: ``Field`` lookups diff --git a/docs/releases/3.1.txt b/docs/releases/3.1.txt index 300c7a2c26..cf77bb15db 100644 --- a/docs/releases/3.1.txt +++ b/docs/releases/3.1.txt @@ -169,6 +169,8 @@ Models :class:`~django.db.models.DateTimeField`, and the new :lookup:`iso_week_day` lookup allows querying by an ISO-8601 day of week. +* :meth:`.QuerySet.explain` now supports ``TREE`` format on MySQL 8.0.16+. + Pagination ~~~~~~~~~~ |