clean_couch/README.md

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 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

1. Create a view which filters the documents in your database with exactly this emit line you can see in this example

function(doc) {
  if (doc.user == "usertodelete") {
    emit(doc._rev, null);
  }
}

2. Execute with parameters

# ./clean_couch
Usage of ./clean_couch:
      --baseurl="http://localhost:5984": BaseURL of your CouchDB instance
      --concurrency=20: How many delete requests should get processed concurrently?
      --database="": The database containing your view and the data to delete
      --view="": The view selecting the data to delete

# ./clean_couch --baseurl=https://user:pass@mycouch.db --database=userdata --view=_design/del/_view/usertodelete

Warnings

• 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
  (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!