added filter_sql to SQL backends which takes an arbitrary SQL statement...

...and returns a list of item ids

Author: Richard Jones

CHANGES.txt

@@ -20,6 +20,8 @@ Feature:
   backends
 - sorting, grouping, and searching by transitive properties (e.g.,
   messages.author.supervisor) is now supported in all backends
+- added filter_sql to SQL backends which takes an arbitrary SQL statement
+  and returns a list of item ids
 
 Fixed:
 - Verbose option for import and export (sf bug 1505645)

doc/customizing.txt

@@ -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 @@ filter      lists of items from this class, filtered and sorted. Two
             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/backends/rdbms_common.py

@@ -15,7 +15,7 @@
 # BASIS, AND THERE IS NO OBLIGATION WHATSOEVER TO PROVIDE MAINTENANCE,
 # SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
 #
-#$Id: rdbms_common.py,v 1.178 2006-08-29 04:20:50 richard Exp $
+#$Id: rdbms_common.py,v 1.179 2006-08-29 04:32:49 richard Exp $
 ''' Relational database (SQL) backend common code.
 
 Basics:
@@ -2319,6 +2319,25 @@ def filter(self, search_matches, filterspec, sort=[], group=[]):
             self.db.stats['filtering'] += (time.time() - start_t)
         return l
 
+    def filter_sql(self, sql):
+        '''Return a list of the ids of the items in this class 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.
+        '''
+        if __debug__:
+            start_t = time.time()
+
+        self.db.sql(sql)
+        l = self.db.sql_fetchall()
+
+        if __debug__:
+            self.db.stats['filtering'] += (time.time() - start_t)
+        return l
+
     def count(self):
         '''Get the number of nodes in this class.