Uploaded image for project: 'HBase'
  1. HBase
  2. HBASE-16376

Document implicit side-effects on partial results when calling Scan#setBatch(int)

VotersWatch issueWatchersCreate sub-taskLinkCloneUpdate Comment AuthorReplace String in CommentUpdate Comment VisibilityDelete Comments
    XMLWordPrintableJSON

Details

    • Reviewed

    Description

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

      Attachments

        1. HBASE-16376.001.patch
          1 kB
          Josh Elser

        Activity

          This comment will be Viewable by All Users Viewable by All Users
          Cancel

          People

            elserj Josh Elser
            elserj Josh Elser
            Votes:
            0 Vote for this issue
            Watchers:
            5 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved:

              Slack

                Issue deployment