Schema inspection for PostgreSQL
Schema inspection for PostgreSQL (and potentially others in the future).
Inspects tables, views, materialized views, constraints, indexes, sequences and functions.
Limitations: Function inspection only confirmed to work with SQL/PLPGSQL languages so far. Doesn’t inspect function modifiers (IMMUTABLE/STABLE/VOLATILE, STRICT, RETURNS NULL ON NULL INPUT, etc).
Get an inspection object from an SQLAlchemy session or connection as follows:
from schemainspect import get_inspector from sqlbag import S with S('postgresql:///example') as s: i = get_inspector(s)
The inspection object has attributes for tables, views, and all the things it tracks. At each of these attributes you’ll find a dictionary (OrderedDict) mapping from fully-qualified-name-of-thing-in-database to information object.
For instance, the information about a table books would be accessed as follows:
>>> books_table = i.tables['"public"."books"'] >>> books_table.name 'books' >>> books_table.schema 'public' >>> [each.name for each in books_table.columns] ['id', 'title', 'isbn']
Documentation is a bit patchy at the moment. Watch this space!
Install with pip:
$ pip install schemainspect
To install psycopg2 (the PostgreSQL driver) at the same time as well:
$ pip install schemainspect[pg]
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
|Filename, Size & Hash SHA256 Hash Help||File Type||Python Version||Upload Date|
(11.4 kB) Copy SHA256 Hash SHA256
|Wheel||3.5||Jul 25, 2016|
(6.7 kB) Copy SHA256 Hash SHA256
|Source||None||Jul 25, 2016|