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.1553852578.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 40dd280ab06529cf6e67d54043375759a63e1480d28908af1a2dbec8b9367ff0 |
|
MD5 | 018bc5236ca7b733adb7ae27a1101706 |
|
BLAKE2b-256 | 48f0baa283a78dc42743fa7c8545fbd81d2ba9be5292a645227e9d2452b88f1c |
Hashes for schemainspect-0.1.1553852578-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 569990c110edb4b408f13dbeb7e792f705723142b88863a6bd0ca3f1e6bf0281 |
|
MD5 | 9d3476c0468c2d56ed19d59dc120185e |
|
BLAKE2b-256 | fda15cf5e8586cf94daf13d4fb4eebd193980f61f3ffdf4e33a9d6701f31ac4d |