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 schemainspect
To install psycopg2 (the PostgreSQL driver) at the same time as well:
$ pip install schemainspect[pg]
Metadata
Release files for schemainspect 0.1.1521505759
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.1521505759.tar.gz | 11.2 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| schemainspect-0.1.1521505759-py2.py3-none-any.whl | Python 3, Python 2 | none | any | Details |
Total release size: 28.4 kB
Release files / schemainspect-0.1.1521505759.tar.gz
| Download URL | schemainspect-0.1.1521505759.tar.gz |
|---|---|
| Size | 11.2 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
7fca4c8fd67faea99240637fd7db033556b7e029575b53b0134c03b2c0cd4095
|
|
BLAKE2b-256 checksum How to use checksums |
1f93ba7ae9ff54e120b76e4712c0f698c9d2284c346178ce762c6f27a43b7ceb
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
Release files / schemainspect-0.1.1521505759-py2.py3-none-any.whl
| Download URL | schemainspect-0.1.1521505759-py2.py3-none-any.whl |
|---|---|
| Size | 17.2 kB |
| Tags | Python 2 Python 3 |
|
SHA-256 checksum How to use checksums |
43b54642a42b48f8083b51ad992b4c9f9bb50733692895528af6848d19e0a926
|
|
BLAKE2b-256 checksum How to use checksums |
48bef1896fd8389e05eb5fcb13cb020e54d7323a681cb0c92700eb393d978510
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |