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. Handles table partitioning and inheritance.

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

Uploaded Source

Built Distribution

schemainspect-0.1.1603009162-py2.py3-none-any.whl (35.0 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

  • Download URL: schemainspect-0.1.1603009162.tar.gz
  • Upload date:
  • Size: 26.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.0.5 CPython/3.8.2 Linux/4.15.0-1077-aws

File hashes

Hashes for schemainspect-0.1.1603009162.tar.gz
Algorithm Hash digest
SHA256 c89dd29826e0d5e8879465064d8a7fabb06309c4b541f9368b00ef2b46b4c90a
MD5 2a8f07be0eb3f1e21c29b6dde7da8d1d
BLAKE2b-256 cdcf65164cbb60907f7e7f3120deafc3d2415ea002de3c2cdb6431c33a3f4fde

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for schemainspect-0.1.1603009162-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 31e9fc90f9cec0b986c9c6face28bdf332a294c1f64743bd4a86cf10908c95be
MD5 00540ca5f9126e191f5422b462ea9f87
BLAKE2b-256 f048e4d054285f5c9b0d810b35f463a3c557e78043a08e14c43b47da477dadcf

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