Skip to main content

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!

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

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.1502453174
File Size Uploaded
schemainspect-0.1.1502453174.tar.gz 9.9 kB Details

Built distribution (wheel)

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

Total release size: 26.2 kB

Release files / schemainspect-0.1.1502453174.tar.gz

Download URL schemainspect-0.1.1502453174.tar.gz
Size 9.9 kB
Tags Source
SHA-256 checksum
How to use checksums
617a150c6c819bd2548eb533e8393933b08b003ace22ca72774c0e9fbf1da9c4
BLAKE2b-256 checksum
How to use checksums
6b2283ed11056e53c229dd1c0331d40e926e9899bb1fe24680326d5ed4282359
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

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

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

Release history Release notifications | RSS feed

This release

0.1.1502453174 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