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.1533120907
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.1533120907.tar.gz | 11.9 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| schemainspect-0.1.1533120907-py2.py3-none-any.whl | Python 3, Python 2 | none | any | Details |
Total release size: 28.3 kB
Release files / schemainspect-0.1.1533120907.tar.gz
| Download URL | schemainspect-0.1.1533120907.tar.gz |
|---|---|
| Size | 11.9 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
808e2660f0985b59a3b1548c65eec4851b02d15adc938169dfbcd86697b573a5
|
|
BLAKE2b-256 checksum How to use checksums |
4fca96f3562457b014032dec986c5b2ac9d78aad3ff30653189c7f0868c2d76a
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/1.11.0 pkginfo/1.4.2 requests/2.19.1 setuptools/40.0.0 requests-toolbelt/0.8.0 tqdm/4.24.0 CPython/3.7.0
|
Release files / schemainspect-0.1.1533120907-py2.py3-none-any.whl
| Download URL | schemainspect-0.1.1533120907-py2.py3-none-any.whl |
|---|---|
| Size | 16.5 kB |
| Tags | Python 2 Python 3 |
|
SHA-256 checksum How to use checksums |
18839919e2cbc0b38a221b5ebd19a11b18a13202a93e81f81037e34b8920af3c
|
|
BLAKE2b-256 checksum How to use checksums |
f0a581cbfca230854e4c0ff99dc3e0eeb86ea224b4e18f27600fe959b62de8c3
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/1.11.0 pkginfo/1.4.2 requests/2.19.1 setuptools/40.0.0 requests-toolbelt/0.8.0 tqdm/4.24.0 CPython/3.7.0
|
