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.1556103540.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | f73a166d503fd3d4599d9cfbb3382a36858282d76ee73583c6bd07ca8e600411 |
|
MD5 | 996add3a6d41d748d4bdab4b26a3d3b3 |
|
BLAKE2b-256 | e7584f3b08e53305bf35fac3ea34d9c2140bce3bcbaee00455cc1640b66ece6b |
Hashes for schemainspect-0.1.1556103540-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | a5800644e181838a414ae4c378b7a42646dbd5025425a9490a3e8f9f8b27f7e8 |
|
MD5 | 3e41f426dd56cfa2ce4e641d851b6257 |
|
BLAKE2b-256 | 0a6feaaedc92e3494e302eb141ce96cefd79c845ef66501305ebb138e45a5501 |