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

Uploaded Source

Built Distribution

schemainspect-3.1.1663497159-py3-none-any.whl (37.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: schemainspect-3.1.1663497159.tar.gz
  • Upload date:
  • Size: 28.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.2.0 CPython/3.10.7 Linux/5.13.0-1023-aws

File hashes

Hashes for schemainspect-3.1.1663497159.tar.gz
Algorithm Hash digest
SHA256 24eb827f3782860f14f5b0e558eca9cae56045a4286cf3ded2dd981f7be745f2
MD5 c2b308937d709495742993e393e3de1f
BLAKE2b-256 5929e114af951312cfb48b0fc1b3c9469ab9cc29bedae378e375b8b554840f99

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for schemainspect-3.1.1663497159-py3-none-any.whl
Algorithm Hash digest
SHA256 4c8a28097a798f3f15ddbb930c3efbe565bce345b676c4b76e907a986f77ae1b
MD5 8f3da5422f989dcbce92d9073c41226f
BLAKE2b-256 b17b626233df50089f4e80baf466f7dee27b1f993e0895686cb016e37342d60e

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