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.1535502343.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8efba7f4d1f1984518588c4c3e50879199a0823e14d0d141b03f3104e38cd3bd |
|
MD5 | 21502ddbebcc4abd0e523d2f94b87f46 |
|
BLAKE2b-256 | 77bc7d29b954e047f99d4280e98c754ec55d46547ab7d00c92eee8273d7a16c6 |
Hashes for schemainspect-0.1.1535502343-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 72aaf458b9b251e8ad7f97fec26d9e2bfdfaa3fb249416ee301821276bbfe9ab |
|
MD5 | 1f9897f406e02574637c6140d64be941 |
|
BLAKE2b-256 | 11565cba4bb6a1c73ab44b2e1c5b9724f411589fb27a9330e26e52e5e2e258bf |