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.1488410765.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | b19236bc3d30b0d9c93d645f643bc06e7926630907c8ad9d809f307e41e30ef5 |
|
MD5 | 5b6b46614e18790f4d6cf8f87ae8c94d |
|
BLAKE2b-256 | d7b812ee42b3470c7fa37f75d5ce6a81a5b12b0c7ee9af9985ac2d02d5da6bf9 |
Hashes for schemainspect-0.1.1488410765-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 573fa8e8e4bf4c0ea23a117ae296e2bf0d4403b45aca9369657f2192ffd4e735 |
|
MD5 | 571d55eb3aa1a00cb9f151bf9be892d6 |
|
BLAKE2b-256 | 8114379449df96abe7bdbe2c6a83146efa0966b762873dd37f67820f02352232 |