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.1542089233.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | a8c4300a7aaaac3ca16f187ef0aa158747ba41e4008814d1a2abb8806b774ae1 |
|
MD5 | 5234dc27b4e962e4854c301e043ed1af |
|
BLAKE2b-256 | 34874494b64b705c0641bb6d6a70b4a9150c1ac057e5559cf49f5df504379c10 |
Hashes for schemainspect-0.1.1542089233-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7612b326c6213e93628c41e00d78f41d20f5a0e8e71e3c076b986c076b7c3b0e |
|
MD5 | 309a64ae9c9de22111a92a7ef7a333d8 |
|
BLAKE2b-256 | 310eb676202900aee0ba0a2a9030695d311c59db6a8ce45cccb2d215b08973d1 |