A Python application that scans and removes all document conflicts from a CouchDB / Cloudant database.
- Install Python 3.9.x or higher.
[email protected]:mpawlow/github-milestone-generator.gitcd couchdb-conflict-remover- Select the target CouchDB / Cloudant database.
- Generate an API key and password with the following permissions:
_reader(for scanning)_writer(for deletion)
- Select the target CouchDB / Cloudant database.
- Create a new
conflictsdesign document with aconflictsview.- Use the conflicts.js design document.
- In the
./scriptsdirectory, copysetup-environment.sh.templatetosetup-environment.sh. - In
setup-environment.sh, specify values for the following environment variables:CLOUDANT_ACCOUNTCLOUDANT_API_KEYCLOUDANT_PASSWORD
. ./scripts/setup-environment.sh. ./scripts/python/create-venv.sh. ./scripts/python/activate-venv.shmake install(Optional)
make verify$ python index.py --help
usage: index.py [-h] -n DATABASE_NAME [-d] [-r RESULTS_DIR] [-t THRESHOLD]
optional arguments:
-h, --help show this help message and exit
-n DATABASE_NAME, --database-name DATABASE_NAME
The name of the target CouchDB / Cloudant database.
-d, --delete Enable deletion mode. Default: False.
-r RESULTS_DIR, --results-dir RESULTS_DIR
The directory name to use for storing results. Default: results/conflicts_results_2021-03-31_01-03-46.
-t THRESHOLD, --threshold THRESHOLD
The maximum threshold of revisions used to determine whether a conflicted document is included during the deletion phase. Default: 5000.
=== Environment Variables ===
CLOUDANT_ACCOUNT : Cloudant account name.
CLOUDANT_API_KEY : Cloudant API key.
CLOUDANT_PASSWORD : Cloudant password.
=== Examples ===
export CLOUDANT_ACCOUNT=account_name
export CLOUDANT_API_KEY=api_key
export CLOUDANT_PASSWORD=password
python index.py -d -n projects-api_prod-dallas================================================================================
Overview
================================================================================
- Cloudant Account: dataai
- Cloudant Database: projects-api_prod-dallas
- Total Documents: 5163
- Elapsed Time: 0:05:46.245396
================================================================================
Scan Details
================================================================================
- Total Conflicted Documents: 291
- Total Conflicted Revisions: 2127
================================================================================
Deletion Details
================================================================================
- Total Conflicted Documents: 291
- Total Resolved Documents: 291
- Total Conflicted Revisions: 2127
- Total Deleted Revisions: 2127
- (a) Creates a CSV file containing details from the scan phase
- e.g.
conflicts_deletion_details_2021-03-28_19-03-31.csv
- e.g.
- (b) Creates a CSV file containing details from the deletion phase
- e.g.
conflicts_scan_details_2021-03-28_19-03-31.csv
- e.g.
- (c) Creates a text file containing summary information for all phases (as shown in the
Sample Outputsection)- e.g.
conflicts_summary_2021-03-28_19-03-31.txt
- e.g.
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent