Josh Elser created HBASE-16376:
----------------------------------
Summary: Document implicit side-effects on partial results when
calling Scan#setBatch(int)
Key: HBASE-16376
URL: https://issues.apache.org/jira/browse/HBASE-16376
Project: HBase
Issue Type: Task
Components: API, documentation
Reporter: Josh Elser
Assignee: Josh Elser
Fix For: 2.0.0, 1.3.0, 1.2.3, 0.98.22
It was brought to my attention that the javadoc on {{Scan#setBatch(int)}} does
not inform the user that calling this method has the implicit side-effect that
the user may see partial {{Result}}s.
While the side-effect isn't necessarily surprising for developers who know how
it's implemented, but for API users, this might be a very jarring implication.
We should update the documentation on {{Scan#setBatch(int)}} to inform users
that they may see partial results if they call this method (and perhaps refer
them to the size-based {{Scan#setMaxResultSize(long)}} too).
--
This message was sent by Atlassian JIRA
(v6.3.4#6332)
