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

Uploaded Source

Built Distribution

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

Uploaded Python 2 Python 3

File details

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

File metadata

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

File hashes

Hashes for schemainspect-0.1.1544328901.tar.gz
Algorithm Hash digest
SHA256 006421221f86b9191616fd3db4385eb025721e5a0dd18857a08e23c4988329ff
MD5 35546ad8cad2e29c940dff8a00f2999d
BLAKE2b-256 089a0cd855506b9caa46f37784ccd0d214d5f76ef5c99492b9f076d7b79cd0a3

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for schemainspect-0.1.1544328901-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 9beb31424439836b637c9aec07a9427ba64d4995c154359d99e9cee15291d3fa
MD5 4a2be9435af42d39b9132a2e5486929b
BLAKE2b-256 8ba738c97ad0b2e37d2c4492a7d542ccfebf15e25658995524c7eeb1c89c2644

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