hbase-issues mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Hudson (JIRA)" <j...@apache.org>
Subject [jira] [Commented] (HBASE-16376) Document implicit side-effects on partial results when calling Scan#setBatch(int)
Date Wed, 24 Aug 2016 13:42:20 GMT

    [ https://issues.apache.org/jira/browse/HBASE-16376?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=15434957#comment-15434957
] 

Hudson commented on HBASE-16376:
--------------------------------

FAILURE: Integrated in Jenkins build HBase-Trunk_matrix #1473 (See [https://builds.apache.org/job/HBase-Trunk_matrix/1473/])
HBASE-16376 Scan#setBatch(int) javadoc update WRT partial results (enis: rev 1ca849269d35494e4adcb4868b4e78e9c6502de7)
* (edit) hbase-client/src/main/java/org/apache/hadoop/hbase/client/Scan.java


> 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
>            Priority: Minor
>              Labels: beginner
>             Fix For: 2.0.0, 1.3.0, 1.4.0, 1.2.3, 0.98.22, 1.1.7
>
>         Attachments: HBASE-16376.001.patch
>
>
> 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)

Mime
View raw message