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.1494928171.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | cddc7f4a1d9448aa84026738c71367fc36ba9b68f4e283ff59a4c8b73d0daafe |
|
MD5 | cd192ccbda05ee00bc757ca60e5edc7d |
|
BLAKE2b-256 | 424dd6511355b7e634a7a4731121c3f6a650f7f24857f3ced07f16cbdc068483 |
Hashes for schemainspect-0.1.1494928171-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 158a905c6fbc7fdfc839023b04d6d36f498d6126f81babf2e784560623ffffa9 |
|
MD5 | 0c3b6c9b1a541eeda06a4a4c08c82107 |
|
BLAKE2b-256 | 939a9a5a6fcc2b2f08c42cfe67444b0dab06c2c05a33d84e7b085a6f16eac8d5 |