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.1503198422.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | e937266e369c3d93134f1896563771efe3ca45d626f512ce98d4198aa6441af5 |
|
MD5 | 8d5ab0467c7da590c358b298a88b39ba |
|
BLAKE2b-256 | 1ed183aed04bd75e48ba7bf3a1a984200ade9af12411e6465cfcee7db52214a5 |
Hashes for schemainspect-0.1.1503198422-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8b656f53d4fe7648256ed5f8dc54a4b5e9347ffd73424c21301ac08f8d50d08f |
|
MD5 | a2c3675b161c0681d02fc59b3a262501 |
|
BLAKE2b-256 | 19e99633e6dec145c3f02ab0fccfabd4e3ca4ed9e6050c9f3b072eae4fea8070 |