Metadata-Version: 2.1
Name: pg-replica-auditor
Version: 0.5.0
Summary: Run a few sanity checks on your logical PostgreSQL replica to make sure its the same as the primary.
Home-page: https://github.com/levkk/pg-replica-auditor
Author: Lev Kokotov
Author-email: lev.kokotov@instacart.com
License: UNKNOWN
Description: # pg-replica-auditor
        
        ## Features
        
        ### Assumptions
        These tests assume that `id` and `updated_at` (or column specified in `--lag-column`) columns exist and have indexes for efficient querying and that the table exists on both databases.
        
        #### Row comparison
        Runs row comparisons between primary and replica using two methods:
        
        1. select 8128 rows (or number of rows given to `--rows`) at random between `MIN(id)` and `MAX(id)`
        2. select the last 1000 rows.
        
        #### Replica lag
        Checks for "replica lag" by comparing `MAX(updated_at)` on the given table on both databases.
        
        #### MinMax
        Checks that the minimum `id` and the maximum `id` match on both replica and primary. These can drift _a little_ because of replica lag.
        
        #### Bulk 1000 Sum
        Take the sum of the `id` column in chunks of 1000 and compare it between databases. This assumes that retrieving rows in bulk is easier than at random and runs faster than the row comparison and can scan more rows.
        
        
        ## Requirements
        
        1. Python 3
        2. Postgres development files (required by psycopg2). On Mac OS, use `brew install postgresql`. On Ubuntu, install `libpq-dev`.
        
        ## Installation
        
        ### Development
        Using virtualenv, `pip install -r requirements.txt`
        
        ### Production
        Using Pypi, `pip install pg-replica-auditor`.
        
        ## Usage
        
        This script requires three arguments:
        1. `--primary`, any acceptable Postgres connection string (incl. DSN),
        2. `--replica`, same as `--primary` but for the replica database,
        
        Optional arguments:
        1. `--exclude-tables`, excludes the comma-separated tables from the scan,
        2. `--table`, only scans this table,
        3. `--debug`, will print debugging information,
        4. `--rows`, will scan this many rows in the row comparisons check,
        5. `--lag-column`, will use this column for the replica lag check,
        6. `--show-skipped`, will print the skipped rows in the Last 1000 check.
        
        Example:
        
        ```bash
        $ pgreplicaauditor --primary=postgres://primary-db.amazonaws.com:5432/my_db --replica=postgres://replica-db.amazonaws.com:5432/my_db --table=immutable_items --lag-column created_at
        ```
        
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3
Description-Content-Type: text/markdown
