module documentation

Provides an abstraction for obtaining database schema information.

Usage Notes:

Here are some general conventions when accessing the low level inspector methods such as get_table_names, get_columns, etc.

  1. Inspector methods return lists of dicts in most cases for the following reasons:
    • They're both standard types that can be serialized.
    • Using a dict instead of a tuple allows easy expansion of attributes.
    • Using a list for the outer structure maintains order and is easy to work with (e.g. list comprehension [d['name'] for d in cols]).
  2. Records that contain a name, such as the column name in a column record use the key 'name'. So for most return values, each record will have a 'name' attribute..
Class ​Inspector Performs database schema inspection.
Function cache Undocumented
@util.decorator
def cache(fn, self, con, *args, **kw):

Undocumented