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.

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

Uploaded Source

Built Distribution

schemainspect-0.1.1547547637-py2.py3-none-any.whl (62.4 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

  • Download URL: schemainspect-0.1.1547547637.tar.gz
  • Upload date:
  • Size: 15.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/0.12.11 CPython/3.7.0 Linux/4.4.0-141-generic

File hashes

Hashes for schemainspect-0.1.1547547637.tar.gz
Algorithm Hash digest
SHA256 31529e635fd82544c47f4f04f12e1b8a6e4c83a652bac55741b02f59cf8df44e
MD5 5febca83a69c77c3e1024268cb399323
BLAKE2b-256 77f83475d0d4a0bdca686d4dd73c644484161e573a6b1ff2628a3e2ca906c29c

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for schemainspect-0.1.1547547637-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 d9db6ac98dbcfcab627d43dc0a6e80c3e397fb5a2f815c896e40ada7a8cb1138
MD5 5bd80a1f50b91e4bb6da09318fa04cc2
BLAKE2b-256 5f76131b94c0104e693f929513ea6e8525aa225c9ec3faade68fed47918c7064

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