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.1551953719.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2abfd248c5aa82bc0f7d0311a776a0ab1c24f1cf457fd0625e19932850a6069c |
|
MD5 | e4545fd5af8554d3da3ef063d6efaa74 |
|
BLAKE2b-256 | b5967ca04e7b66026b68c210054003f1e479c133e24df8e07aeaaa838e7c9692 |
Hashes for schemainspect-0.1.1551953719-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | e5f01eb8924fb87291533f6e174c25bc8f24320ffac2c2eabdcddfc466422359 |
|
MD5 | 8a4b8fc0d0f002f18cc1725857b4a9b7 |
|
BLAKE2b-256 | 55ae2ee4abcccc290c60a7bfaa59ff4b90bbf095aa937dcd983b8f9babfdb352 |