Return-Path: X-Original-To: archive-asf-public-internal@cust-asf2.ponee.io Delivered-To: archive-asf-public-internal@cust-asf2.ponee.io Received: from cust-asf.ponee.io (cust-asf.ponee.io [163.172.22.183]) by cust-asf2.ponee.io (Postfix) with ESMTP id 4EED1200B6F for ; Wed, 24 Aug 2016 16:53:23 +0200 (CEST) Received: by cust-asf.ponee.io (Postfix) id 4DA08160AC7; Wed, 24 Aug 2016 14:53:23 +0000 (UTC) Delivered-To: archive-asf-public@cust-asf.ponee.io Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by cust-asf.ponee.io (Postfix) with SMTP id C50D4160AC2 for ; Wed, 24 Aug 2016 16:53:22 +0200 (CEST) Received: (qmail 94972 invoked by uid 500); 24 Aug 2016 14:53:21 -0000 Mailing-List: contact issues-help@hbase.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Delivered-To: mailing list issues@hbase.apache.org Received: (qmail 94857 invoked by uid 99); 24 Aug 2016 14:53:21 -0000 Received: from arcas.apache.org (HELO arcas) (140.211.11.28) by apache.org (qpsmtpd/0.29) with ESMTP; Wed, 24 Aug 2016 14:53:21 +0000 Received: from arcas.apache.org (localhost [127.0.0.1]) by arcas (Postfix) with ESMTP id 37FB62C0164 for ; Wed, 24 Aug 2016 14:53:21 +0000 (UTC) Date: Wed, 24 Aug 2016 14:53:21 +0000 (UTC) From: "Josh Elser (JIRA)" To: issues@hbase.apache.org Message-ID: In-Reply-To: References: Subject: [jira] [Commented] (HBASE-16376) Document implicit side-effects on partial results when calling Scan#setBatch(int) MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 7bit X-JIRA-FingerPrint: 30527f35849b9dde25b450d4833f0394 archived-at: Wed, 24 Aug 2016 14:53:23 -0000 [ https://issues.apache.org/jira/browse/HBASE-16376?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=15435059#comment-15435059 ] Josh Elser commented on HBASE-16376: ------------------------------------ Thanks, [~enis]! > 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)