wiki:WikiTableMacro

Version 13 (modified by anonymous, 3 years ago) (diff)

--

SQL Table in Wiki Page

Description

This is a simple macro that enables you to place tables resulting from SQL queries into a wiki page.

It is similar to, but simpler than, SqlQueryMacro. The main differences are that it has fewer dependencies and always queries the Trac database, rather than letting you set up a separate data connection.

Usage

Use the SQLTable macro:

    {{{
    #!SQLTable
        SELECT count(id) as 'Number of Tickets'
        FROM ticket
    }}}

The result will be a table.

Use the SQLScalar macro:

    {{{
    #!SQLScalar
        SELECT count(id) as 'Number of Tickets'
        FROM ticket
    }}}

The result will be a single number.

Installation

  1. Install globally with:
      sudo easy_install https://trac-hacks.org/svn/wikitablemacro/0.11/
    
  2. Enable the plugin by updating TracIni file (..../trac.ini) as follows:
      [components]
      wikitable.* = enabled
    
  3. Restart web server on command line:
        $ sudo /etc/init.d/apache2 restart
    

Bugs/Feature Requests

Existing bugs and feature requests for WikiTableMacro are here.

If you have any issues, create a new ticket.

Known issues

  1. Issue: If incorrect SQL sentences are entered, auto preview (Trac 0.12) isn´t updated, neither any error message is shown until you submit / save your changes. When you save changes Trac will rise error message. You will not be able to edit that wiki page anymore.
    1. Workaround / Tip: You can still delete incorrect wiki entry by going into Timeline and locating diff link.

Source & Download

You can check out WikiTableMacro from here using Subversion, or browse the source with Trac.

Download the zipped source from here.

Recent Changes

[14531] by rjollos on 2015-04-13 21:24:22
0.3dev: Fix issue fetching from cursor on MySQL.

Patch by theYT <dev@…>. Fixes #12269.

[14524] by rjollos on 2015-04-09 02:08:20
0.3dev: Use Trac 1.0 DB API.

  • Macro now requires Trac 1.0 and later.
  • Genshi is used to construct the table.
  • Queries can use non-ASCII table names. Fixes #11708.
  • Read-only database connection is used.

Please report any issues with the latest changes.

[14523] by rjollos on 2015-04-09 00:34:21
0.2: Tagging version 0.2.

Author/Contributors

Author: optilude
Maintainer: rjollos
Contributors:


Some Patches

I added below to render_macro to provide a rudimentary sort of variable function.

    def render_macro(self, req, name, content):
+        c = content.split("|;|")
+        content = c[0]
+        if len(c) > 1 :
+                for i in c[1:] :
+                        v = i.split("=")
+                        if len(v) > 1 :
+                                k = v[0]
+                                v = v[1]
+                                content = content.replace(k,v)

i.e. you can do something like this

    {{{
    #!SQLTable
        SELECT "a", count($id) as 'Number of Tickets' 
        FROM ticket
        UNION
        SELECT "b", count($id) as 'Number of Tickets' 
        FROM ticket|;|$id=id
    }}}

Useful when you have the same id that you don't want to keep on retyping over.