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.1525395046.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0ea0b536a92270701592a330e2ff79567e67de39494a0f9cf71acc73f8cf7aab |
|
MD5 | 6f8848755c373c836f8e2eb1f74e1269 |
|
BLAKE2b-256 | 711970c9159aa3cb7c3a4d88a37ca0b8e6582f2a33267a9de700f3bdb9e783e9 |
Hashes for schemainspect-0.1.1525395046-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | d6c5acfb17efc123025ed2e923d2dc19c2c59ee3d604890ce97198d3f4dac17f |
|
MD5 | f84a19258e1fea242b7206f3e94caa33 |
|
BLAKE2b-256 | 4b6c3b6b9cdd98f2a86b6ed6a378020ef5ec98191ae42ed1a4efce9360b085bd |