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

Uploaded Source

Built Distribution

schemainspect-3.1.1651924499-py3-none-any.whl (36.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: schemainspect-3.1.1651924499.tar.gz
  • Upload date:
  • Size: 28.1 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.1651924499.tar.gz
Algorithm Hash digest
SHA256 6583bc7c5355889b2d4bbe9a479afd12bbaf869c4a9e4ab8324ef2c315e9e6da
MD5 c54c6546d0715f48c395d27c5444d49d
BLAKE2b-256 a06cc23252d57446415a85806cdf0b35a79e9a3409074087005f9a6a08ed5dfd

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for schemainspect-3.1.1651924499-py3-none-any.whl
Algorithm Hash digest
SHA256 74abca36541e9817b9f893e2d9bdf75e41cae068e7c4acb9dbca638f306ee2fd
MD5 0e4679de1406d523ad5a3962d34b3c28
BLAKE2b-256 547e4fe4f0af7d33e34324b4bf2266bbfa8949ed40df7017f8aa1f9705400434

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