Interfaces can handle tags through Add/Get/Update
[plcapi.git] / PLC / PostgreSQL.py
index 30e9c46..172b5c3 100644 (file)
@@ -5,12 +5,14 @@
 # Mark Huang <mlhuang@cs.princeton.edu>
 # Copyright (C) 2006 The Trustees of Princeton University
 #
-# $Id: PostgreSQL.py,v 1.9 2006/11/08 22:43:02 mlhuang Exp $
+# $Id$
 #
 
 import psycopg2
 import psycopg2.extensions
 psycopg2.extensions.register_type(psycopg2.extensions.UNICODE)
+# UNICODEARRAY not exported yet
+psycopg2.extensions.register_type(psycopg2._psycopg.UNICODEARRAY)
 
 import pgdb
 from types import StringTypes, NoneType
@@ -49,33 +51,43 @@ if not psycopg2:
 class PostgreSQL:
     def __init__(self, api):
         self.api = api
+        self.debug = False
+#        self.debug = True
+        self.connection = None
 
-        # Initialize database connection
-        if psycopg2:
-            try:
-                # Try UNIX socket first
-                self.db = psycopg2.connect(user = api.config.PLC_DB_USER,
-                                           password = api.config.PLC_DB_PASSWORD,
-                                           database = api.config.PLC_DB_NAME)
-            except psycopg2.OperationalError:
-                # Fall back on TCP
-                self.db = psycopg2.connect(user = api.config.PLC_DB_USER,
-                                           password = api.config.PLC_DB_PASSWORD,
-                                           database = api.config.PLC_DB_NAME,
-                                           host = api.config.PLC_DB_HOST,
-                                           port = api.config.PLC_DB_PORT)
-            self.db.set_client_encoding("UNICODE")
-        else:
-            self.db = pgdb.connect(user = api.config.PLC_DB_USER,
-                                   password = api.config.PLC_DB_PASSWORD,
-                                   host = "%s:%d" % (api.config.PLC_DB_HOST, api.config.PLC_DB_PORT),
-                                   database = api.config.PLC_DB_NAME)
-
-        self.cursor = self.db.cursor()
+    def cursor(self):
+        if self.connection is None:
+            # (Re)initialize database connection
+            if psycopg2:
+                try:
+                    # Try UNIX socket first
+                    self.connection = psycopg2.connect(user = self.api.config.PLC_DB_USER,
+                                                       password = self.api.config.PLC_DB_PASSWORD,
+                                                       database = self.api.config.PLC_DB_NAME)
+                except psycopg2.OperationalError:
+                    # Fall back on TCP
+                    self.connection = psycopg2.connect(user = self.api.config.PLC_DB_USER,
+                                                       password = self.api.config.PLC_DB_PASSWORD,
+                                                       database = self.api.config.PLC_DB_NAME,
+                                                       host = self.api.config.PLC_DB_HOST,
+                                                       port = self.api.config.PLC_DB_PORT)
+                self.connection.set_client_encoding("UNICODE")
+            else:
+                self.connection = pgdb.connect(user = self.api.config.PLC_DB_USER,
+                                               password = self.api.config.PLC_DB_PASSWORD,
+                                               host = "%s:%d" % (api.config.PLC_DB_HOST, api.config.PLC_DB_PORT),
+                                               database = self.api.config.PLC_DB_NAME)
 
         (self.rowcount, self.description, self.lastrowid) = \
                         (None, None, None)
 
