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.1488167750.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | bf6f20c47dbedc7c0e08e71668fa4c027c0dd5a2162befe6c0720c64ebc9d65e |
|
MD5 | 8cc54b6e334b9ddcc1c2badc6e6145a0 |
|
BLAKE2b-256 | 13504937deea8588d27ca7ea4de451cf67aae4ea7580aa79901987f00ef924a7 |
Hashes for schemainspect-0.1.1488167750-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | a60d5c04548bd98346a4ec7518ebba5d340fbc6ec4f2eb3c01b2b8880d526cdc |
|
MD5 | 56cbf21264f968deda17297dde14337c |
|
BLAKE2b-256 | bacfaf1f89859e9f2c1258e0b9dbf473e8b3584de454d04367344ed53638e82b |