Package pydo :: Module dbi :: Class DBIBase
[show private | hide private]
[frames | no frames]

Class DBIBase

object --+
         |
        DBIBase

Known Subclasses:
MssqlDBI, MysqlDBI, OracleDBI, PsycopgDBI, SqliteDBI

base class for db connection wrappers.
Method Summary
  __init__(self, connectArgs, connectFunc, dbapiModule, pool, verbose, initFunc)
constructor.
  _connect(self)
  _convertResultSet(description, resultset, qualified)
internal function that turns a result set into a list of dictionaries. (Static method)
  _initExceptions(self)
  commit(self)
commits a transaction
  cursor(self)
returns a database cursor for direct access to the db connection
  describeTable(self, table, schema)
for the given table, returns a 2-tuple: a dict of Field objects keyed by name, and list of multi-column unique constraints (sets of Fields)).
  endConnection(self)
disassociate from the current connection, which may be deleted or returned to a pool.
  execute(self, sql, values, qualified)
Executes the statement with the values and does conversion of the return result as necessary.
  getAutoIncrement(self, name)
If db uses auto increment, should obtain the value of the auto-incremented field named 'name'
  getConverter(self)
returns a converter instance.
  getSequence(self, name, field, table)
If db has sequences, this should return the next value of the sequence named 'name'
  listTables(self, schema)
list the tables in the database schema
  orderByString(order, limit, offset)
(Static method)
  rollback(self)
rolls back a transaction
  swapConnection(self, connection)
switch the connection in use for the current thread with another one.
    Inherited from object
  __delattr__(...)
x.__delattr__('name') <==> del x.name
  __getattribute__(...)
x.__getattribute__('name') <==> x.name
  __hash__(x)
x.__hash__() <==> hash(x)
  __reduce__(...)
helper for pickle
  __reduce_ex__(...)
helper for pickle
  __repr__(x)
x.__repr__() <==> repr(x)
  __setattr__(...)
x.__setattr__('name', value) <==> x.name = value
  __str__(x)
x.__str__() <==> str(x)
    Inherited from type
  __new__(T, S, ...)
T.__new__(S, ...) -> a new object with type S, a subtype of T

Property Summary
  conn: the underlying db connection

Class Variable Summary
bool auto_increment = False
bool has_sane_rowcount = True
str paramstyle = 'format'

Instance Method Details

__init__(self, connectArgs, connectFunc, dbapiModule, pool=None, verbose=False, initFunc=None)
(Constructor)

constructor.
* connectArgs are arguments passed directly to the underlying
  DBAPI driver.
* connectFunc is the connect function from the DBAPI module.
* pool is a connection pool instance.
* verbose is whether or not to log the sql being executed.
Overrides:
__builtin__.object.__init__

commit(self)

commits a transaction

cursor(self)

returns a database cursor for direct access to the db connection

describeTable(self, table, schema=None)

for the given table, returns a 2-tuple: a dict of Field objects keyed by name, and list of multi-column unique constraints (sets of Fields)). The Field instances should contain information about whether they are unique or sequenced.

endConnection(self)

disassociate from the current connection, which may be deleted or returned to a pool.

execute(self, sql, values=(), qualified=False)

Executes the statement with the values and does conversion of the return result as necessary. result is list of dictionaries, or number of rows affected

getAutoIncrement(self, name)

If db uses auto increment, should obtain the value of the auto-incremented field named 'name'

getConverter(self)

returns a converter instance.

getSequence(self, name, field, table)

If db has sequences, this should return the next value of the sequence named 'name'

listTables(self, schema=None)

list the tables in the database schema

rollback(self)

rolls back a transaction

swapConnection(self, connection)

switch the connection in use for the current thread with another one.

Static Method Details

_convertResultSet(description, resultset, qualified=False)

internal function that turns a result set into a list of dictionaries.

Property Details

conn

the underlying db connection
Get Method:
fget(...)
Set Method:
fset(...)
Delete Method:
fdel(...)

Class Variable Details

auto_increment

Type:
bool
Value:
False                                                                  

has_sane_rowcount

Type:
bool
Value:
True                                                                   

paramstyle

Type:
str
Value:
'format'                                                               

Generated by Epydoc 2.0 on Wed Mar 8 10:18:59 2006 http://epydoc.sf.net