Skip to main content

Schema inspection for PostgreSQL

Project description

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]

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

schemainspect-0.1.1470583264.tar.gz (9.1 kB view details)

Uploaded Source

Built Distribution

schemainspect-0.1.1470583264-py2.py3-none-any.whl (14.6 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file schemainspect-0.1.1470583264.tar.gz.

File metadata

File hashes

Hashes for schemainspect-0.1.1470583264.tar.gz
Algorithm Hash digest
SHA256 42c94b5208d81ca1189134cd9ebab5f3c81818c221032c8e53a71a6ffb0177ef
MD5 9f782b3f9b9f4a523de11920ce46ffd1
BLAKE2b-256 f982ea91764ee3d89b915c9cd76f4e8cc3e3bd40ff66f0735b4b19d2ca276ee5

See more details on using hashes here.

File details

Details for the file schemainspect-0.1.1470583264-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for schemainspect-0.1.1470583264-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 224bacc8ed522fdd528ed7f61c0bf6b58317932c184139ebd5e0027179cdc279
MD5 59f059a2641446bc3b43c81acb51bdd4
BLAKE2b-256 35ac51ab2ba5697e99e47078a082804e3844b11bf915ffb0c32fc3ccd10018e1

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page