[HBASE-16390] Fix documentation around setAutoFlush

• Type: Bug
• Status: Resolved
• Priority: Minor
• Resolution: Fixed
• Fix Version/s: 2.0.0-alpha-3, 2.0.0
• Component/s: documentation
• Labels: beginner
• Hadoop Flags: Reviewed
• Assignee: Sahil Aggarwal
• Reporter: Michael Stack
• Created: 10/Aug/16 17:51
• Updated: 21/Mar/18 22:12
• Resolved: 04/Sep/17 08:06

Description

Our documentation is a little confused around setAutoFlush. Talks of Table but setAutoFlush is not in the Table interface. It was on HTable but was deprecated and since removed. Clean up the doc:

100.4. HBase Client: AutoFlush

When performing a lot of Puts, make sure that setAutoFlush is set to false
on your Table
<http://hbase.apache.org/apidocs/org/apache/hadoop/hbase/client/Table.html>
instance.
Otherwise, the Puts will be sent one at a time to the RegionServer. Puts
added via table.add(Put) and table.add( <List> Put) wind up in the same
write buffer. If autoFlush = false, these messages are not sent until the
write-buffer is filled. To explicitly flush the messages, call flushCommits.
Calling close on the Table instance will invoke flushCommits

Spotted by Jeff Shmain.