[MDEV-17079] Update documentation on "EXPLAIN" and "EXPLAIN in the Slow Query Log" Created: 2018-08-27 Updated: 2023-12-15 |
|
| Status: | Open |
| Project: | MariaDB Server |
| Component/s: | Documentation - Support |
| Fix Version/s: | N/A |
| Type: | Task | Priority: | Major |
| Reporter: | Geoff Montee (Inactive) | Assignee: | Joe Cotellese |
| Resolution: | Unresolved | Votes: | 0 |
| Labels: | None | ||
| Issue Links: |
|
||||||||||||
| Description |
|
In MariaDB 10.1.0 and later, the r_rows and r_filtered columns were added to the EXPLAIN output that appears in the slow query log. For example:
Updates to "EXPLAIN in the Slow Query Log"The documentation page for "EXPLAIN in the Slow Query Log" will need some updates: https://mariadb.com/kb/en/library/explain-in-the-slow-query-log/ The page should mention that these two new columns were added in MariaDB 10.1. The examples on the page should contain the two new columns. The page should mention that these two new columns are not printed with normal EXPLAIN output. They are printed with ANALYZE output. For example, something like this:
And it should link to here: https://mariadb.com/kb/en/library/analyze-statement/ Updates to "EXPLAIN"The documentation page for "EXPLAIN" will need some updates: https://mariadb.com/kb/en/library/explain/ The page currently says this:
This is not very clear. It should probably say something like this:
https://mariadb.com/kb/en/library/analyze-statement/ The existing examples on this page don't need to be updated, because the two new columns were not added to the output of the regular EXPLAIN statement. |
| Comments |
| Comment by Jacob Moorman (Inactive) [ 2019-04-12 ] |
|
Upon review, we agree that the documented fields of the output should be made to match the fields found in the output. |
| Comment by Julien Fritsch [ 2021-09-22 ] |
|
jacob.moorman from our discussion, I decided to reassign Kenneth's ticket to you? |