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. Handles table partitioning and inheritance.

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 schemahq-schemainspect 1.0.12

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

Source distribution (sdist)

Source distribution for schemahq-schemainspect 1.0.12
File Size Uploaded Provenance Actions
schemahq-schemainspect-1.0.12.tar.gz 21.5 kB Without provenance Details for schemahq-schemainspect-1.0.12.tar.gz

Built distribution (wheel)

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

Total release size: 51.8 kB

Release files / schemahq-schemainspect-1.0.12.tar.gz

Download URL schemahq-schemainspect-1.0.12.tar.gz
Size 21.5 kB
Tags Source
SHA-256 checksum
How to use checksums
6d1389d009cda39cf4deb352233fe117e87734de75a80b9590e6360808534381
BLAKE2b-256 checksum
How to use checksums
89c7bb8ec009eb70484e72dcaaef6f66a55d6666254928d1b5d58e024630014b
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/1.0.5 CPython/3.8.3 Linux/5.3.0-1020-azure

Release files / schemahq_schemainspect-1.0.12-py2.py3-none-any.whl

Download URL schemahq_schemainspect-1.0.12-py2.py3-none-any.whl
Size 30.3 kB
Tags Python 2 Python 3
SHA-256 checksum
How to use checksums
50a422998a4d7270dcac65d405dd71caa5946b5d23e194972405f8aa99a56641
BLAKE2b-256 checksum
How to use checksums
8926272ddf4dae82c98ddb939b43bf5f8e932db4014b152c82f1f97ce0bbca39
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/1.0.5 CPython/3.8.3 Linux/5.3.0-1020-azure

Security for schemahq-schemainspect 1.0.12

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

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