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

Uploaded Source

Built Distribution

schemainspect-0.1.1602274168-py2.py3-none-any.whl (34.5 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

  • Download URL: schemainspect-0.1.1602274168.tar.gz
  • Upload date:
  • Size: 25.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.1602274168.tar.gz
Algorithm Hash digest
SHA256 92639c44ee1f9bca4b074b12ae914b1770670eee8078ec3f15b9a20783254078
MD5 27865a16199145e9897802f2f2b60981
BLAKE2b-256 f2eb5a5132c9fa97bfed14a8644b6ded819d636630506901b3697d41f347009c

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for schemainspect-0.1.1602274168-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 804ea9d4b14fbb0d09dee8273ddb8551f02a0b21c9ca5376231c36e9d97d9c70
MD5 67a402a3bb7722fb83aca077d526b681
BLAKE2b-256 dca15e157aab4938e6d3eff94e92969e5969ef72699ba38d15492799012336b5

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