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

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

Built distribution (wheel)

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

Total release size: 28.2 kB

Release files / schemainspect-0.1.1530867186.tar.gz

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

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

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

Release history Release notifications | RSS feed

This release

0.1.1530867186 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