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]
Metadata
Release files for schemainspect 0.1.1486292158
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| schemainspect-0.1.1486292158.tar.gz | 9.2 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| schemainspect-0.1.1486292158-py2.py3-none-any.whl | Python 3, Python 2 | none | any | Details |
Total release size: 24.0 kB
Release files / schemainspect-0.1.1486292158.tar.gz
| Download URL | schemainspect-0.1.1486292158.tar.gz |
|---|---|
| Size | 9.2 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
89ceb94930575a8601add8384b2c109666a7d80cf819914e69204529c3ca6616
|
|
BLAKE2b-256 checksum How to use checksums |
5ce261fe87ccabc9709cb7f7790c022eedb629c527549586142f525f926a550d
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
Release files / schemainspect-0.1.1486292158-py2.py3-none-any.whl
| Download URL | schemainspect-0.1.1486292158-py2.py3-none-any.whl |
|---|---|
| Size | 14.7 kB |
| Tags | Python 2 Python 3 |
|
SHA-256 checksum How to use checksums |
a2b1f86760ebdd9b751b302a6914e081bc0c76538f837ff269f95cc92b612a8b
|
|
BLAKE2b-256 checksum How to use checksums |
1a6becc563d3d6a7205e7c19b98e46b1518a25e772dabd983b232ea022ce9a06
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |