PostgreSQL backend lands.

- that's the postgresql backend in (cleaned up doc, unit testing harness and
  the backend module itself)
- also cleaned up the index maintenance code (actual checks for existence
  rather than bare-except failure mode)

Author: Richard Jones

CHANGES.txt

@@ -7,7 +7,7 @@ Feature:
 - support setgid and running on port < 1024 (sf patch 777528)
 - using Zope3's test runner now, allowing GC checks, nicer controls and
   coverage analysis
-- !BETA! added postgresql backend, needs work !BETA!
+- added postgresql backend
 - all RDBMS backends now have indexes on several columns
 - Change nosymessage and send_message to accept msgid=None (RFE #707235).
 

doc/postgresql.txt

@@ -18,29 +18,40 @@ additionally install:
    http://initd.org/software/initd/psycopg
 
 
+Running the PostgreSQL unit tests
+=================================
+
+The user that you're running the tests as will need to be able to access
+the postgresql database on the local machine and create and drop
+databases. Edit the ``test/test_postgresql.py`` database connection info if
+you wish to test against a different database.
+
+The test database will be called "rounduptest".
+
+
 Additional configuration
 ========================
 
 To initialise and use PostgreSQL database roundup's configuration file
 (config.py in the tracker's home directory) should be appended with the
 following constants (substituting real values, obviously)::
 
-    POSTGRESQL_DBHOST = 'localhost'
-    POSTGRESQL_DBUSER = 'roundup'
-    POSTGRESQL_DBPASSWORD = 'roundup'
-    POSTGRESQL_DBNAME = 'roundup'
-    POSTGRESQL_PORT = 5432
+    POSTGRESQL_DATABASE = {'database': 'rounduptest'}
+
+if not local, or a different user is to be used, then more information may
+be supplied::
+
     POSTGRESQL_DATABASE = {
-        'host': MYSQL_DBHOST, 'port': POSTGRESQL_PORT,
-        'user': MYSQL_DBUSER, 'password': MYSQL_DBPASSWORD,
-        'database': MYSQL_DBNAME
+        'host': 'localhost', 'port': 5432,
+        'database': 'roundup'
+        'user': 'roundup', 'password': 'roundup',
     }
 
 Also note that you can leave some values out of
 ``POSTGRESQL_DATABASE``: 'host' and 'port' are not necessary when
 connecting to a local database and 'password'
 is optional if postgres trusts local connections. The user specified in
-``POSTGRESQL_DBUSER`` must have rights to create a new database and to
+``user`` must have rights to create a new database and to
 connect to the "template1" database, used while initializing roundup.
 
     Have fun with psycopg,

roundup/backends/back_mysql.py

@@ -92,7 +92,14 @@ def sql_fetchone(self):
 
     def sql_fetchall(self):
         return self.cursor.fetchall()
-    
+
+    def sql_index_exists(self, table_name, index_name):
+        self.cursor.execute('show index from %s'%table_name)
+        for index in self.cursor.fetchall():
+            if index[2] == index_name:
+                return 1
+        return 0
+
     def save_dbschema(self, schema):
         s = repr(self.database_schema)
         self.sql('INSERT INTO schema VALUES (%s)', (s,))
@@ -138,8 +145,24 @@ def create_class_table(self, spec):
         if __debug__:
           print >>hyperdb.DEBUG, 'create_class', (self, sql)
         self.cursor.execute(sql)
+        self.create_class_table_indexes(spec)
         return cols, mls
 
+    def drop_class_table_indexes(self, cn, key):
+        # drop the old table indexes first
+        l = ['_%s_id_idx'%cn, '_%s_retired_idx'%cn]
+        if key:
+            l.append('_%s_%s_idx'%(cn, key))
+
+        table_name = '_%s'%cn
+        for index_name in l:
+            if not self.sql_index_exists(table_name, index_name):
+                continue
+            index_sql = 'drop index %s on %s'%(index_name, table_name)
+            if __debug__:
+                print >>hyperdb.DEBUG, 'drop_index', (self, index_sql)
+            self.cursor.execute(index_sql)
+
     def create_journal_table(self, spec):
         cols = ',' . join(['`%s` VARCHAR(255)'%x
           for x in 'nodeid date tag action params' . split()])
@@ -148,6 +171,16 @@ def create_journal_table(self, spec):
         if __debug__:
             print >>hyperdb.DEBUG, 'create_class', (self, sql)
         self.cursor.execute(sql)
+        self.create_journal_table_indexes(spec)
+
+    def drop_journal_table_indexes(self, classname):
+        index_name = '%s_journ_idx'%classname
+        if not self.sql_index_exists('%s__journal'%classname, index_name):
+            return
+        index_sql = 'drop index %s on %s__journal'%(index_name, classname)
+        if __debug__:
+            print >>hyperdb.DEBUG, 'drop_index', (self, index_sql)
+        self.cursor.execute(index_sql)
 
     def create_multilink_table(self, spec, ml):
         sql = '''CREATE TABLE `%s_%s` (linkid VARCHAR(255),
@@ -156,6 +189,20 @@ def create_multilink_table(self, spec, ml):
         if __debug__:
           print >>hyperdb.DEBUG, 'create_class', (self, sql)
         self.cursor.execute(sql)
+        self.create_multilink_table_indexes(spec, ml)
+
+    def drop_multilink_table_indexes(self, classname, ml):
+        l = [
+            '%s_%s_l_idx'%(classname, ml),
+            '%s_%s_n_idx'%(classname, ml)
+        ]
+        for index_name in l:
+            if not self.sql_index_exists(table_name, index_name):
+                continue
+            index_sql = 'drop index %s on %s'%(index_name, table_name)
+            if __debug__:
+                print >>hyperdb.DEBUG, 'drop_index', (self, index_sql)
+            self.cursor.execute(index_sql)
 
 class MysqlClass:
     # we're overriding this method for ONE missing bit of functionality.

roundup/backends/back_postgresql.py

@@ -11,28 +11,7 @@
 from roundup.backends.rdbms_common import *
 from roundup.backends import rdbms_common
 import psycopg
-import os, shutil
-
-class Maintenance:
-    """ Database maintenance functions """
-    def db_nuke(self, config):
-        """Clear all database contents and drop database itself"""
-        config.POSTGRESQL_DATABASE['database'] = 'template1'
-        db = Database(config, 'admin')
-        db.conn.set_isolation_level(0)
-        db.sql("DROP DATABASE %s" % config.POSTGRESQL_DBNAME)
-        db.sql("CREATE DATABASE %s" % config.POSTGRESQL_DBNAME)
-        if os.path.exists(config.DATABASE):
-            shutil.rmtree(config.DATABASE)
-        config.POSTGRESQL_DATABASE['database'] = config.POSTGRESQL_DBNAME
-
-    def db_exists(self, config):
-        """Check if database already exists"""
-        try:
-            db = Database(config, 'admin')
-            return 1
-        except:
-            return 0
+import os, shutil, popen2
 
 class Database(Database):
     arg = '%s'
@@ -58,7 +37,7 @@ def close(self):
         self.conn.close()
 
     def __repr__(self):
-        return '<psycopgroundsql 0x%x>' % id(self)
+        return '<roundpsycopgsql 0x%x>' % id(self)
 
     def sql_fetchone(self):
         return self.cursor.fetchone()
@@ -67,7 +46,15 @@ def sql_fetchall(self):
         return self.cursor.fetchall()
 
     def sql_stringquote(self, value):
-        return psycopg.QuotedString(str(value))
+        ''' psycopg.QuotedString returns a "buffer" object with the
+            single-quotes around it... '''
+        return str(psycopg.QuotedString(str(value)))[1:-1]
+
+    def sql_index_exists(self, table_name, index_name):
+        sql = 'select count(*) from pg_indexes where ' \
+            'tablename=%s and indexname=%s'%(self.arg, self.arg)
+        self.cursor.execute(sql, (table_name, index_name))
+        return self.cursor.fetchone()[0]
 
     def save_dbschema(self, schema):
         s = repr(self.database_schema)
@@ -139,10 +126,6 @@ def create_multilink_table(self, spec, ml):
 
         self.cursor.execute(sql)
 
-    # Static methods
-    nuke = Maintenance().db_nuke
-    exists = Maintenance().db_exists
-
 class PsycopgClass:
     def find(self, **propspec):
         """Get the ids of nodes in this class which link to the given nodes."""
@@ -174,6 +157,8 @@ def find(self, **propspec):
             if type(values) is type(''):
                 allvalues += (values,)
                 where.append('_%s = %s' % (prop, a))
+            elif values is None:
+                where.append('_%s is NULL'%prop)
             else:
                 allvalues += tuple(values.keys())
                 where.append('_%s in (%s)' % (prop, ','.join([a]*len(values))))

roundup/backends/back_sqlite.py

@@ -1,4 +1,4 @@
-# $Id: back_sqlite.py,v 1.10 2003-10-07 07:17:54 anthonybaxter Exp $
+# $Id: back_sqlite.py,v 1.11 2003-11-11 11:19:18 richard Exp $
 __doc__ = '''
 See https://pysqlite.sourceforge.net/ for pysqlite info
 '''
@@ -106,6 +106,13 @@ def sql_commit(self):
             if str(error) != 'cannot commit - no transaction is active':
                 raise
 
+    def sql_index_exists(self, table_name, index_name):
+        self.cursor.execute('pragma index_list(%s)'%table_name)
+        for entry in self.cursor.fetchall():
+            if entry[1] == index_name:
+                return 1
+        return 0
+
     def save_dbschema(self, schema):
         ''' Save the schema definition that the database currently implements
         '''