Author: ecn
Date: Thu Jan 10 16:28:15 2013
New Revision: 1431485
URL: http://svn.apache.org/viewvc?rev=1431485&view=rev
Log:
ACCUMULO-733 added description to BatchWriter documentation
Modified:
accumulo/trunk/core/src/main/java/org/apache/accumulo/core/client/BatchWriter.java
Modified:
accumulo/trunk/core/src/main/java/org/apache/accumulo/core/client/BatchWriter.java
URL:
http://svn.apache.org/viewvc/accumulo/trunk/core/src/main/java/org/apache/accumulo/core/client/BatchWriter.java?rev=1431485&r1=1431484&r2=1431485&view=diff
==============================================================================
---
accumulo/trunk/core/src/main/java/org/apache/accumulo/core/client/BatchWriter.java
(original)
+++
accumulo/trunk/core/src/main/java/org/apache/accumulo/core/client/BatchWriter.java
Thu Jan 10 16:28:15 2013
@@ -20,6 +20,14 @@ import org.apache.accumulo.core.data.Mut
/**
* Send Mutations to a single Table in Accumulo.
+ *
+ * When the user uses a Connector to create a BatchWriter,
+ * they specify how much memory and how many threads it should use.
+ * As the user adds mutations to the batch writer, it buffers them.
+ * Once the buffered mutations have used half of the user specified buffer,
+ * the mutations are dumped into the background to be written by a thread pool.
+ * If the user specified memory completely fills up, then writes are held.
+ * When a user calls flush, it does not return until all buffered mutations
are written.
*/
public interface BatchWriter {
