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

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

Built distribution (wheel)

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

Total release size: 26.5 kB

Release files / schemainspect-0.1.1509328651.tar.gz

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

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

Download URL schemainspect-0.1.1509328651-py2.py3-none-any.whl
Size 16.4 kB
Tags Python 2 Python 3
SHA-256 checksum
How to use checksums
30fa0812b389b77d93fb665fa200ecf5885504affe6c6fd486d722465c8ba563
BLAKE2b-256 checksum
How to use checksums
335b418076b6c461ca61d3e96cacbc61265af5d338b383130b8882734e66a1c0
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Release history Release notifications | RSS feed

This release

0.1.1509328651 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