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

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.1519171230
File Size Uploaded
schemainspect-0.1.1519171230.tar.gz 11.1 kB Details

Built distribution (wheel)

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

Total release size: 28.2 kB

Release files / schemainspect-0.1.1519171230.tar.gz

Download URL schemainspect-0.1.1519171230.tar.gz
Size 11.1 kB
Tags Source
SHA-256 checksum
How to use checksums
4027634615345820b44062dc27925a1d8ef12be996462b64ad7eaf16785c15cb
BLAKE2b-256 checksum
How to use checksums
7fdfedf654bdce0a27aae209c332b3d6a8b6af9e0d9a5ae65fc8b16b02668ce4
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

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

Download URL schemainspect-0.1.1519171230-py2.py3-none-any.whl
Size 17.1 kB
Tags Python 2 Python 3
SHA-256 checksum
How to use checksums
64ff865e51d031e0b87b3ef3b22be33033ae1c6661accd6cb549083b7558c600
BLAKE2b-256 checksum
How to use checksums
1858735dfd81a7dda0b1a5fb0262efa5fc7552ff40fcc2220e665bf5e74a6162
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Release history Release notifications | RSS feed

This release

0.1.1519171230 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