[MDEV-25325] built-in documentation for performance_schema tables Created: 2021-04-01 Updated: 2021-10-26 Resolved: 2021-10-26 |
|
| Status: | Closed |
| Project: | MariaDB Server |
| Component/s: | Performance Schema |
| Fix Version/s: | 10.2.41, 10.3.32, 10.4.22, 10.5.13, 10.6.5, 10.7.1 |
| Type: | Task | Priority: | Critical |
| Reporter: | Sergei Golubchik | Assignee: | Vicențiu Ciorbaru |
| Resolution: | Fixed | Votes: | 0 |
| Labels: | beginner-friendly | ||
| Description |
|
Document all performance schema tables using per-column COMMENT, like in
After that one can see the built-in documentation with
or, better, with
returning
The documentation text is taken from https://mariadb.com/kb/en/performance-schema-file_instances-table/ |
| Comments |
| Comment by Haidong Ji [ 2021-05-01 ] |
|
Hi Sergei, I'd like to work on this, if that is ok. I've checked the page here on https://mariadb.com/kb/en/performance-schema-tables/ . I think I know what to do. Haidong |
| Comment by Haidong Ji [ 2021-05-02 ] |
|
I did some development work over the weekend: 1. The kb articles don't always have the complete columns defined in the cc files. I'll keep note of this. I'm pretty sure I can finish this task. Any tips/suggestions welcome. Thanks! |
| Comment by Sergei Golubchik [ 2021-05-05 ] |
|
haidong, yes, thanks. Please, list here all columns that you find not documented in the KB |
| Comment by Haidong Ji [ 2021-05-12 ] |
|
I have finished editing the cc files for all performance schema tables listed. I've tested every one of them by building and then running `select column_name, column_comment from information_schema.columns where table_schema='performance_schema' and table_name='file_instances'`. They look good. I've checked in the code to my forked branch here: https://github.com/haidong/server/tree/MDEV-25325 I plan to work on writing tests next. I've never done that before. So if you have suggestions/tips, that would be welcome. I may not be able to get to it until the weekend. PS. I have noted the inconsistencies between the documentation and code files, and will report them also. |
| Comment by Haidong Ji [ 2021-05-16 ] |
|
I have finished all coding tasks, including test cases, at least for the first go-round. I have also just submitted a PR: https://github.com/MariaDB/server/pull/1830
|
| Comment by Sergei Golubchik [ 2021-05-20 ] |
|
great, thanks! |