Schema inspection for PostgreSQL
Project description
Schema inspection for PostgreSQL (and potentially others in the future).
Inspects tables, views, materialized views, constraints, indexes, sequences, enums, functions, and extensions.
Limitations: Function inspection only confirmed to work with SQL/PLPGSQL languages so far.
Basic Usage
Get an inspection object from an already opened 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 other things it tracks. At each of these attributes you’ll find a dictionary (OrderedDict) mapping from fully-qualified-and-quoted-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
Documentation is a bit patchy at the moment. Watch this space!
Install
Install with pip:
$ pip install schemainspect
To install psycopg2 (the PostgreSQL driver) at the same time as well:
$ pip install schemainspect[pg]
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for schemainspect-0.1.1533120907.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 808e2660f0985b59a3b1548c65eec4851b02d15adc938169dfbcd86697b573a5 |
|
MD5 | 3a518796ebea777b7fec108c23eaba30 |
|
BLAKE2b-256 | 4fca96f3562457b014032dec986c5b2ac9d78aad3ff30653189c7f0868c2d76a |
Hashes for schemainspect-0.1.1533120907-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 18839919e2cbc0b38a221b5ebd19a11b18a13202a93e81f81037e34b8920af3c |
|
MD5 | 631428affc7dbc9b525a9c7c9d758a0e |
|
BLAKE2b-256 | f0a581cbfca230854e4c0ff99dc3e0eeb86ea224b4e18f27600fe959b62de8c3 |