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.1552209928.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 80996185e62a51efdd74e73c0586b810b45b02565c4b5efaa0bfcea8a2fda564 |
|
MD5 | 3fbe68f598e5706e25d01f6e4e08dd0d |
|
BLAKE2b-256 | be09b508532ce3b5cc63ee998cad1934d201a96a85e43f8ddf8b3922191eeaca |
Hashes for schemainspect-0.1.1552209928-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | fc65bb82f4eb8f561d13822cbd0fad3788d13fa4164af60f4c8c73a32d9d0130 |
|
MD5 | 39c04be9111d1bc3389fbef2c54d742c |
|
BLAKE2b-256 | 5a816883667c65530731a990a0a08bcf00d4c8e9553e50798291e2e28faba2a3 |