Wikka Documentation: DbInfoActionInfo

[1296] Latest edit on 2008-11-01 23:23:06 by DarTar [Removed HomePage link]

Deletions:
~~HomePage~~

[822] Edited on 2008-02-21 18:40:09 by DarTar [minor edit]

Additions:
Of course, it's possible to use an external client such as PhpMyAdmin or a desktop client, but for a quick lookup it's handy to have that information available right inside Wikka.
Deletions:
~~Of course, it's possible to use an external client such as PhpMyAdmin or a desktop client, but for a quick lookup it's handy to have that information available right inside Wikka.~~

[821] Edited on 2008-02-21 18:39:49 by DarTar [minor edits]

Additions:
Of course, it's possible to use an external client such as PhpMyAdmin or a desktop client, but for a quick lookup it's handy to have that information available right inside Wikka.
Deletions:
~~Of course, it's possible to use an external client like PhpMyAdmin or a desktop client, but for a quick lookup it's handy to have that information available right inside Wikka.~~

[760] Edited on 2008-02-19 21:20:41 by BrianKoontz [Added info page]

Additions:
This is the documentation page for the dbinfo action.

DbInfoAction: Additional development notes

An action that provides administrators an easy way to inspect the structure of the tables Wikka is using.
{{dbinfo [all="0|1"] [prefix="0|1"]}}

all	int	optional	0	By specifying all='1' possibly more databases become visible (depending on the permissions of the Wikka database user). If multiple databases are visible, a selection form is shown to pick a database.
prefix	int	optional	1	By specifying prefix='0' the prefix configured for Wikka is ignored, allowing other tables in the same database (if any) to be inspected.

Why
Admins, and especially admins that like to tweak Wikka and create their own extensions, frequently need to check what exactly the database structure is that Wikka is using. Column names, sizes, indexes, etc. are important things to know when creating extensions.
Of course, it's possible to use an external client like PhpMyAdmin or a desktop client, but for a quick lookup it's handy to have that information available right inside Wikka.
How
Although the PHP implementation of MySQL provides a few shortcuts with special functions, these don't support all information that we need. However, the MySQL SHOW command can reveal all we need to know, and it can be used with the PHP PHP:mysql_query function.
Limitations
Since revealing database structure is a potential security risk, only administrators will be able to see what this action has on offer.
Apart from that, it makes use of the configured Wikka database user; what this user can see really depends on what permissions it has been given prior to installation of Wikka, so your mileage may vary.
JavaWoman
Deletions:
This is the documentation page for the DbInfo action.

Related links
Must be added here

This page is a template. It belongs to CategoryTemplate (which contains more handy documentation templates). To create an action documentation page, clone this page to a page called xxxxxActionInfo (where xxxxx is the (capitalized) name of the action), replace all occurrences of xxxxx with the name of the action and replace this paragraph with the actual content.
Remember to change the category link at the bottom of this page to CategoryDocumentation when the new page is ready to be published.
Describe your action in one sentence.
{{action_name [optional_param="xxx"]}}
You can add a longer description here.

param1	int	mandatory	value	This is one of the params, your action uses. Add as many rows as action parameters.
param2	string	optional	value	If your action uses no params, please remove this table

Examples

You can put one or more examples here.
The name(s) of the person(s) who wrote this action.

[716] Edited on 2008-02-19 11:27:24 by BrianKoontz [category changed]

Additions:
CategoryEN
Deletions:
~~CategoryTemplate~~

[698] Edited on 2008-02-19 09:57:24 by BrianKoontz [initialized template]

Additions:

DbInfo Action Documentation

This is the documentation page for the DbInfo action.
Deletions:
DbInfo Action Documentation
This is the documentation page for the DbInfo action.

[696] Edited on 2008-02-19 09:57:00 by BrianKoontz [initialized template]

Additions:

DbInfo Action Documentation

This is the documentation page for the DbInfo action.

NOTE

This feature is available since:
WikkaWiki 1.1.6.4

Deletions:
xxxxx Action Documentation
This is the documentation page for the xxxxx action.

NOTE

This feature is available since:
WikkaWiki 1.1.7

[695] The oldest known version of this page was created on 2008-02-19 09:56:32 by BrianKoontz [Cloned from ActionInfoTemplate]

History of recent changes for DbInfoActionInfo

HomePage

xxxxx Action Documentation

This is the documentation page for the xxxxx action.

NOTE

This feature is available since:
WikkaWiki 1.1.7

Documentation

Short description

Describe your action in one sentence.

Usage

{{action_name [optional_param="xxx"]}}

Parameters
name	type	required?	default	description
param1	int	mandatory	value	This is one of the params, your action uses. Add as many rows as action parameters.
param2	string	optional	value	If your action uses no params, please remove this table

Long description

You can add a longer description here.

Examples

You can put one or more examples here.

Author

The name(s) of the person(s) who wrote this action.

CategoryTemplate