Skip to main content

Schema inspection for PostgreSQL (and possibly others)

Project description

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!

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

Uploaded Source

Built Distribution

schemainspect-0.1.1542708492-py2.py3-none-any.whl (57.9 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

  • Download URL: schemainspect-0.1.1542708492.tar.gz
  • Upload date:
  • Size: 14.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/0.12.9 CPython/3.7.0 Linux/4.4.0-139-generic

File hashes

Hashes for schemainspect-0.1.1542708492.tar.gz
Algorithm Hash digest
SHA256 ec0cd2117dd59a658e58bd28433a0f035357c505378725799ced79ad3e823861
MD5 4dc0721a067124484808be3e03201027
BLAKE2b-256 ce2c29f6a940a80c4ebc7ec9372a5c28e4b8d9675175d9add9463dcee9830b7a

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for schemainspect-0.1.1542708492-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 78a0ae81c58b404e8813c6937351fac5eb0f55f62bd8c290bd8c1e2ed8ed6c8c
MD5 0683c3abc663f6dd43af8ba9fab66ad4
BLAKE2b-256 d1c4455fd98a7e8636331c717674140f59254209cb7b9334d3e8cfe2a23ed713

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