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

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.1495522896
File Size Uploaded
schemainspect-0.1.1495522896.tar.gz 9.6 kB Details

Built distribution (wheel)

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

Total release size: 24.8 kB

Release files / schemainspect-0.1.1495522896.tar.gz

Download URL schemainspect-0.1.1495522896.tar.gz
Size 9.6 kB
Tags Source
SHA-256 checksum
How to use checksums
2659752676759b48196d5dbdd5e0f69d61670a4e056d698c55f8c58605b11755
BLAKE2b-256 checksum
How to use checksums
f17aaa0f9a870e7a765b7d2c1378682c409b138b3e8aa567079cacdee60d1f95
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

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

Download URL schemainspect-0.1.1495522896-py2.py3-none-any.whl
Size 15.2 kB
Tags Python 2 Python 3
SHA-256 checksum
How to use checksums
3facf3885e99e0b3f0197ef781b36756202a54db9926d86b4822bf0fd68b34e9
BLAKE2b-256 checksum
How to use checksums
1916c112de849c594b1c8730626d37795bac3248033abfc8297361975c9ad71b
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Release history Release notifications | RSS feed

This release

0.1.1495522896 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