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.1543633065.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 389b416fd0b00a85074888ce00eae9eb86a149d835f98d79131b2c6a6a6d472a |
|
MD5 | dbc93cbee06c330418db87192075450d |
|
BLAKE2b-256 | 6e369fcedcc0864ecbc1e5e23a4660b2669d74d9774090054e0afbf6d0f69337 |
Hashes for schemainspect-0.1.1543633065-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | fdc2c3f9f8e5344e96280ecbb3081c67d6a9155aceeb5abee3f3a13d174e52d6 |
|
MD5 | b194daffa373b932042db5b47b384d63 |
|
BLAKE2b-256 | b0ae1e2cf9b7122e5ffd014bf503f91d17d599f16eb70d5ed8e54e595a276dae |