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

Uploaded Source

Built Distribution

schemainspect-0.1.1591162156-py2.py3-none-any.whl (27.1 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

  • Download URL: schemainspect-0.1.1591162156.tar.gz
  • Upload date:
  • Size: 19.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.0.5 CPython/3.8.2 Linux/5.3.0-1019-aws

File hashes

Hashes for schemainspect-0.1.1591162156.tar.gz
Algorithm Hash digest
SHA256 81c8b1e6b5dacc81fb7107e4369fd11f4fa48ecbd1200b82083ab980c592b772
MD5 046023327d95fb0929b6a8bb052d01e7
BLAKE2b-256 8168a27a5cb7b66598ac38d79ddb1db28649fd55b085c8e4b6cf6ccd849d83f4

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for schemainspect-0.1.1591162156-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 ac9a05fd0d9a9bc0cb3024973efd0cac92c6a880ac2d4fbd5c49c54404b337db
MD5 1fea97493ed77d0859b6712fd453c7e4
BLAKE2b-256 00b13b6c1a6540c0cfa47acef357caaee3d15b17aa7d0b9d70be4b14690ebc59

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