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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: schemainspect-3.1.1663485973.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.1663485973.tar.gz
Algorithm Hash digest
SHA256 b532ab327408ebf3beab78d8972a741b14421fae173bc44cc4fc66d8b3669630
MD5 40f57c42d4cbfeef3bbecd6991a66ff9
BLAKE2b-256 fb7e96353601098f129b3d6359cbc2b81d1bfead3f17a0be93e1e0ec6a51728b

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for schemainspect-3.1.1663485973-py3-none-any.whl
Algorithm Hash digest
SHA256 a7707a63972116c6e08f8c64c726f5ffb579579f257f53876de8176aba618dc5
MD5 659d0392acfe9966d3b898c4fe9a0d07
BLAKE2b-256 bfebf3bdd2851270e06d9d620e524b321faa069de634b8f0595ed4320eaa096b

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