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

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.1521373866
File Size Uploaded
schemainspect-0.1.1521373866.tar.gz 10.3 kB Details

Built distribution (wheel)

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

Total release size: 27.5 kB

Release files / schemainspect-0.1.1521373866.tar.gz

Download URL schemainspect-0.1.1521373866.tar.gz
Size 10.3 kB
Tags Source
SHA-256 checksum
How to use checksums
af03b4ae8d9ff0d4f7864e2014f8c32a7f36ff85a8f66d7801479ae9951c8543
BLAKE2b-256 checksum
How to use checksums
936aeca2d5499a6c193191f275af518171532a86cf615dc5a2d887a34a31eb3e
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

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

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

Release history Release notifications | RSS feed

This release

0.1.1521373866 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