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.1542097438.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5823f221658ffbccb84ffe489403854488713b543003f43a132b7c830941fe00 |
|
MD5 | 1f19ef24c093204a90cc31e5281f80fd |
|
BLAKE2b-256 | dbbe7e4cc98bc00ac66462dfa3e45974bd6c42f6754dd094d97e58a199df5e07 |
Hashes for schemainspect-0.1.1542097438-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 39b31a9c23c52e8f41c984e438671235612f8593a6e32b96cf754a1dbe28865e |
|
MD5 | 81521c69c37e8b4eebaf560ac075f0a8 |
|
BLAKE2b-256 | d325c4bca049687cca5641532917177711d514610eea10c01a8e17858e27174e |