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

Uploaded Source

Built Distribution

schemainspect-0.1.1597727684-py2.py3-none-any.whl (30.0 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

  • Download URL: schemainspect-0.1.1597727684.tar.gz
  • Upload date:
  • Size: 21.7 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.1597727684.tar.gz
Algorithm Hash digest
SHA256 8c5c93a43ad58d290a69db9bd447a5c6f6423530ab8bd47ea7bf7611b2735c51
MD5 d77f03c50075a5b7958b83c9966250a0
BLAKE2b-256 53a054c709c3a18a5c7743e075ff173b5f87439b428f793ca44e6a7afd8e7a93

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for schemainspect-0.1.1597727684-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 2754340f70e60e99901746582ab3711e0db7d5900a4c8d5b13bfef16166005f6
MD5 11774f8e59090fbf99b3f98286ca34f9
BLAKE2b-256 f0f9f8fc4f5b471da6462e079dbbe7a75a0f6a650e984e9a0b75ab369e1e5699

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