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.1543655873.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | c03bfe58500c2c391dd0f5ef1c57dd3b5659bee4e6cea6793c70601ae08108cb |
|
MD5 | c6df6a2bf860d1d9d582c766a819d824 |
|
BLAKE2b-256 | 9dd6a4b073dc7c5eed3ae19101c7099d8c5d5db798b86bb6a1cdadc1c5736f7e |
Hashes for schemainspect-0.1.1543655873-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7620f61f3f119324980611dbb6dce24eb680b96d6c219e08484936a86434a575 |
|
MD5 | 9e9dce454cc611d820a5c324af1514cb |
|
BLAKE2b-256 | 35e134c8d784f77ae99157f9f340517123364e7e4760660fa37ca444f0237977 |