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!

Author Credits

Initial development, maintenance

Contributions

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

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.1525395046
File Size Uploaded
schemainspect-0.1.1525395046.tar.gz 11.4 kB Details

Built distribution (wheel)

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

Total release size: 27.1 kB

Release files / schemainspect-0.1.1525395046.tar.gz

Download URL schemainspect-0.1.1525395046.tar.gz
Size 11.4 kB
Tags Source
SHA-256 checksum
How to use checksums
0ea0b536a92270701592a330e2ff79567e67de39494a0f9cf71acc73f8cf7aab
BLAKE2b-256 checksum
How to use checksums
711970c9159aa3cb7c3a4d88a37ca0b8e6582f2a33267a9de700f3bdb9e783e9
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

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

Download URL schemainspect-0.1.1525395046-py2.py3-none-any.whl
Size 15.7 kB
Tags Python 2 Python 3
SHA-256 checksum
How to use checksums
d6c5acfb17efc123025ed2e923d2dc19c2c59ee3d604890ce97198d3f4dac17f
BLAKE2b-256 checksum
How to use checksums
4b6c3b6b9cdd98f2a86b6ed6a378020ef5ec98191ae42ed1a4efce9360b085bd
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Release history Release notifications | RSS feed

This release

0.1.1525395046 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