[MDEV-29292] EXPLAIN plan Documentation outdated Created: 2022-08-11  Updated: 2023-12-13

Status: Open
Project: MariaDB Server
Component/s: Documentation
Affects Version/s: N/A
Fix Version/s: N/A

Type: Bug Priority: Critical
Reporter: Faisal Saeed (Inactive) Assignee: Joe Cotellese
Resolution: Unresolved Votes: 1
Labels: None

Issue Links:
PartOf

 Description   

Many changes have been made to the InnoDB engine and the Optimizer since 10.5. These changes have affected the output of the `EXPLAIN` and a lot of new items have been added which are missing documentation and details for instance: https://mariadb.com/kb/en/explain/

As an example, refer to the following plan.

+------+-------------+-------+------------+---------------------------+---------------------------+---------+-------+--------------+---------------------------------+
| id   | select_type | table | type       | possible_keys             | key                       | key_len | ref   | rows         | Extra                           |
+------+-------------+-------+------------+---------------------------+---------------------------+---------+-------+--------------+---------------------------------+
|    1 | SIMPLE      | deal  | ref|filter | dealref_idx,transref_idx1 | transref_idx1|dealref_idx | 14|50   | const | 1906508 (0%) | Using where; Using rowid filter |
+------+-------------+-------+------------+---------------------------+---------------------------+---------+-------+--------------+---------------------------------+

Here under the column `type`, we can see `ref|filter`. What does this mean? Similarly, the `key` column has two indexes separated by a PIPE, is this referring to a MERGE index or something else? Finally, the `rows` column has a `(0%)`. What does this represent?

This is just an example, and we need all the changes in the EXPLAIN/EXPLAIN JSON documented with details for the proper reference and understanding.


Generated at Thu Feb 08 10:07:23 UTC 2024 using Jira 8.20.16#820016-sha1:9d11dbea5f4be3d4cc21f03a88dd11d8c8687422.