Skip to main content

a simple tool to diff schemas in two postgresql database

Project description

Copyright (c) 2016 hanks

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

Description: |Build Status| |Coverage Status|

pg diff
=======

A simple tool to diff serveral properties of schemas in two postgresql
databases.

Now supported diff options are:

- table\_name
- table\_count
- table\_schema
- row\_count
- table\_size
- index\_size
- ``table_total_size``
- sequence

Why
===

Recently I worked on database migration things, and very need a tool to
analyze the consistency between source and target database. So I make
this tool to some simple comparison, and it looks good to me:)

Prerequisite
============

You need to install ``postgresql`` firstly, because ``pg_diff`` will use
``psycopg2`` to execute some commands.

Installation
============

``pip install pg_diff``

Usage
=====

``pg_diff --type=table_count 'host=source dbname=test user=postgres password=secret port=5432' 'host=target dbname=test user=postgres password=secret port=5432' --verbose``

::

Usage:
pg_diff --type=T_NAME SOURCE_DSN TARGET_DSN [--verbose]
pg_diff -h | --help
pg_diff --version

Arguments:
SOURCE_DSN dsn for source database, like "host=xxx dbname=test user=postgres password=secret port=5432"
TARGET_DSN dsn for target database, like "host=xxx dbname=test user=postgres password=secret port=5432"

Options:
--type=T_NAME Type name to compare in category, valid input likes: table_name, table_count, table_schema, row_count, table size. index size, table_total_size, sequence
-h --help Show help info.
--verbose Show verbose information.
--version Show version.

Implementation
==============

Mainly using libraries below to make this tool:

- docopt==0.6.2
- schema==0.6.5
- deepdiff==2.5.1
- psycopg2==2.6.2

And I use some SQL to query the status of schema, like table size, index
size and etc.

Contribution
============

#. Fork the repository on GitHub.
#. Make a branch off of master and commit your changes to it.
#. Run the tests with ``tox``

- Either use ``tox`` to build against all supported Python versions (if
you have them installed) or use ``tox -e py{version}`` to test
against a specific version, e.g., ``tox -e py27`` or ``tox -e py33``.

#. Submit a Pull Request to the master branch on GitHub.

If you’d like to have a development environment for ``pg_diff``, you
should create a virtualenv and then do ``pip install -e .`` from within
the directory.

Lisence
=======

MIT Lisence

.. |Build Status| image:: https://travis-ci.org/hanks/pg_diff.svg?branch=master
:target: https://travis-ci.org/hanks/pg_diff
.. |Coverage Status| image:: https://coveralls.io/repos/github/hanks/pg_diff/badge.svg?branch=master
:target: https://coveralls.io/github/hanks/pg_diff?branch=master
Keywords: pg_diff postgresql diff
Platform: UNKNOWN
Classifier: Topic :: Utilities
Classifier: Development Status :: 5 - Production/Stable
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.6
Classifier: Programming Language :: Python :: 2.7
Classifier: Intended Audience :: Developers
Classifier: Operating System :: OS Independent

Project details


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
pg_diff-0.2.1-py2.py3-none-any.whl (10.2 kB) Copy SHA256 hash SHA256 Wheel py2.py3 Jan 16, 2017
pg_diff-0.2.1.tar.gz (7.7 kB) Copy SHA256 hash SHA256 Source None Jan 16, 2017

Supported by

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