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.1551695490.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | f5b1c9152c0289a492288e09b82aea95920e86e20656dbfae1e19cc55ea1bdaa |
|
MD5 | e840801db99232d2257429693de57af1 |
|
BLAKE2b-256 | 85fe99819f5dc7c3dd4a750a2e9c98331e23f0eafd5a64235ff3ac17eac3eedd |
Hashes for schemainspect-0.1.1551695490-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f0b9e8eddc431364078af9d68931fbb5c014b41f65d5983389591ae989618cbb |
|
MD5 | c069f7de668e1c7f53a09ab4a1e8f5a5 |
|
BLAKE2b-256 | 45076859569f83758bd1a14dda738d6efbbd61e3a8057a2118edd1f79e18f274 |