# Mark Huang <mlhuang@cs.princeton.edu>
# Copyright (C) 2006 The Trustees of Princeton University
#
-# $Id: PostgreSQL.py,v 1.6 2006/10/20 17:53:42 mlhuang Exp $
+# $Id: PostgreSQL.py,v 1.10 2006/11/09 19:34:04 mlhuang Exp $
#
+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
import traceback
import commands
+import re
from pprint import pformat
from PLC.Debug import profile, log
from PLC.Faults import *
+if not psycopg2:
+ is8bit = re.compile("[\x80-\xff]").search
+
+ def unicast(typecast):
+ """
+ pgdb returns raw UTF-8 strings. This function casts strings that
+ appear to contain non-ASCII characters to unicode objects.
+ """
+
+ def wrapper(*args, **kwds):
+ value = typecast(*args, **kwds)
+
+ # pgdb always encodes unicode objects as UTF-8 regardless of
+ # the DB encoding (and gives you no option for overriding
+ # the encoding), so always decode 8-bit objects as UTF-8.
+ if isinstance(value, str) and is8bit(value):
+ value = unicode(value, "utf-8")
+
+ return value
+
+ return wrapper
+
+ pgdb.pgdbTypeCache.typecast = unicast(pgdb.pgdbTypeCache.typecast)
+
class PostgreSQL:
def __init__(self, api):
self.api = api
# Initialize database connection
- 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 = "planetlab4") # XXX api.config.PLC_DB_NAME)
+ 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()
(self.rowcount, self.description, self.lastrowid) = \
(None, None, None)
- def quote(self, params):
+ def quote(self, value):
"""
- Returns quoted version(s) of the specified parameter(s).
+ Returns quoted version of the specified value.
"""
- # pgdb._quote functions are good enough for general SQL quoting
- if hasattr(params, 'has_key'):
- params = pgdb._quoteitem(params)
- elif isinstance(params, list) or isinstance(params, tuple) or isinstance(params, set):
- params = map(pgdb._quote, params)
+ # The pgdb._quote function is good enough for general SQL
+ # quoting, except for array types.
+ if isinstance(value, (list, tuple, set)):
+ return "ARRAY[%s]" % ", ".join(map, self.quote, value)
else:
- params = pgdb._quote(params)
-
- return params
+ return pgdb._quote(value)
quote = classmethod(quote)
def execute_array(self, query, param_seq):
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)
(self.rowcount, self.description, self.lastrowid) = \
(cursor.rowcount, cursor.description, cursor.lastrowid)
- except pgdb.DatabaseError, e:
+ except Exception, e:
try:
self.rollback()
except:
self.execute(query, params)
rows = self.cursor.fetchall()
- if hashref:
+ if hashref or key_field is not None:
# Return each row as a dictionary keyed on field name
# (like DBI selectrow_hashref()).
labels = [column[0] for column in self.description]