PLC/PostgreSQL.py

   1 #
   2 # PostgreSQL database interface. Sort of like DBI(3) (Database
   3 # independent interface for Perl).
   4 #
   5 # Mark Huang <mlhuang@cs.princeton.edu>
   6 # Copyright (C) 2006 The Trustees of Princeton University
   7 #
   8 # $Id$
   9 #
  10
  11 import pgdb
  12 from types import StringTypes, NoneType
  13 import traceback
  14 import commands
  15 from pprint import pformat
  16
  17 from PLC.Debug import profile, log
  18 from PLC.Faults import *
  19
  20 class PostgreSQL:
  21     def __init__(self, api):
  22         self.api = api
  23
  24         # Initialize database connection
  25         self.db = pgdb.connect(user = api.config.PLC_DB_USER,
  26                                password = api.config.PLC_DB_PASSWORD,
  27                                host = "%s:%d" % (api.config.PLC_DB_HOST, api.config.PLC_DB_PORT),
  28                                database = api.config.PLC_DB_NAME)
  29         self.cursor = self.db.cursor()
  30
  31         (self.rowcount, self.description, self.lastrowid) = \
  32                         (None, None, None)
  33
  34     def quote(self, params):
  35         """
  36         Returns quoted version(s) of the specified parameter(s).
  37         """
  38
  39         # pgdb._quote functions are good enough for general SQL quoting
  40         if hasattr(params, 'has_key'):
  41             params = pgdb._quoteitem(params)
  42         elif isinstance(params, list) or isinstance(params, tuple):
  43             params = map(pgdb._quote, params)
  44         else:
  45             params = pgdb._quote(params)
  46
  47         return params
  48
  49     quote = classmethod(quote)
  50
  51     def param(self, name, value):
  52         # None is converted to the unquoted string NULL
  53         if isinstance(value, NoneType):
  54             conversion = "s"
  55         # True and False are also converted to unquoted strings
  56         elif isinstance(value, bool):
  57             conversion = "s"
  58         elif isinstance(value, float):
  59             conversion = "f"
  60         elif not isinstance(value, StringTypes):
  61             conversion = "d"
  62         else:
  63             conversion = "s"
  64
  65         return '%(' + name + ')' + conversion
  66
  67     param = classmethod(param)
  68
  69     def begin_work(self):
  70         # Implicit in pgdb.connect()
  71         pass
  72
  73     def commit(self):
  74         self.db.commit()
  75
  76     def rollback(self):
  77         self.db.rollback()
  78
  79     def do(self, query, params = None):
  80         self.execute(query, params)
  81         return self.rowcount
  82
  83     def last_insert_id(self):
  84         return self.lastrowid
  85
  86     def execute(self, query, params = None):
  87         self.execute_array(query, (params,))
  88
  89     def execute_array(self, query, param_seq):
  90         cursor = self.cursor
  91         try:
  92             cursor.executemany(query, param_seq)
  93             (self.rowcount, self.description, self.lastrowid) = \
  94                             (cursor.rowcount, cursor.description, cursor.lastrowid)
  95         except pgdb.DatabaseError, e:
  96             self.rollback()
  97             uuid = commands.getoutput("uuidgen")
  98             print >> log, "Database error %s:" % uuid
  99             print >> log, e
 100             print >> log, "Query:"
 101             print >> log, query
 102             print >> log, "Params:"
 103             print >> log, pformat(param_seq[0])
 104             raise PLCDBError("Please contact " + \
 105                              self.api.config.PLC_NAME + " Support " + \
 106                              "<" + self.api.config.PLC_MAIL_SUPPORT_ADDRESS + ">" + \
 107                              " and reference " + uuid)
 108
 109     def selectall(self, query, params = None, hashref = True, key_field = None):
 110         """
 111         Return each row as a dictionary keyed on field name (like DBI
 112         selectrow_hashref()). If key_field is specified, return rows
 113         as a dictionary keyed on the specified field (like DBI
 114         selectall_hashref()).
 115
 116         If params is specified, the specified parameters will be bound
 117         to the query (see PLC.DB.parameterize() and
 118         pgdb.cursor.execute()).
 119         """
 120
 121         self.execute(query, params)
 122         rows = self.cursor.fetchall()
 123
 124         if hashref:
 125             # Return each row as a dictionary keyed on field name
 126             # (like DBI selectrow_hashref()).
 127             labels = [column[0] for column in self.description]
 128             rows = [dict(zip(labels, row)) for row in rows]
 129
 130         if key_field is not None and key_field in labels:
 131             # Return rows as a dictionary keyed on the specified field
 132             # (like DBI selectall_hashref()).
 133             return dict([(row[key_field], row) for row in rows])
 134         else:
 135             return rows