"""Wrapper around psycopg2. Database connection provides regular DB-API 2.0 interface. Connection object methods:: .cursor() .commit() .rollback() .close() Cursor methods:: .execute(query[, args]) .fetchone() .fetchall() Sample usage:: db = self.get_database('somedb') curs = db.cursor() # query arguments as array q = "select * from table where id = %s and name = %s" curs.execute(q, [1, 'somename']) # query arguments as dict q = "select id, name from table where id = %(id)s and name = %(name)s" curs.execute(q, {'id': 1, 'name': 'somename'}) # loop over resultset for row in curs.fetchall(): # columns can be asked by index: id = row[0] name = row[1] # and by name: id = row['id'] name = row['name'] # now commit the transaction db.commit() Deprecated interface: .dictfetchall/.dictfetchone functions on cursor. Plain .fetchall() / .fetchone() give exact same result. """ # no exports __all__ = ['connect_database'] ##from psycopg2.psycopg1 import connect as _pgconnect # psycopg2.psycopg1.cursor is too backwards compatible, # to the point of avoiding optimized access. # only backwards compat thing we need is dict* methods import psycopg2.extensions, psycopg2.extras from skytools.sqltools import dbdict class _CompatRow(psycopg2.extras.DictRow): """Make DictRow more dict-like.""" __slots__ = ('_index',) def __contains__(self, k): """Returns if such row has such column.""" return k in self._index def copy(self): """Return regular dict.""" return dbdict(self.iteritems()) def iterkeys(self): return self._index.iterkeys() def itervalues(self): return list.__iter__(self) # obj.foo access def __getattr__(self, k): return self[k] class _CompatCursor(psycopg2.extras.DictCursor): """Regular psycopg2 DictCursor with dict* methods.""" def __init__(self, *args, **kwargs): psycopg2.extras.DictCursor.__init__(self, *args, **kwargs) self.row_factory = _CompatRow dictfetchone = psycopg2.extras.DictCursor.fetchone dictfetchall = psycopg2.extras.DictCursor.fetchall dictfetchmany = psycopg2.extras.DictCursor.fetchmany class _CompatConnection(psycopg2.extensions.connection): """Connection object that uses _CompatCursor.""" my_name = '?' def cursor(self): return psycopg2.extensions.connection.cursor(self, cursor_factory = _CompatCursor) def connect_database(connstr): """Create a db connection with connect_timeout option. Default connect_timeout is 15, to change put it directly into dsn. """ # allow override if connstr.find("connect_timeout") < 0: connstr += " connect_timeout=15" # create connection db = _CompatConnection(connstr) # fill .server_version on older psycopg if not hasattr(db, 'server_version'): iso = db.isolation_level db.set_isolation_level(0) curs = db.cursor() curs.execute('show server_version_num') db.server_version = curs.fetchone()[0] db.set_isolation_level(iso) return db