Schema inspection for PostgreSQL (and possibly others)
Project description
schemainspect
: SQL Schema Inspection
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!
Author Credits
Initial development, maintenance:
Contributions:
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.1543708870.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 441796f92fa890e91ee597735c3c2f321861674a22a44faf576e53c9777b31b3 |
|
MD5 | 6f8ce5c67fb99a83c996d38a7f4d1bc4 |
|
BLAKE2b-256 | 9eb3aa252a3d93de6f8be195ff7f7911d37ff7566194b321b2ce5ee336bb83cc |
Hashes for schemainspect-0.1.1543708870-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 212c7645315a23632d2008f6741110dbaedea99a592e54a5065c6bc58d1663d2 |
|
MD5 | 5557903121d47195ecc23b68000a5577 |
|
BLAKE2b-256 | 3f5c1b9ce91832c60b55b2b1f26d339cb9d5d4881706e679efe395b4263355a0 |