Tags:
database6Add my vote for this tag import4Add my vote for this tag integration3Add my vote for this tag twiki_application2Add my vote for this tag web_application1Add my vote for this tag create new tag
, view all tags

Database Plugin

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

Any database that has a CPAN:DBI interface can be used.

Usage

DATABASE_SQL

%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.

  • description - identifies the database configuration to use (required)
  • sql - The SQL to execute (required)
  • format - (optional) Format to display results in. if you don't give this parameter results will be ignored.
  • header - (optional) The header to display on the results table.
  • separator - string that separates results. Default newline.

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

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

  • description - identifies the database configuration to use
  • headers - Table headers.
  • command - Any SQL command that returns rows
  • ALERT! This syntax is maintained for compatibility. You are recommended to use DATABASE_SQL instead.

DATABASE_SQL_REPEAT

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

  • description - identifies the database configuration to use
  • columns - The columns in the table to return. Default "*"
  • command - Any SQL command that returns values
  • ALERT! This syntax is maintained for compatibility. You are recommended to use DATABASE_SQL instead.

DATABASE_TABLE

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

  • description - identifies the database+table configuration to use (required)
  • columns - The columns in the table to return. Default "*"
  • headers - Table headers
  • ALERT! This command requires a table to be specified in the configuration.
  • ALERT! This syntax is maintained for compatibility. You are recommended to use DATABASE_SQL instead.

DATABASE_REPEAT

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

  • description - identifies the database+table configuration to use
  • columns - The columns in the table to return. Default "*"
  • ALERT! This command requires a table to be specified in the configuration.
  • ALERT! This syntax is maintained for compatibility. You are recommended to use DATABASE_SQL instead.

DATABASE_EDIT

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

Creates a frame and invokes an external database editor.

  • description - identifies the database configuration to use
  • display_text - (optional) The columns in the table to return

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

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.

  • If you have TWiki 4.2 or later, you can install from the configure interface (Go to Plugins->Find More Extensions)
  • If you have any problems, then you can still install manually from the command-line:
    1. Download one of the .zip or .tgz archives
    2. Unpack the archive in the root directory of your TWiki installation.
    3. Run the installer script ( perl <module>_installer )
    4. Run configure and enable the module, if it is a plugin.
    5. Repeat for any missing dependencies.
  • If you are still having problems, then instead of running the installer script:
    1. Make sure that the file permissions allow the webserver user to access all files.
    2. Check in any installed files that have existing ,v files in your existing install (take care not to lock the files when you check in)
    3. Manually edit LocalSite.cfg to set any configuration variables.

  • Use configure to set up the plugin.

Plugin Info

  • One line description, is shown in the TextFormattingRules topic:
    • Set SHORTDESCRIPTION = Provide access to data in a SQL database

Plugin Author: TWiki:Main.TaitCyrus
Copyright: © 2002-2007 TWiki:Main.TaitCyrus
© 2007-2011 TWiki:TWiki.TWikiContributor
License: GPL (GNU General Public License)
Plugin Version: 22417 (2011-11-11)
Change History:  
2011-11-11: TWikibug:Item6800: Fix for using qw(...) as parentheses, which is deprecated in Perl 5.14 -- TWiki:Main.PeterThoeny
2011-05-14: TWikibug:Item6701: Small fix in Config.spec -- TWiki:Main.PeterThoeny
2011-02-19: TWikibug:Item6638: Doc improvements; changing TWIKIWEB to SYSTEMWEB -- TWiki:Main.PeterThoeny
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: CPAN: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

Topic attachments
I Attachment History Action Size Date Who Comment
Unknown file formatmd5 DatabasePlugin.md5 r10 r9 r8 r7 r6 manage 0.2 K 2011-11-11 - 23:19 PeterThoeny  
Compressed Zip archivetgz DatabasePlugin.tgz r10 r9 r8 r7 r6 manage 9.6 K 2011-11-11 - 23:19 PeterThoeny  
Compressed Zip archivezip DatabasePlugin.zip r21 r20 r19 r18 r17 manage 18.3 K 2011-11-11 - 23:19 PeterThoeny  
Unknown file formatEXT DatabasePlugin_installer r5 r4 r3 r2 r1 manage 3.9 K 2011-11-11 - 23:19 PeterThoeny  
Edit | Attach | Watch | Print version | History: r27 < r26 < r25 < r24 < r23 | Backlinks | Raw View | Raw edit | More topic actions
Topic revision: r27 - 2013-10-16 - PeterThoeny
 
  • Learn about TWiki  
  • Download TWiki
This site is powered by the TWiki collaboration platform Powered by Perl Hosted by OICcam.com Ideas, requests, problems regarding TWiki? Send feedback. Ask community in the support forum.
Copyright © 1999-2015 by the contributing authors. All material on this collaboration platform is the property of the contributing authors.