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.1530867186.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | b410b8d21d1b5bb972c08f310de73a4dd48c66cfbd682c56ef1ac00ddbf5c3ea |
|
MD5 | 528a7d79e165eb7dcc3c8a97c4eca637 |
|
BLAKE2b-256 | c7ef71ed7482089e753c3915b58d0e93dcfe8d341bf4fecfa9e8c5283921103e |
Hashes for schemainspect-0.1.1530867186-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 782cb913df76590c378f8f47c9c8b81eb4eba837c5625511a71c8c73e4f3a105 |
|
MD5 | ef32449c48eee2f354a94ba9974d9062 |
|
BLAKE2b-256 | 0f9aa42d21a77f9a449104708e39afa7c28363dec76e5e72dd349744192ece83 |