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]
1 maintainer
Metadata
1 maintainer
Release files for schemainspect 0.1.1552220105
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.1552220105.tar.gz | 16.0 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| schemainspect-0.1.1552220105-py2.py3-none-any.whl | Python 3, Python 2 | none | any | Details |
Total release size: 82.7 kB
Release files / schemainspect-0.1.1552220105.tar.gz
| Download URL | schemainspect-0.1.1552220105.tar.gz |
|---|---|
| Size | 16.0 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
631838e61965ead258edac6c010a36745159f3a0ab7f36c9cbc8e2c0c8ba546b
|
|
BLAKE2b-256 checksum How to use checksums |
ee637ef464ca7f996854b7f6ee7c893eabbfeb01d16d52e161a3d9cadb8a5db8
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/0.12.11 CPython/3.7.2 Linux/4.4.0-141-generic
|
Release files / schemainspect-0.1.1552220105-py2.py3-none-any.whl
| Download URL | schemainspect-0.1.1552220105-py2.py3-none-any.whl |
|---|---|
| Size | 66.8 kB |
| Tags | Python 2 Python 3 |
|
SHA-256 checksum How to use checksums |
ce0e7760512382456d45f42356126e75d45a84c6b32a0e7bb0cc7edaf1cfa0c0
|
|
BLAKE2b-256 checksum How to use checksums |
085869038bc03fd3a161db3dbd20d89b7f7ac0aa7f3ce8d61a9adfe717c3e0d0
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/0.12.11 CPython/3.7.2 Linux/4.4.0-141-generic
|
