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!
Install
Install with pip:
$ pip install schemainspectTo 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.1470583264
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.1470583264.tar.gz | 9.1 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| schemainspect-0.1.1470583264-py2.py3-none-any.whl | Python 3, Python 2 | none | any | Details |
Total release size: 23.7 kB
Release files / schemainspect-0.1.1470583264.tar.gz
| Download URL | schemainspect-0.1.1470583264.tar.gz |
|---|---|
| Size | 9.1 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
42c94b5208d81ca1189134cd9ebab5f3c81818c221032c8e53a71a6ffb0177ef
|
|
BLAKE2b-256 checksum How to use checksums |
f982ea91764ee3d89b915c9cd76f4e8cc3e3bd40ff66f0735b4b19d2ca276ee5
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
Release files / schemainspect-0.1.1470583264-py2.py3-none-any.whl
| Download URL | schemainspect-0.1.1470583264-py2.py3-none-any.whl |
|---|---|
| Size | 14.6 kB |
| Tags | Python 2 Python 3 |
|
SHA-256 checksum How to use checksums |
224bacc8ed522fdd528ed7f61c0bf6b58317932c184139ebd5e0027179cdc279
|
|
BLAKE2b-256 checksum How to use checksums |
35ac51ab2ba5697e99e47078a082804e3844b11bf915ffb0c32fc3ccd10018e1
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
