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.1495522896.tar.gz (9.6 kB view details)

Uploaded Source

Built Distribution

schemainspect-0.1.1495522896-py2.py3-none-any.whl (15.2 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

File hashes

Hashes for schemainspect-0.1.1495522896.tar.gz
Algorithm Hash digest
SHA256 2659752676759b48196d5dbdd5e0f69d61670a4e056d698c55f8c58605b11755
MD5 149c5f0148c0ff633dfc4e9bb6b5de2b
BLAKE2b-256 f17aaa0f9a870e7a765b7d2c1378682c409b138b3e8aa567079cacdee60d1f95

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for schemainspect-0.1.1495522896-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 3facf3885e99e0b3f0197ef781b36756202a54db9926d86b4822bf0fd68b34e9
MD5 57360efeee4a138de35390a3653d7e3a
BLAKE2b-256 1916c112de849c594b1c8730626d37795bac3248033abfc8297361975c9ad71b

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