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.1472341830.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 69b1b884dd2c0660d317279a2f48390fc03d2f4fe8f1bc5485cd19a637f628d7 |
|
MD5 | 1b5dc0fc6ff115e941d1cb6aed0c202d |
|
BLAKE2b-256 | 8c15dd8ec32b9e95b535b5950bd8461bd8d51c9fadde812e92bee49862abf5f4 |
Hashes for schemainspect-0.1.1472341830-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3ddac7a19076e057afdd5275ba0cdd65c981ffeade8f799c136aebd58f1f9e3f |
|
MD5 | d1714a5bb3fe779b40072c0a9dc24c71 |
|
BLAKE2b-256 | 3e32803d0d03d6faa70edc6d9307f09999f2a4c1ecc20797379a4fe2302b504a |