Daya Bay Reactor Neutrino Experiment TWiki > DatabasePlugin Daya Bay webs:
Public | 中文 | Internal | Help

Log In or Register

Database Plugin

Provide secure access (read and write) to data in an SQL database, with flexible results formatting.

Any database that has a DBI interface can be used.

This version is for TWiki-4 only.

Usage

%DATABASE_SQL{description="table_description" sql="sql"}%

This is the most general of the commands. It allows you to execute arbitrary SQL statements, and provides flexible formatting of the results. If the SQL statement doesn't return a result (e.g. an UPDATE statement) you must not give a format parameter. The format parameter is a string describing the required format for the results, where each $colname will expand to the value of that column. See FormattedSearch for more on how format, header and separator work.

%DATABASE_SQL_TABLE{description="db1" headers="hdr1,hdr2,hdr3" command="sql command"}%

%DATABASE_SQL_REPEAT{description="description" command="..SQL COMMAND.." columns="col1,col2,col3"}% .... user formatting .... %DATABASE_SQL_REPEAT%

%DATABASE_TABLE{description="table_description" headers="hdr1,hdr2,hdr3" columns="col1,col2,col3"}%

%DATABASE_REPEAT{description="table_description" table="mytable" columns="col1,col2,col3"}% .... user formatting .... %DATABASE_REPEAT%

%DATABASE_EDIT{description="table_description" display_text="HTML link text"}%

Creates a frame and invokes an external database editor.

Examples

%DATABASE_SQL{description="mysql_user_info" format="| $User | $Select_priv |" header="| *User Name* | *Select Privs* |"}%

You will get back a table with one row for each matching database entry.

Using the format functionality, you can define how the database data is displayed wrapping it in any formatting you choose. For example, if you wanted to create a single table cell containing the information for 3 fields of the Kalendus calendar, you could use the following:

%DATABASE_SQL{description="calendar_events" sql="SELECT * from calendar" format="| $startdate $subject $body |"}%

Or let's say you wanted to display the next two upcoming scheduled events in the Kalendus calendar.

%DATABASE_SQL{description="calendar_events" command="SELECT subject,body,startdate FROM kalendus_event WHERE to_days(startdate) > to_days(now()) order by startdate limit 2" format="$startdate<br />$subject<br />$body"}%

Plugin Installation Instructions

IDEA! Note for upgraders; the configuration has moved into configure now. You will have to copy the settings from your existing bin/DatabasePluginConfig.pm manually. it should be fairly obvious what you have to do.

You do not need to install anything in the browser to use this extension. The following instructions are for the administrator who installs the extension on the server where TWiki is running.

Like many other TWiki extensions, this module is shipped with a fully automatic installer script written using the BuildContrib.

Plugin Info

Plugin Author: TWiki:Main.TaitCyrus
Plugin Version: 15561 (12 Dec 2008)
Change History:  
17 Sep 2007 Bugs:Item4343 Minor corrections to Config.spec - TWiki:Main.CrawfordCurrie
18 March 2007 Rewritten for efficiency and clarity, and added DATABASE_SQL - TWiki:Main.CrawfordCurrie
5 May 2003 (v1.3) Add support for the primary DB to be in a local file instead of in a DB. It is acknowledged that this reduces security somewhat
Also added support for Oracle (by adding in the concept of a SID)
20 Mar 2002 (v1.2) Added table editing ability
18 Feb 2002 (v1.11): Removed hard coded $debug=1;
16 Feb 2002 (v1.1): Added the two REPEAT functions
20 Jan 2002 (v1.0): Initial version
CPAN Dependencies: DBI
Other Dependencies: phpmyadmin (optional, to support DATABASE_EDIT)
Perl Version: 5.0 (tested with 5.6.1 [mysql] and 5.8.0 [Oracle and Local] )
Plugin Home: http://TWiki.org/cgi-bin/view/Plugins/DatabasePlugin
Feedback: http://TWiki.org/cgi-bin/view/Plugins/DatabasePluginDev

Related Topics: TWikiPreferences, TWikiPlugins



Revision: r1 - 2015-03-20 - 20:23:07 - TWikiGuest

Copyright © 1999-2019 by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding Daya Bay? Send feedback
Note: Please contribute updates to this topic on TWiki.org at TWiki:TWiki.DatabasePlugin.