Bug #13244 Internally Documentable Schema
Submitted: 15 Sep 2005 23:50 Modified: 4 Oct 2005 12:12
Reporter: Greg Keefe Email Updates:
Status: Won't fix Impact on me:
Category:MySQL Server Severity:S4 (Feature request)
Version: OS:
Assigned to: CPU Architecture:Any

[15 Sep 2005 23:50] Greg Keefe
I'd like to request the following feature for MySQL Server:

An Internally Documentable Schema.

if you issue "SHOW columns FROM sometable" there could be an additional column labeled "Documented" that has a value "YES" or "NO".

If the value is "YES", then that would mean that that particular Field has supporting documentation (such as "note by gfk: this column is NOT actually in use and can safely be removed as of 9/15/05 but may eventually be used as part of program example.com/xyz.php.").

A user could view the documentation by issuing a "SHOW documentation FROM sometable WHERE field = 'somefield'"

Greg Keefe

How to repeat:
[4 Oct 2005 12:12] Valeriy Kravchuk
There comment for columns and table already. See http://dev.mysql.com/doc/mysql/en/create-table.html for details:

"A comment for a column can be specified with the COMMENT option. The comment is displayed by the SHOW CREATE TABLE and SHOW FULL COLUMNS statements. This option is operational as of MySQL 4.1. (It is allowed but ignored in earlier versions.)"

So, we have a way to add such a comment already.