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 links

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Newer release available (3.1.1663587362)

1 maintainer

PyPI data
Data sourced directly from PyPI's database.
Avatar for djrobstep from gravatar.com djrobstep

Credits

Author: Robert Lechte

Classifiers

Report project as malware

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

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

schemainspect-0.1.1533117668-py2.py3-none-any.whl (16.4 kB view details)

Uploaded Python 2Python 3

File details

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

File metadata

  • Download URL: schemainspect-0.1.1533117668.tar.gz
  • Upload date:
  • Size: 11.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.11.0 pkginfo/1.4.2 requests/2.19.1 setuptools/40.0.0 requests-toolbelt/0.8.0 tqdm/4.23.4 CPython/3.7.0

File hashes

Hashes for schemainspect-0.1.1533117668.tar.gz
Algorithm Hash digest
SHA256 b52301842debe5d36c992b86a23d94728341417dab8cf621ab8ad940f3a88c71
MD5 f307a5725b87e14279a5bd2a7fd9748c
BLAKE2b-256 9591e90bfdc066e7315ad560ed5ea8c502d669daed4c23590b9a43cd29ac7c68

See more details on using hashes here.

File details

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

File metadata

  • Download URL: schemainspect-0.1.1533117668-py2.py3-none-any.whl
  • Upload date:
  • Size: 16.4 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.11.0 pkginfo/1.4.2 requests/2.19.1 setuptools/40.0.0 requests-toolbelt/0.8.0 tqdm/4.23.4 CPython/3.7.0

File hashes

Hashes for schemainspect-0.1.1533117668-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 c43a60b796d8628a6cfc823de0b842b206ccc50fa5ec0239402b59232b76bd4d
MD5 7039d95e9fb603e6729f16245f83788d
BLAKE2b-256 0f8e9ad7d6ecf46b48766848f6d6c8cc71f2d2c594ae814b4ca8876c3587260d

See more details on using hashes here.

Release history Release notifications | RSS feed

3.1.1663587362

2 files

3.1.1663497159

2 files

3.1.1663485973

2 files

3.1.1663481360

2 files

3.1.1663480743

2 files

3.1.1663062229

2 files

3.1.1658648837

2 files

3.1.1652015119

2 files

3.1.1651924499

2 files

3.1.1651924172

2 files

3.1.1651839513

2 files

3.1.1648463413

2 files

3.1.1648462274

2 files

3.1.1647609922

2 files

3.1.1647608289

2 files

3.1.1647147918

2 files

3.0.1616029793

2 files

3.0.1611806281

2 files

2.0.1611793281

2 files

0.1.1611724890

2 files

0.1.1610933302

2 files

0.1.1610498640

2 files

0.1.1607225519

2 files

0.1.1607224896

2 files

0.1.1603448192

2 files

0.1.1603009162

2 files

0.1.1602274168

2 files

0.1.1601964119

2 files

0.1.1601518481

2 files

0.1.1601350901

2 files

0.1.1600993299

2 files

0.1.1599464781

2 files

0.1.1599463750

2 files

0.1.1599463524

2 files

0.1.1599450586

2 files

0.1.1599449889

2 files

0.1.1599449022

2 files

0.1.1599448365

2 files

0.1.1597727684

2 files

0.1.1596263228

2 files

0.1.1595673757

2 files

0.1.1595570852

2 files

0.1.1595243889

2 files

0.1.1593605722

2 files

0.1.1593565676

2 files

0.1.1593518991

2 files

0.1.1592300770

2 files

0.1.1592273867

2 files

0.1.1591162156

2 files

0.1.1588915531

2 files

0.1.1587214651

2 files

0.1.1587211753

2 files

0.1.1586428725

2 files

0.1.1585871494

2 files

0.1.1576717677

2 files

0.1.1576714717

2 files

0.1.1576671221

2 files

0.1.1576671014

2 files

0.1.1576670260

2 files

0.1.1576669988

2 files

0.1.1575949847

2 files

0.1.1571629429

2 files

0.1.1556103540

2 files

0.1.1553852578

2 files

0.1.1553817909

2 files

0.1.1552220105

2 files

0.1.1552209928

2 files

0.1.1551953719

2 files

0.1.1551695490

2 files

0.1.1548143332

2 files

0.1.1547903959

2 files

0.1.1547549341

2 files

0.1.1547547637

2 files

0.1.1544328901

2 files

0.1.1543708870

2 files

0.1.1543655873

2 files

0.1.1543633065

2 files

0.1.1542708492

2 files

0.1.1542622403

2 files

0.1.1542097438

2 files

0.1.1542089233

2 files

0.1.1541069836

2 files

0.1.1540897086

2 files

0.1.1540724771

2 files

0.1.1535502343

2 files

0.1.1533120907

2 files

This release

0.1.1533117668 This release

2 files

0.1.1532255552

2 files

0.1.1530867186

2 files

0.1.1525395046

2 files

0.1.1525394090

2 files

0.1.1521505759

2 files

0.1.1521373866

2 files

0.1.1519171230

2 files

0.1.1509328651

2 files

0.1.1503198422

2 files

0.1.1502453174

2 files

0.1.1500870460

2 files

0.1.1495522896

2 files

0.1.1494928171

2 files

0.1.1488410765

2 files

0.1.1488167750

2 files

0.1.1486292158

2 files

0.1.1472341830

2 files

0.1.1470831013

2 files

0.1.1470583264

2 files

0.1.1469700903

2 files

0.1.1469409161

2 files

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page