Skip to main content

Schema inspection for PostgreSQL (and potentially others in the future).

Inspects tables, views, materialized views, constraints, indexes, sequences, 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 things it tracks. At each of these attributes you’ll find a dictionary (OrderedDict) mapping from fully-qualified-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.1469700903

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.1469700903
File Size Uploaded
schemainspect-0.1.1469700903.tar.gz 8.0 kB Details

Built distribution (wheel)

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

Total release size: 21.0 kB

Release files / schemainspect-0.1.1469700903.tar.gz

Download URL schemainspect-0.1.1469700903.tar.gz
Size 8.0 kB
Tags Source
SHA-256 checksum
How to use checksums
13f327252fd29fb82ada686c994e58fadba25af988b1067432c0fddd4fc14957
BLAKE2b-256 checksum
How to use checksums
018e059b72fac1380c123d94e0b580ad1a408379c191158595867967ed79a7d4
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

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

Download URL schemainspect-0.1.1469700903-py2.py3-none-any.whl
Size 13.0 kB
Tags Python 2 Python 3
SHA-256 checksum
How to use checksums
a4a86e9ce6b45d5ab04095c490e96e8e53415589e418b515ef322fea2fd02d75
BLAKE2b-256 checksum
How to use checksums
228dac0d68c8696de3503adacc10c90b8a443714255e4a2ffc269ce1e27d91b2
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Release history Release notifications | RSS feed

This release

0.1.1469700903 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