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!

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

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.1532255552
File Size Uploaded
schemainspect-0.1.1532255552.tar.gz 11.8 kB Details

Built distribution (wheel)

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

Total release size: 28.2 kB

Release files / schemainspect-0.1.1532255552.tar.gz

Download URL schemainspect-0.1.1532255552.tar.gz
Size 11.8 kB
Tags Source
SHA-256 checksum
How to use checksums
dda3f694cca6c360ad6b401c62e8e8cec760b441342382585d24ecfef741b24f
BLAKE2b-256 checksum
How to use checksums
58f7e58ec857a55fa2468c01e150db6b4cd37139ca051ac8e9d005546e594cfd
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

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

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

Release history Release notifications | RSS feed

This release

0.1.1532255552 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