Debugging tools/describe table

From TestWiki

The WikiDebug extension adds a new tag that allows you to display a live description of a DB table within a wiki page.

Syntax

<describe_table table="{TableName}" display="{DisplayType}" showindexes="{bool}"></describe_table>

• {TableName} is the name of a table in the wiki's database. Do not include the prefix specified by $wgPrefix.
• {DisplayType} is the output format for the table data and currently has two possible values. "table" outputs the table definition in tabular form and "sql" outputs it as an SQL "CREATE TABLE" statement. The display attribute is optional, and if omitted (or present but the value is invalid) then "sql" will be used.
• showindexes is an optional argument, which defaults to true if omitted. Set to false to disable index display when outputting in tabular form (ignored for SQL output).

As a security measure this extension will only allow display of tables added to the $wgWikiDebug_ViewableTables array. Any other tables are blocked.

For example, to view the table 'page', you would need to add the following to LocalSettings.php:

$wgWikiDebug_ViewableTables[] = "page";

Example 1: SQL output

Providing the table 'page' is in the viewable tables array, then you can show its description by using the following syntax:

<describe_table table="page"></describe_table>

CREATE TABLE IF NOT EXISTS `page` (
  `page_id` int(8) unsigned NOT NULL auto_increment,
  `page_namespace` int(11) NOT NULL default '0',
  `page_title` varchar(255) NOT NULL default '',
  `page_restrictions` tinyblob NOT NULL,
  `page_counter` bigint(20) unsigned NOT NULL default '0',
  `page_is_redirect` tinyint(1) unsigned NOT NULL default '0',
  `page_is_new` tinyint(1) unsigned NOT NULL default '0',
  `page_random` double unsigned NOT NULL default '0',
  `page_touched` varchar(14) NOT NULL default '',
  `page_latest` int(8) unsigned NOT NULL default '0',
  `page_len` int(8) unsigned NOT NULL default '0',
  PRIMARY KEY  (`page_id`),
  UNIQUE KEY `name_title` (`page_namespace`,`page_title`),
  KEY `page_random` (`page_random`),
  KEY `page_len` (`page_len`)
) TYPE=MyISAM;

Example 2: Tabular description with indexes

<describe_table table="page" display="table"></describe_table>

Example 2: Tabular Description without indexes

<describe_table table="page" display="table" showindexes="false"></describe_table>

Example 3: Non-viewable table

If we try and look at a table that is not listed in the $wgWikiDebug_ViewableTables array we get the following: