Skip to main content

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]

Metadata

Release files for schemainspect 0.1.1525394090

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for schemainspect 0.1.1525394090
File Size Uploaded
schemainspect-0.1.1525394090.tar.gz 11.4 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for schemainspect 0.1.1525394090
File Interpreter ABI Platform
schemainspect-0.1.1525394090-py2.py3-none-any.whl Python 3, Python 2 none any Details

Total release size: 27.1 kB

Release files / schemainspect-0.1.1525394090.tar.gz

Download URL schemainspect-0.1.1525394090.tar.gz
Size 11.4 kB
Tags Source
SHA-256 checksum
How to use checksums
bfce2c21a376d36848b30e08bbe8d0129d698a3b71fe64596fe7e08c97264da9
BLAKE2b-256 checksum
How to use checksums
95d0243e012adb7da0426eaa571d426ce54287093c432955f08d86a1d70a9d64
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Release files / schemainspect-0.1.1525394090-py2.py3-none-any.whl

Download URL schemainspect-0.1.1525394090-py2.py3-none-any.whl
Size 15.7 kB
Tags Python 2 Python 3
SHA-256 checksum
How to use checksums
54569f6882454c0f211d18b101258954987e9c5cefc25f59ffa02860656b43c2
BLAKE2b-256 checksum
How to use checksums
0dfd4a007c0c66c8270b9f4ede23de01cd16e652fbe6903b0a90a34e36681cd3
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Release history Release notifications | RSS feed

This release

0.1.1525394090 This release

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page