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!

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.1472341830

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.1472341830
File Size Uploaded
schemainspect-0.1.1472341830.tar.gz 9.1 kB Details

Built distribution (wheel)

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

Total release size: 23.8 kB

Release files / schemainspect-0.1.1472341830.tar.gz

Download URL schemainspect-0.1.1472341830.tar.gz
Size 9.1 kB
Tags Source
SHA-256 checksum
How to use checksums
69b1b884dd2c0660d317279a2f48390fc03d2f4fe8f1bc5485cd19a637f628d7
BLAKE2b-256 checksum
How to use checksums
8c15dd8ec32b9e95b535b5950bd8461bd8d51c9fadde812e92bee49862abf5f4
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

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

Download URL schemainspect-0.1.1472341830-py2.py3-none-any.whl
Size 14.6 kB
Tags Python 2 Python 3
SHA-256 checksum
How to use checksums
3ddac7a19076e057afdd5275ba0cdd65c981ffeade8f799c136aebd58f1f9e3f
BLAKE2b-256 checksum
How to use checksums
3e32803d0d03d6faa70edc6d9307f09999f2a4c1ecc20797379a4fe2302b504a
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Release history Release notifications | RSS feed

This release

0.1.1472341830 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