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.1553817909.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8aca45976ab2248c359349d3464a9b08fb967c641aadff7693e4abeddcb44e1f |
|
MD5 | 859391bc2dcaa68c2a97586d8d1ca86e |
|
BLAKE2b-256 | 2870a31c9493e3f662b4dabd0d97567d7245fcaaaee977f064197e1d6ada589f |
Hashes for schemainspect-0.1.1553817909-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6519508b0f0addbf42787a078d61d466b3e0624d10b4906a1369247b16a1d27e |
|
MD5 | d62f577e3e1093f53c11f57a3895f229 |
|
BLAKE2b-256 | 95457210dca6f10e1126ab21f70032d9876ce3eb78c027d9acd49014c89d0cb3 |