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.1575949847.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6c2761162e3fc15f43c40e67eb798b5846228bb17985d2b8920b9af7b6734900 |
|
MD5 | 9528d96d5226db3ee9273c12ba9b802a |
|
BLAKE2b-256 | e276dd1f614b90ddd60e302f4eb87d26343ea2e3e09fe196225a9eea25c360a0 |
Hashes for schemainspect-0.1.1575949847-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0a2c099941939eabbbf1cf5300bb5e7c13726ae855d6003529b99d9618a6788d |
|
MD5 | 46faf4c9b17ed350aa1e98a01b440ae4 |
|
BLAKE2b-256 | 0c7fdaea9fce25a7e77e6aaa91b00a90d864d6718427a312838ee5e349b534c0 |