1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
|
%global _empty_manifest_terminate_build 0
Name: python-pg-replica-auditor
Version: 0.15
Release: 1
Summary: Run a few sanity checks on your logical PostgreSQL replica to make sure its the same as the primary.
License: MIT License
URL: https://github.com/levkk/pg-replica-auditor
Source0: https://mirrors.aliyun.com/pypi/web/packages/6a/34/43acfe16d408382d3954936ecbeaecd73d878ae5b880e2ddd6dc2d6bb001/pg-replica-auditor-0.15.tar.gz
BuildArch: noarch
Requires: python3-Click
Requires: python3-colorama
Requires: python3-psycopg2
Requires: python3-tqdm
Requires: python3-datadiff
%description
# pg-replica-auditor
A tool to compare a PostgreSQL logical replica to its primary. It can help detect data inconsistencies.
## 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.
#### Count all rows
Counts all the rows using `COUNT(lag_column)` to make sure row counts match on both replica and primary. Very slow, since it has to do a full scan (index or table). Adjust `--count-before` to count all columns before a timestamp on `--lag-column`, or `updated_at` by default.
#### Missing Sequential Records
Go throught the table with a step size of `MAX(id)` * `--step-size=0.01`. The assumption is that if records will be missing, they will be missing in bulk, grouped together.
## 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,
7. `--count-before`, will count all rows in the table created/updated before this timestamp,
8. `--step-size`, will decrease the step size for missing sequential records search.
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 --count-before="2020-04-06"
```
%package -n python3-pg-replica-auditor
Summary: Run a few sanity checks on your logical PostgreSQL replica to make sure its the same as the primary.
Provides: python-pg-replica-auditor
BuildRequires: python3-devel
BuildRequires: python3-setuptools
BuildRequires: python3-pip
%description -n python3-pg-replica-auditor
# pg-replica-auditor
A tool to compare a PostgreSQL logical replica to its primary. It can help detect data inconsistencies.
## 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.
#### Count all rows
Counts all the rows using `COUNT(lag_column)` to make sure row counts match on both replica and primary. Very slow, since it has to do a full scan (index or table). Adjust `--count-before` to count all columns before a timestamp on `--lag-column`, or `updated_at` by default.
#### Missing Sequential Records
Go throught the table with a step size of `MAX(id)` * `--step-size=0.01`. The assumption is that if records will be missing, they will be missing in bulk, grouped together.
## 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,
7. `--count-before`, will count all rows in the table created/updated before this timestamp,
8. `--step-size`, will decrease the step size for missing sequential records search.
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 --count-before="2020-04-06"
```
%package help
Summary: Development documents and examples for pg-replica-auditor
Provides: python3-pg-replica-auditor-doc
%description help
# pg-replica-auditor
A tool to compare a PostgreSQL logical replica to its primary. It can help detect data inconsistencies.
## 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.
#### Count all rows
Counts all the rows using `COUNT(lag_column)` to make sure row counts match on both replica and primary. Very slow, since it has to do a full scan (index or table). Adjust `--count-before` to count all columns before a timestamp on `--lag-column`, or `updated_at` by default.
#### Missing Sequential Records
Go throught the table with a step size of `MAX(id)` * `--step-size=0.01`. The assumption is that if records will be missing, they will be missing in bulk, grouped together.
## 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,
7. `--count-before`, will count all rows in the table created/updated before this timestamp,
8. `--step-size`, will decrease the step size for missing sequential records search.
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 --count-before="2020-04-06"
```
%prep
%autosetup -n pg-replica-auditor-0.15
%build
%py3_build
%install
%py3_install
install -d -m755 %{buildroot}/%{_pkgdocdir}
if [ -d doc ]; then cp -arf doc %{buildroot}/%{_pkgdocdir}; fi
if [ -d docs ]; then cp -arf docs %{buildroot}/%{_pkgdocdir}; fi
if [ -d example ]; then cp -arf example %{buildroot}/%{_pkgdocdir}; fi
if [ -d examples ]; then cp -arf examples %{buildroot}/%{_pkgdocdir}; fi
pushd %{buildroot}
if [ -d usr/lib ]; then
find usr/lib -type f -printf "\"/%h/%f\"\n" >> filelist.lst
fi
if [ -d usr/lib64 ]; then
find usr/lib64 -type f -printf "\"/%h/%f\"\n" >> filelist.lst
fi
if [ -d usr/bin ]; then
find usr/bin -type f -printf "\"/%h/%f\"\n" >> filelist.lst
fi
if [ -d usr/sbin ]; then
find usr/sbin -type f -printf "\"/%h/%f\"\n" >> filelist.lst
fi
touch doclist.lst
if [ -d usr/share/man ]; then
find usr/share/man -type f -printf "\"/%h/%f.gz\"\n" >> doclist.lst
fi
popd
mv %{buildroot}/filelist.lst .
mv %{buildroot}/doclist.lst .
%files -n python3-pg-replica-auditor -f filelist.lst
%dir %{python3_sitelib}/*
%files help -f doclist.lst
%{_docdir}/*
%changelog
* Tue Jun 20 2023 Python_Bot <Python_Bot@openeuler.org> - 0.15-1
- Package Spec generated
|
