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.1547903959.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3542b56f0459aa7ec2f414fee78fb7d7364c055b4c710541e373cedc3079de11 |
|
MD5 | 67a4b45659ee9ea7af966e8300146172 |
|
BLAKE2b-256 | c3ccfd88fd69aa5cfe6caf85ab52b536239c3129e3763f5702f3396552b9ed2d |
Hashes for schemainspect-0.1.1547903959-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1b186c2c4e92553e5bd5eac6605b114c64087d52069abdb33ee2004275d88906 |
|
MD5 | 9d483f436375e32a0e770d6a05efdedb |
|
BLAKE2b-256 | 9f868a9717276a19b8c4ebf2ce9612bf97a505f0174686954b58f50b3e7c3916 |