Schema inspection for PostgreSQL
Project description
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!
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.1486292158.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 89ceb94930575a8601add8384b2c109666a7d80cf819914e69204529c3ca6616 |
|
MD5 | 7055ae9c954fb08c0d2a8f8d9c712c94 |
|
BLAKE2b-256 | 5ce261fe87ccabc9709cb7f7790c022eedb629c527549586142f525f926a550d |
Hashes for schemainspect-0.1.1486292158-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | a2b1f86760ebdd9b751b302a6914e081bc0c76538f837ff269f95cc92b612a8b |
|
MD5 | c7523ea8e93ac2eb61e54e16d50e9ab2 |
|
BLAKE2b-256 | 1a6becc563d3d6a7205e7c19b98e46b1518a25e772dabd983b232ea022ce9a06 |