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!

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

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.1488410765
File Size Uploaded
schemainspect-0.1.1488410765.tar.gz 9.2 kB Details

Built distribution (wheel)

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

Total release size: 24.0 kB

Release files / schemainspect-0.1.1488410765.tar.gz

Download URL schemainspect-0.1.1488410765.tar.gz
Size 9.2 kB
Tags Source
SHA-256 checksum
How to use checksums
b19236bc3d30b0d9c93d645f643bc06e7926630907c8ad9d809f307e41e30ef5
BLAKE2b-256 checksum
How to use checksums
d7b812ee42b3470c7fa37f75d5ce6a81a5b12b0c7ee9af9985ac2d02d5da6bf9
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

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

Download URL schemainspect-0.1.1488410765-py2.py3-none-any.whl
Size 14.7 kB
Tags Python 2 Python 3
SHA-256 checksum
How to use checksums
573fa8e8e4bf4c0ea23a117ae296e2bf0d4403b45aca9369657f2192ffd4e735
BLAKE2b-256 checksum
How to use checksums
8114379449df96abe7bdbe2c6a83146efa0966b762873dd37f67820f02352232
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Release history Release notifications | RSS feed

This release

0.1.1488410765 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