Skip to main content
Help us improve PyPI by participating in user testing. All experience levels needed!

Schema inspection for PostgreSQL

Project description

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 details


Release history Release notifications

This version
History Node

0.1.1525395046

History Node

0.1.1525394090

History Node

0.1.1521505759

History Node

0.1.1521373866

History Node

0.1.1519171230

History Node

0.1.1509328651

History Node

0.1.1503198422

History Node

0.1.1502453174

History Node

0.1.1500870460

History Node

0.1.1495522896

History Node

0.1.1494928171

History Node

0.1.1488410765

History Node

0.1.1488167750

History Node

0.1.1486292158

History Node

0.1.1472341830

History Node

0.1.1470831013

History Node

0.1.1470583264

History Node

0.1.1469700903

History Node

0.1.1469409161

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
schemainspect-0.1.1525395046-py2.py3-none-any.whl (15.7 kB) Copy SHA256 hash SHA256 Wheel py2.py3 May 4, 2018
schemainspect-0.1.1525395046.tar.gz (11.4 kB) Copy SHA256 hash SHA256 Source None May 4, 2018

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging CloudAMQP CloudAMQP RabbitMQ AWS AWS Cloud computing Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page