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.1521505759.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7fca4c8fd67faea99240637fd7db033556b7e029575b53b0134c03b2c0cd4095 |
|
MD5 | 837f4ac66a4a2eb07ce52b9c0449ba7a |
|
BLAKE2b-256 | 1f93ba7ae9ff54e120b76e4712c0f698c9d2284c346178ce762c6f27a43b7ceb |
Hashes for schemainspect-0.1.1521505759-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 43b54642a42b48f8083b51ad992b4c9f9bb50733692895528af6848d19e0a926 |
|
MD5 | f638ce17e4c1ada30ab348995104f8ec |
|
BLAKE2b-256 | 48bef1896fd8389e05eb5fcb13cb020e54d7323a681cb0c92700eb393d978510 |