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

Uploaded Source

Built Distribution

schemainspect-0.1.1509328651-py2.py3-none-any.whl (16.4 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

File hashes

Hashes for schemainspect-0.1.1509328651.tar.gz
Algorithm Hash digest
SHA256 42a38d51f56325b821751df3e21c109685e398aeb319ee58bf513b650cb116e0
MD5 8985f18dff5cd9f1bbcece3a3ec2bb53
BLAKE2b-256 ed672efc2b228e07297a29bdb71a8521fcae53ad5e701417bcb39188ef8bf26a

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for schemainspect-0.1.1509328651-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 30fa0812b389b77d93fb665fa200ecf5885504affe6c6fd486d722465c8ba563
MD5 87b93bd4efd4ece9e04ffb3cadead36e
BLAKE2b-256 335b418076b6c461ca61d3e96cacbc61265af5d338b383130b8882734e66a1c0

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