diff doc/customizing.txt @ 3688:722ab52d47fc

added filter_sql to SQL backends which takes an arbitrary SQL statement... ...and returns a list of item ids
author Richard Jones <richard@users.sourceforge.net>
date Tue, 29 Aug 2006 04:32:49 +0000
parents d6aeef8a1910
children 790363e96852
line wrap: on
line diff
--- a/doc/customizing.txt	Tue Aug 29 04:20:50 2006 +0000
+++ b/doc/customizing.txt	Tue Aug 29 04:32:49 2006 +0000
@@ -2,7 +2,7 @@
 Customising Roundup
 ===================
 
-:Version: $Revision: 1.204 $
+:Version: $Revision: 1.205 $
 
 .. This document borrows from the ZopeBook section on ZPT. The original is at:
    http://www.zope.org/Documentation/Books/ZopeBook/current/ZPT.stx
@@ -1871,6 +1871,17 @@
             eg. ``issue.filter(filterspec={"priority": "1"},
             sort=('activity', '+'))``
 
+filter_sql  **Only in SQL backends**
+
+            Lists the items that match the SQL provided. The SQL is a
+            complete "select" statement.
+
+            The SQL select must include the item id as the first column.
+
+            This function **does not** filter out retired items, add
+            on a where clause "__retired__ <> 1" if you don't want
+            retired nodes.
+
 classhelp   display a link to a javascript popup containing this class'
             "help" template.
 

Roundup Issue Tracker: http://roundup-tracker.org/