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!

Author Credits

### Initial development, maintenance

### Contributions

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

Uploaded Source

Built Distribution

schemainspect-0.1.1525394090-py2.py3-none-any.whl (15.7 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

File hashes

Hashes for schemainspect-0.1.1525394090.tar.gz
Algorithm Hash digest
SHA256 bfce2c21a376d36848b30e08bbe8d0129d698a3b71fe64596fe7e08c97264da9
MD5 f14f71971ad66d09d6d630191029abba
BLAKE2b-256 95d0243e012adb7da0426eaa571d426ce54287093c432955f08d86a1d70a9d64

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for schemainspect-0.1.1525394090-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 54569f6882454c0f211d18b101258954987e9c5cefc25f59ffa02860656b43c2
MD5 65a7f1494ac9c2c3264e2e684fbd692a
BLAKE2b-256 0dfd4a007c0c66c8270b9f4ede23de01cd16e652fbe6903b0a90a34e36681cd3

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