+        return self.connection.cursor()
+
+    def close(self):
+        if self.connection is not None:
+            self.connection.close()
+            self.connection = None
+
     def quote(self, value):
         """
         Returns quoted version of the specified value.
@@ -113,15 +125,25 @@ class PostgreSQL:
         pass
 
     def commit(self):
-        self.db.commit()
+        self.connection.commit()
 
     def rollback(self):
-        self.db.rollback()
+        self.connection.rollback()
 
     def do(self, query, params = None):
-        self.execute(query, params)
+        cursor = self.execute(query, params)
+        cursor.close()
         return self.rowcount
 
+    def next_id(self, table_name, primary_key):
+       sequence = "%(table_name)s_%(primary_key)s_seq" % locals()      
+       sql = "SELECT nextval('%(sequence)s')" % locals()
+       rows = self.selectall(sql, hashref = False)
+       if rows: 
+           return rows[0][0]
+               
+       return None 
+
     def last_insert_id(self, table_name, primary_key):
         if isinstance(self.lastrowid, int):
             sql = "SELECT %s FROM %s WHERE oid = %d" % \
@@ -132,18 +154,39 @@ class PostgreSQL:
 
         return None
 
+    # modified for psycopg2-2.0.7 
+    # executemany is undefined for SELECT's
+    # see http://www.python.org/dev/peps/pep-0249/
+    # accepts either None, a single dict, a tuple of single dict - in which case it execute's
+    # or a tuple of several dicts, in which case it executemany's
     def execute(self, query, params = None):
-        self.execute_array(query, (params,))
 
-    def execute_array(self, query, param_seq):
-        cursor = self.cursor
+        cursor = self.cursor()
         try:
+
             # psycopg2 requires %()s format for all parameters,
             # regardless of type.
             if psycopg2:
                 query = re.sub(r'(%\([^)]*\)|%)[df]', r'\1s', query)
 
-            cursor.executemany(query, param_seq)
+            if not params:
+                if self.debug:
+                    print >> log,'execute0',query
+                cursor.execute(query)
+            elif isinstance(params,dict):
+                if self.debug:
+                    print >> log,'execute-dict: params',params,'query',query%params
+                cursor.execute(query,params)
+            elif isinstance(params,tuple) and len(params)==1:
+                if self.debug:
+                    print >> log,'execute-tuple',query%params[0]
+                cursor.execute(query,params[0])
+            else:
+                param_seq=(params,)
+                if self.debug:
+                    for params in param_seq:
+                        print >> log,'executemany',query%params
+                cursor.executemany(query, param_seq)
             (self.rowcount, self.description, self.lastrowid) = \
                             (cursor.rowcount, cursor.description, cursor.lastrowid)
         except Exception, e:
@@ -157,12 +200,14 @@ class PostgreSQL:
             print >> log, "Query:"
             print >> log, query
             print >> log, "Params:"
-            print >> log, pformat(param_seq[0])
+            print >> log, pformat(params)
             raise PLCDBError("Please contact " + \
                              self.api.config.PLC_NAME + " Support " + \
                              "<" + self.api.config.PLC_MAIL_SUPPORT_ADDRESS + ">" + \
                              " and reference " + uuid)
 
+        return cursor
+
     def selectall(self, query, params = None, hashref = True, key_field = None):
         """
         Return each row as a dictionary keyed on field name (like DBI
@@ -171,12 +216,12 @@ class PostgreSQL:
         selectall_hashref()).
 
         If params is specified, the specified parameters will be bound
-        to the query (see PLC.DB.parameterize() and
-        pgdb.cursor.execute()).
+        to the query.
         """
 
-        self.execute(query, params)
-        rows = self.cursor.fetchall()
+        cursor = self.execute(query, params)
+        rows = cursor.fetchall()
+        cursor.close()
 
         if hashref or key_field is not None:
             # Return each row as a dictionary keyed on field name
@@ -196,6 +241,12 @@ class PostgreSQL:
         Return the names of the fields of the specified table.
         """
 
+        if hasattr(self, 'fields_cache'):
+            if self.fields_cache.has_key((table, notnull, hasdef)):
+                return self.fields_cache[(table, notnull, hasdef)]
+        else:
+            self.fields_cache = {}
+
         sql = "SELECT attname FROM pg_attribute, pg_class" \
               " WHERE pg_class.oid = attrelid" \
               " AND attnum > 0 AND relname = %(table)s"
@@ -208,4 +259,6 @@ class PostgreSQL:
 
         rows = self.selectall(sql, locals(), hashref = False)
 
-        return [row[0] for row in rows]
+        self.fields_cache[(table, notnull, hasdef)] = [row[0] for row in rows]
+
+        return self.fields_cache[(table, notnull, hasdef)]