summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/ref/models/querysets.txt10
-rw-r--r--docs/releases/3.1.txt2
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
~~~~~~~~~~