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!

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

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.1535502343
File Size Uploaded
schemainspect-0.1.1535502343.tar.gz 11.9 kB Details

Built distribution (wheel)

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

Total release size: 28.3 kB

Release files / schemainspect-0.1.1535502343.tar.gz

Download URL schemainspect-0.1.1535502343.tar.gz
Size 11.9 kB
Tags Source
SHA-256 checksum
How to use checksums
8efba7f4d1f1984518588c4c3e50879199a0823e14d0d141b03f3104e38cd3bd
BLAKE2b-256 checksum
How to use checksums
77bc7d29b954e047f99d4280e98c754ec55d46547ab7d00c92eee8273d7a16c6
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/1.11.0 pkginfo/1.4.2 requests/2.19.1 setuptools/40.2.0 requests-toolbelt/0.8.0 tqdm/4.25.0 CPython/3.7.0

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

Download URL schemainspect-0.1.1535502343-py2.py3-none-any.whl
Size 16.5 kB
Tags Python 2 Python 3
SHA-256 checksum
How to use checksums
72aaf458b9b251e8ad7f97fec26d9e2bfdfaa3fb249416ee301821276bbfe9ab
BLAKE2b-256 checksum
How to use checksums
11565cba4bb6a1c73ab44b2e1c5b9724f411589fb27a9330e26e52e5e2e258bf
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/1.11.0 pkginfo/1.4.2 requests/2.19.1 setuptools/40.2.0 requests-toolbelt/0.8.0 tqdm/4.25.0 CPython/3.7.0

Release history Release notifications | RSS feed

This release

0.1.1535502343 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