Schema inspection for PostgreSQL
Project description
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!
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.1519171230.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4027634615345820b44062dc27925a1d8ef12be996462b64ad7eaf16785c15cb |
|
MD5 | 7fa4418526951a7452321389294c1742 |
|
BLAKE2b-256 | 7fdfedf654bdce0a27aae209c332b3d6a8b6af9e0d9a5ae65fc8b16b02668ce4 |
Hashes for schemainspect-0.1.1519171230-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 64ff865e51d031e0b87b3ef3b22be33033ae1c6661accd6cb549083b7558c600 |
|
MD5 | ac727afc8706dd20cbb99bf6762d107b |
|
BLAKE2b-256 | 1858735dfd81a7dda0b1a5fb0262efa5fc7552ff40fcc2220e665bf5e74a6162 |