Schema inspection for PostgreSQL
Project description
Schema inspection for PostgreSQL (and potentially others in the future).
Inspects tables, views, materialized views, constraints, indexes, sequences, 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 things it tracks. At each of these attributes you’ll find a dictionary (OrderedDict) mapping from fully-qualified-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.1469700903.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 13f327252fd29fb82ada686c994e58fadba25af988b1067432c0fddd4fc14957 |
|
MD5 | 1705b454005a5fe7bdbbaad22fef1be9 |
|
BLAKE2b-256 | 018e059b72fac1380c123d94e0b580ad1a408379c191158595867967ed79a7d4 |
Hashes for schemainspect-0.1.1469700903-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | a4a86e9ce6b45d5ab04095c490e96e8e53415589e418b515ef322fea2fd02d75 |
|
MD5 | 0f9cf32d0bbb1a7c74820f835c25b32a |
|
BLAKE2b-256 | 228dac0d68c8696de3503adacc10c90b8a443714255e4a2ffc269ce1e27d91b2 |