Schema inspection for PostgreSQL (and possibly others)
Project description
schemainspect
: SQL Schema Inspection
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!
Author Credits
Initial development, maintenance:
Contributions:
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.1548143332.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | d16ddead75bbc5466d8eeb4d1ca6cd16a6ca70f97e4cbe40f11b9fa4c5d1ab39 |
|
MD5 | 41fd700072c0133231d7f51069af4a3c |
|
BLAKE2b-256 | 94b35b34e28879e73297eff440a01becd464df572840c7aa155fc0ccc2d17ac0 |
Hashes for schemainspect-0.1.1548143332-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 94b331df0e30be80d3df1ff7d884c890a5a86e7fce8d83c8cbdf9d4694064d52 |
|
MD5 | d800d2f6239085774656b2e953b8a3fc |
|
BLAKE2b-256 | cd60403689254bf227a57ac649c0abb8feea0acd9bcc9d6b355712bc621cef59 |