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.1571629429
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.1571629429.tar.gz | 16.2 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| schemainspect-0.1.1571629429-py2.py3-none-any.whl | Python 3, Python 2 | none | any | Details |
Total release size: 37.5 kB
Release files / schemainspect-0.1.1571629429.tar.gz
| Download URL | schemainspect-0.1.1571629429.tar.gz |
|---|---|
| Size | 16.2 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
a1bccf3bd4d91d9d895c024952bb47bda0a42c5421d369d2ce8258474ca08c5e
|
|
BLAKE2b-256 checksum How to use checksums |
d4d8b457cbb8d5275a8fe1281baa4cf9941add32acad4cd485593170207cf631
|
| 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-1043-aws
|
Release files / schemainspect-0.1.1571629429-py2.py3-none-any.whl
| Download URL | schemainspect-0.1.1571629429-py2.py3-none-any.whl |
|---|---|
| Size | 21.4 kB |
| Tags | Python 2 Python 3 |
|
SHA-256 checksum How to use checksums |
4c285ad1f3e239a10419e8efa5a42113748dd00711ed6cdd17d75654c7778dc3
|
|
BLAKE2b-256 checksum How to use checksums |
478543289e08f131e9b83ec1cf61d9ccb8b8a9871a32af92dc3a8f2eafd8591f
|
| 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-1043-aws
|
