luzifer/clean_couch
1
0
Fork 0
mirror of https://github.com/Luzifer/clean_couch.git synced 2024-12-22 10:41:20 +00:00
Code Issues Releases Wiki Activity

Improved README

Browse source
This commit is contained in:
Knut Ahlers 2015-06-20 23:16:27 +02:00
parent de2e522e1a
commit 8100a87d7c
Signed by: luzifer
GPG key ID: DC2729FDD34BE99E
1 changed files with 6 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
README.md
View file

@ -1,8 +1,9 @@
# Luzifer / clean_couch # Luzifer / clean_couch
[![License: Apache 2.0](http://badge.luzifer.io/v1/badge?color=5d79b5&title=license&text=Apache%202.0)](http://www.apache.org/licenses/LICENSE-2.0) [![License: Apache 2.0](http://badge.luzifer.io/v1/badge?color=5d79b5&title=license&text=Apache%202.0)](http://www.apache.org/licenses/LICENSE-2.0)
[![Download on GoBuilder](http://badge.luzifer.io/v1/badge?title=Download%20on&text=GoBuilder)](https://gobuilder.me/github.com/Luzifer/clean_couch)
This utility emerged from the need to delete about 20k documents from a CouchDB database with more than 600k documents. As I did not want to delete every document by hand and had no other way to delete documents by a specific filter. This utility emerged from the need to delete about 20k documents from a CouchDB database with more than 600k documents. As I did not want to delete every document by hand and had no other way to delete documents by a specific filter I wrote this to fetch documents from a view which filters my documents for me and then deletes them efficiently by using Go routines.
## Usage ## Usage
@ -22,11 +23,11 @@ function(doc) {
# ./clean_couch # ./clean_couch
Usage of ./clean_couch: Usage of ./clean_couch:
--baseurl="http://localhost:5984": BaseURL of your CouchDB instance --baseurl="http://localhost:5984": BaseURL of your CouchDB instance
--concurrency=50: How many delete requests should get processed concurrently? --concurrency=20: How many delete requests should get processed concurrently?
--database="": The database containing your view and the data to delete --database="": The database containing your view and the data to delete
--view="": The view selecting the data to delete --view="": The view selecting the data to delete
# ./clean_couch --database=userdata --view=_design/del/_view/usertodelete # ./clean_couch --baseurl=https://user:pass@mycouch.db --database=userdata --view=_design/del/_view/usertodelete
``` ```
## Warnings ## Warnings
@ -34,3 +35,5 @@ Usage of ./clean_couch:
- If you set the concurrency above 1024 either `clean_couch` or even the CouchDB server might break because of a limit in open file descriptors - If you set the concurrency above 1024 either `clean_couch` or even the CouchDB server might break because of a limit in open file descriptors
- If the database has many views you could overload your server because views need to get recalculated - If the database has many views you could overload your server because views need to get recalculated
(My CouchDB server survived a concurrency of 100 with minimal load) (My CouchDB server survived a concurrency of 100 with minimal load)
- This tool will not place nice with your CouchDB if you configure it wrong
- Tripple-check your View does only contain what you want to delete and you used the right view. This tool does not come with a safety-net!