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.1575949847
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.1575949847.tar.gz | 17.9 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| schemainspect-0.1.1575949847-py2.py3-none-any.whl | Python 2, Python 3 | none | any | Details |
Total release size: 43.3 kB
Release files / schemainspect-0.1.1575949847.tar.gz
| Download URL | schemainspect-0.1.1575949847.tar.gz |
|---|---|
| Size | 17.9 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
6c2761162e3fc15f43c40e67eb798b5846228bb17985d2b8920b9af7b6734900
|
|
BLAKE2b-256 checksum How to use checksums |
e276dd1f614b90ddd60e302f4eb87d26343ea2e3e09fe196225a9eea25c360a0
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/0.12.17 CPython/3.8.0 Linux/4.15.0-1052-aws
|
Release files / schemainspect-0.1.1575949847-py2.py3-none-any.whl
| Download URL | schemainspect-0.1.1575949847-py2.py3-none-any.whl |
|---|---|
| Size | 25.3 kB |
| Tags | Python 2 Python 3 |
|
SHA-256 checksum How to use checksums |
0a2c099941939eabbbf1cf5300bb5e7c13726ae855d6003529b99d9618a6788d
|
|
BLAKE2b-256 checksum How to use checksums |
0c7fdaea9fce25a7e77e6aaa91b00a90d864d6718427a312838ee5e349b534c0
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/0.12.17 CPython/3.8.0 Linux/4.15.0-1052-aws
|
