From 1ffb37db8ed9ef4d1d0bb913b2f3ba6a396d9756 Mon Sep 17 00:00:00 2001 From: Aleksandr Kuzminsky Date: Sun, 13 Sep 2020 15:04:53 -0700 Subject: [PATCH 1/2] Documentation update --- HISTORY.rst | 7 +++++++ README.rst | 17 ++++------------- docs/index.rst | 1 + docs/installation.rst | 15 ++++++++++----- docs/modules.rst | 7 +++++++ docs/twindb_table_compare.rst | 30 ++++++++++++++++++++++++++++++ docs/usage.rst | 21 +++++++++++++++++---- twindb_table_compare/compare.py | 22 +++++++++++----------- 8 files changed, 87 insertions(+), 33 deletions(-) create mode 100644 docs/modules.rst create mode 100644 docs/twindb_table_compare.rst diff --git a/HISTORY.rst b/HISTORY.rst index 915e7cd..7e8ae67 100644 --- a/HISTORY.rst +++ b/HISTORY.rst @@ -2,6 +2,13 @@ History ======= +3.0.2 (2020-09-13) +------------------ + +* Python 3 support +* Command line tool renamed to twindb-table-compare + + 0.1.0 (2016-08-29) ------------------ diff --git a/README.rst b/README.rst index b706611..48a719a 100644 --- a/README.rst +++ b/README.rst @@ -2,27 +2,18 @@ TwinDB Table Compare ==================== -.. image:: https://badges.gitter.im/twindb/twindb_table_compare.svg - :alt: Join the chat at https://gitter.im/twindb/twindb_table_compare - :target: https://gitter.im/twindb/twindb_table_compare?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge - - .. image:: https://img.shields.io/pypi/v/twindb_table_compare.svg :target: https://pypi.python.org/pypi/twindb_table_compare -.. image:: https://img.shields.io/travis/twindb/twindb_table_compare.svg - :target: https://travis-ci.org/twindb/twindb_table_compare - -.. image:: https://img.shields.io/codecov/c/github/twindb/twindb_table_compare.svg - :target: https://codecov.io/gh/twindb/twindb_table_compare - :alt: Code test coverage +.. image:: https://img.shields.io/travis/twindb/twindb-table-compare.svg + :target: https://travis-ci.org/twindb/twindb-table-compare .. image:: https://readthedocs.org/projects/twindb-table-compare/badge/?version=master :target: https://twindb-table-compare.readthedocs.io/en/master/?badge=master :alt: Documentation Status -.. image:: https://pyup.io/repos/github/twindb/twindb_table_compare/shield.svg - :target: https://pyup.io/repos/github/twindb/twindb_table_compare/ +.. image:: https://pyup.io/repos/github/twindb/twindb-table-compare/shield.svg + :target: https://pyup.io/repos/github/twindb/twindb-table-compare/ :alt: Updates .. image:: https://img.shields.io/pypi/dd/Django.svg?maxAge=2592000 diff --git a/docs/index.rst b/docs/index.rst index 7da9590..06188fc 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -15,6 +15,7 @@ Contents: installation usage modules + history contributing authors diff --git a/docs/installation.rst b/docs/installation.rst index b73bf83..2e8a10e 100644 --- a/docs/installation.rst +++ b/docs/installation.rst @@ -5,6 +5,11 @@ Installation ============ +Supported Python versions +------------------------- + +* Python 3.6, 3.7, and 3.8 are supported. + Stable release -------------- @@ -12,7 +17,7 @@ To install TwinDB Table Compare, run this command in your terminal: .. code-block:: console - $ pip install twindb_table_compare + $ pip install twindb-table-compare This is the preferred method to install TwinDB Table Compare, as it will always install the most recent stable release. @@ -32,13 +37,13 @@ You can either clone the public repository: .. code-block:: console - $ git clone git://github.com/twindb/twindb_table_compare + $ git clone https://github.com/twindb/twindb-table-compare.git Or download the `tarball`_: .. code-block:: console - $ curl -OL https://github.com/twindb/twindb_table_compare/tarball/master + $ curl -OL https://github.com/twindb/twindb-table-compare/tarball/master Once you have a copy of the source, you can install it with: @@ -47,5 +52,5 @@ Once you have a copy of the source, you can install it with: $ python setup.py install -.. _Github repo: https://github.com/twindb/twindb_table_compare -.. _tarball: https://github.com/twindb/twindb_table_compare/tarball/master +.. _Github repo: https://github.com/twindb/twindb-table-compare +.. _tarball: https://github.com/twindb/twindb-table-compare/tarball/master diff --git a/docs/modules.rst b/docs/modules.rst new file mode 100644 index 0000000..22486e7 --- /dev/null +++ b/docs/modules.rst @@ -0,0 +1,7 @@ +twindb_table_compare +==================== + +.. toctree:: + :maxdepth: 4 + + twindb_table_compare diff --git a/docs/twindb_table_compare.rst b/docs/twindb_table_compare.rst new file mode 100644 index 0000000..2288004 --- /dev/null +++ b/docs/twindb_table_compare.rst @@ -0,0 +1,30 @@ +twindb\_table\_compare package +============================== + +Submodules +---------- + +twindb\_table\_compare.cli module +--------------------------------- + +.. automodule:: twindb_table_compare.cli + :members: + :undoc-members: + :show-inheritance: + +twindb\_table\_compare.compare module +------------------------------------- + +.. automodule:: twindb_table_compare.compare + :members: + :undoc-members: + :show-inheritance: + + +Module contents +--------------- + +.. automodule:: twindb_table_compare + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/usage.rst b/docs/usage.rst index bc7c868..13ab188 100644 --- a/docs/usage.rst +++ b/docs/usage.rst @@ -3,16 +3,29 @@ Usage TwinDB Table Compare should be used in the command line. -This will show differences in data between *slave* and its master. -``twindb_table_compare`` *slave* +.. note:: + + Before running TwinDB Table Compare tool, you should run ``pt-table-checksum`` first. + ``twindb-table-compare`` uses ``percona.checksums``. If you don't run ``pt-table-checksum``, + ``percona.checksums`` will be empty and thus ``twindb-table-compare`` won't show any differences. + +.. note:: + + ``twindb-table-compare`` should run agains the slave. + +This will show differences in data between a *slave* and its master. + +.. code-block:: shell + + twindb-table-compare slave where *slave* is a hostname of a MySQL slave. :: - [root@master vagrant]# twindb_table_compare --user=dba --password=qwerty 192.168.35.251 + # twindb-table-compare --user=dba --password=qwerty 192.168.35.251 2016-09-03 22:48:01,732: INFO: twindb_table_compare.get_inconsistencies():127: Executing: SELECT chunk FROM `percona`.`checksums` WHERE (this_crc<>master_crc OR this_cnt<>master_cnt) AND db='mysql' AND tbl='proxies_priv' 2016-09-03 22:48:01,734: INFO: twindb_table_compare.get_inconsistencies():138: Found 1 inconsistent chunk 2016-09-03 22:48:01,734: INFO: twindb_table_compare.get_inconsistencies():141: # mysql.proxies_priv, chunk 1 @@ -48,4 +61,4 @@ where *slave* is a hostname of a MySQL slave. localhost dba *AA1420F182E88B9E5F874F6FBE7459291E8F4601 Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y 0 0 0 0mysql_native_password N % repl *809534247D21AC735802078139D8A854F45C31F3 N N N N N N N N N N N N N N N N N N N Y N N N N N N N N N 0 0 0 0 mysql_native_password N -Run ``twindb_table_compare --help`` for other options. +Run ``twindb-table-compare --help`` for other options. diff --git a/twindb_table_compare/compare.py b/twindb_table_compare/compare.py index d9ce702..a16c974 100644 --- a/twindb_table_compare/compare.py +++ b/twindb_table_compare/compare.py @@ -274,11 +274,11 @@ def primary_exists(conn, db, tbl): def get_boundary_clause(oper=">", index_fields=None, boundaries=None): """ - Generate a clause for the WHERE statement based on field names and values + Generate a clause for the WHERE statement based on field names and values. - :param oper: Can be either ``<`` for the lower boundary or ``>`` - for the upper boundary - :param index_fields: list of fields in the index + :param oper: Can be either ``<`` for the lower boundary + or ``>`` for the upper boundary. + :param index_fields: list of fields in the index. :type index_fields: list :param boundaries: list of values for a boundary. :type boundaries: list @@ -317,15 +317,15 @@ def get_boundary_clause(oper=">", index_fields=None, boundaries=None): def get_where(lower_boundary, upper_boundary, index_fields): """ Generate WHERE clause based on strings ``lower_boundary``, - ``upper_boundary`` from percona.checksums table and fields in the index + ``upper_boundary`` from ``percona.checksums`` table and fields in the index. - :param lower_boundary: values of lower boundary + :param lower_boundary: values of lower boundary. :type lower_boundary: str - :param upper_boundary: values of upper boundary + :param upper_boundary: values of upper boundary. :type upper_boundary: str - :param index_fields: list of fields in the index that was used - to access a chunk - :return: a WHERE clause to read a chunk + :param index_fields: list of fields in the index that was used. + to access a chunk. + :return: a WHERE clause to read a chunk. :rtype: str """ @@ -578,7 +578,7 @@ def get_inconsistent_tables(host, user, password, ch_db="percona", ch_tbl="check :param ch_db: Database where checksums are stored. :param ch_tbl: Table name where checksums are stored. :return: List of tuples with inconsistent tables. - Each tuple is database name, table name + Each tuple is database name, table name. :rtype: list """ conn = connect(host=host, user=user, passwd=password) From eb729329e5f615c195b74449f23b36c6f5e5b68e Mon Sep 17 00:00:00 2001 From: Aleksandr Kuzminsky Date: Sun, 13 Sep 2020 15:09:03 -0700 Subject: [PATCH 2/2] =?UTF-8?q?Bump=20version:=203.0.2=20=E2=86=92=203.0.3?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- setup.cfg | 2 +- setup.py | 2 +- twindb_table_compare/__init__.py | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/setup.cfg b/setup.cfg index 36e013d..53d15cf 100644 --- a/setup.cfg +++ b/setup.cfg @@ -1,5 +1,5 @@ [bumpversion] -current_version = 3.0.2 +current_version = 3.0.3 commit = True tag = False diff --git a/setup.py b/setup.py index ef92188..5b05609 100644 --- a/setup.py +++ b/setup.py @@ -15,7 +15,7 @@ setup( name="twindb_table_compare", - version="3.0.2", + version="3.0.3", description=( "TwinDB Table Compare reads percona.checksums from the master and slave " "and shows what records are difference if there are any inconsistencies." diff --git a/twindb_table_compare/__init__.py b/twindb_table_compare/__init__.py index bdfbfa8..72d42c4 100644 --- a/twindb_table_compare/__init__.py +++ b/twindb_table_compare/__init__.py @@ -7,7 +7,7 @@ __author__ = "Aleksandr Kuzminsky" __email__ = "aleks@twindb.com" -__version__ = "3.0.2" +__version__ = "3.0.3" LOG = logging.getLogger(__name__)