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

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.1503198422
File Size Uploaded
schemainspect-0.1.1503198422.tar.gz 10.1 kB Details

Built distribution (wheel)

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

Total release size: 26.5 kB

Release files / schemainspect-0.1.1503198422.tar.gz

Download URL schemainspect-0.1.1503198422.tar.gz
Size 10.1 kB
Tags Source
SHA-256 checksum
How to use checksums
e937266e369c3d93134f1896563771efe3ca45d626f512ce98d4198aa6441af5
BLAKE2b-256 checksum
How to use checksums
1ed183aed04bd75e48ba7bf3a1a984200ade9af12411e6465cfcee7db52214a5
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

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

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

Release history Release notifications | RSS feed

This release

0.1.1503198422 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