Metadata-Version: 2.1
Name: pg-analyse
Version: 0.1.0
Summary: Tools to gather useful information from PostgreSQL
Home-page: https://github.com/idlesign/pg_analyse
Author: Igor `idle sign` Starikov
Author-email: idlesign@yandex.ru
License: BSD 3-Clause License
Description: pg_analyse
        ==========
        https://github.com/idlesign/pg_analyse
        
        |release| |lic| |ci| |coverage|
        
        .. |release| image:: https://img.shields.io/pypi/v/pg_analyse.svg
            :target: https://pypi.python.org/pypi/pg_analyse
        
        .. |lic| image:: https://img.shields.io/pypi/l/pg_analyse.svg
            :target: https://pypi.python.org/pypi/pg_analyse
        
        .. |ci| image:: https://img.shields.io/travis/idlesign/pg_analyse/master.svg
            :target: https://travis-ci.org/idlesign/pg_analyse
        
        .. |coverage| image:: https://img.shields.io/coveralls/idlesign/pg_analyse/master.svg
            :target: https://coveralls.io/r/idlesign/pg_analyse
        
        
        Description
        -----------
        
        *Tools to gather useful information from PostgreSQL*
        
        This package can function both as Python module and as a command line utility.
        Command line interface can show gathered information in the form of tables or ``JSON``.
        
        Use it to gather information manually or in Continuous Integration.
        
        Can give you some information on:
        
        * Index health (bloat, duplicates, unused, etc.);
        * Tables missing PKs and indexes.
        
        
        .. note:: SQLs used for inspections are available in https://github.com/mfvanek/pg-index-health-sql
        
        
        Requirements
        ------------
        
        * Python 3.6+
        
        
        Installation
        ------------
        
        .. code-block:: bash
        
            ; If you want to use it just as Python module:
            $ pip install pg_analyse
        
            ; If you want to use it from command line:
            $ pip install pg_analyse[cli]
        
        
        Usage
        -----
        
        Hint
        ~~~~
        
        One can set ``PG_ANALYSE_DSN`` environment variable instead of explicitly passing DSN
        to connect to PostgreSQL. If `envbox <https://pypi.org/project/envbox/>`_ is installed this
        variable can be defined in ``.env`` file .
        
        Python module
        ~~~~~~~~~~~~~
        
        
        .. code-block:: python
        
            from pg_analyse.toolbox import Analyser
        
            analyser = Analyser(dsn='user=test')
        
            inspections = analyser.run()
            inspection = inspections[0]
        
            print(inspection.alias)
            print(inspection.result)
        
        
        CLI
        ~~~
        
        .. code-block:: bash
        
            ; Show known inspections and descriptions:
            $ pg_analyse inspections
        
            ; Use DSN from the environment variable (see hint above),
            ; print out human values (e.g. sizes) in human-friendly way:
            $ pg_analyse run --human
        
            ; Run certain inspections:
            $ pg_analyse run --one idx_unused --one idx_nulls
        
            ; Use explicitly passed DSN:
            $ pg_analyse run --dsn "host=myhost.net port=6432 user=test password=xxx sslmode=verify-full sslrootcert=/home/my.pem"
        
            ; Output analysis result as json (instead of tables):
            $ pg_analyse run --fmt json
        
        
        Adding Inspection
        -----------------
        
        To add a new inspection to ``pg_analyse``:
        
        1. Compose SQL for inspection and put it into a file under ``sql/`` directory.
        2. Add a subclass of ``Inspection`` into ``inspections/bundled.py``. Fill in ``alias``, ``sql_name`` attributes (see docstrings in ``Inspection``).
        
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: License :: OSI Approved :: BSD License
Requires-Python: >=3.6
Provides-Extra: cli
