Skip to main content

schemainspect: SQL Schema Inspection

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

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.1500870460
File Size Uploaded
schemainspect-0.1.1500870460.tar.gz 9.8 kB Details

Built distribution (wheel)

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

Total release size: 26.0 kB

Release files / schemainspect-0.1.1500870460.tar.gz

Download URL schemainspect-0.1.1500870460.tar.gz
Size 9.8 kB
Tags Source
SHA-256 checksum
How to use checksums
d3db9331dd7050a0ad4bd284123e95325584ed9a0d84311003b624e21a4b3285
BLAKE2b-256 checksum
How to use checksums
0c7f32485ffebb1bdc056f6504ce852633e06fd4bf93a97540c62c7cb16aca30
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

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

Download URL schemainspect-0.1.1500870460-py2.py3-none-any.whl
Size 16.2 kB
Tags Python 2 Python 3
SHA-256 checksum
How to use checksums
f1e108a3ac4d7b1b2e5d7fb7acf515ab659c84eed117bec0e53f787ad4819f04
BLAKE2b-256 checksum
How to use checksums
0c6afd400cdcc19565547e7d56f4ff7ecd558264c02d9cabff23ff45510fab10
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Release history Release notifications | RSS feed

This release

0.1.1500870460 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