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

Uploaded Source

Built Distribution

schemainspect-3.1.1652015119-py3-none-any.whl (37.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: schemainspect-3.1.1652015119.tar.gz
  • Upload date:
  • Size: 28.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.13 CPython/3.10.4 Linux/5.13.0-1021-aws

File hashes

Hashes for schemainspect-3.1.1652015119.tar.gz
Algorithm Hash digest
SHA256 7eb05190b52e1520c1ea573abc39eac47752b647708b6d7dfc350345737e44a1
MD5 b928c2aec53fefc43de7b21af30f12b1
BLAKE2b-256 a7dbb6080cfeda0e6e88fe5cf9f9ef77a9bad68e68121416bc0ec385557df171

See more details on using hashes here.

File details

Details for the file schemainspect-3.1.1652015119-py3-none-any.whl.

File metadata

File hashes

Hashes for schemainspect-3.1.1652015119-py3-none-any.whl
Algorithm Hash digest
SHA256 b98cf19f76a8e5110c2a81f74bf72e7ae52697895f5910f40c0cd1d64cb7c445
MD5 b5c3b69529ec5aec3bfedff638650318
BLAKE2b-256 8215225ca6ecb11258f80944eb75c03d7009a7bda7d366d06946437ecc3137a2

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