Skip to main content

Schema inspection for PostgreSQL

Project description

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

Uploaded Source

Built Distribution

schemainspect-0.1.1533117668-py2.py3-none-any.whl (16.4 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

  • Download URL: schemainspect-0.1.1533117668.tar.gz
  • Upload date:
  • Size: 11.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.11.0 pkginfo/1.4.2 requests/2.19.1 setuptools/40.0.0 requests-toolbelt/0.8.0 tqdm/4.23.4 CPython/3.7.0

File hashes

Hashes for schemainspect-0.1.1533117668.tar.gz
Algorithm Hash digest
SHA256 b52301842debe5d36c992b86a23d94728341417dab8cf621ab8ad940f3a88c71
MD5 f307a5725b87e14279a5bd2a7fd9748c
BLAKE2b-256 9591e90bfdc066e7315ad560ed5ea8c502d669daed4c23590b9a43cd29ac7c68

See more details on using hashes here.

File details

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

File metadata

  • Download URL: schemainspect-0.1.1533117668-py2.py3-none-any.whl
  • Upload date:
  • Size: 16.4 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.11.0 pkginfo/1.4.2 requests/2.19.1 setuptools/40.0.0 requests-toolbelt/0.8.0 tqdm/4.23.4 CPython/3.7.0

File hashes

Hashes for schemainspect-0.1.1533117668-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 c43a60b796d8628a6cfc823de0b842b206ccc50fa5ec0239402b59232b76bd4d
MD5 7039d95e9fb603e6729f16245f83788d
BLAKE2b-256 0f8e9ad7d6ecf46b48766848f6d6c8cc71f2d2c594ae814b4ca8876c3587260d

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