From commits-return-6596-archive-asf-public=cust-asf.ponee.io@kudu.apache.org Fri Oct 26 20:57:03 2018 Return-Path: X-Original-To: archive-asf-public@cust-asf.ponee.io Delivered-To: archive-asf-public@cust-asf.ponee.io Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by mx-eu-01.ponee.io (Postfix) with SMTP id C605C1807A1 for ; Fri, 26 Oct 2018 20:57:01 +0200 (CEST) Received: (qmail 21753 invoked by uid 500); 26 Oct 2018 18:56:55 -0000 Mailing-List: contact commits-help@kudu.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: dev@kudu.apache.org Delivered-To: mailing list commits@kudu.apache.org Received: (qmail 21553 invoked by uid 99); 26 Oct 2018 18:56:55 -0000 Received: from git1-us-west.apache.org (HELO git1-us-west.apache.org) (140.211.11.23) by apache.org (qpsmtpd/0.29) with ESMTP; Fri, 26 Oct 2018 18:56:55 +0000 Received: by git1-us-west.apache.org (ASF Mail Server at git1-us-west.apache.org, from userid 33) id 26A9DE0E21; Fri, 26 Oct 2018 18:56:55 +0000 (UTC) Content-Type: text/plain; charset="us-ascii" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit From: abukor@apache.org To: commits@kudu.apache.org Date: Fri, 26 Oct 2018 18:57:10 -0000 Message-Id: <261feb1fb1ff45f89bd7e02062e86e38@git.apache.org> In-Reply-To: References: X-Mailer: ASF-Git Admin Mailer Subject: [17/52] [abbrv] [partial] kudu git commit: Updating web site for Kudu 1.8.0 release http://git-wip-us.apache.org/repos/asf/kudu/blob/1fefa84c/releases/1.8.0/apidocs/org/apache/kudu/client/KuduScanToken.html ---------------------------------------------------------------------- diff --git a/releases/1.8.0/apidocs/org/apache/kudu/client/KuduScanToken.html b/releases/1.8.0/apidocs/org/apache/kudu/client/KuduScanToken.html new file mode 100644 index 0000000..f031b6c --- /dev/null +++ b/releases/1.8.0/apidocs/org/apache/kudu/client/KuduScanToken.html @@ -0,0 +1,411 @@ + + + + + + +KuduScanToken (Kudu 1.8.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
org.apache.kudu.client
+

Class KuduScanToken

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    Comparable<KuduScanToken>
    +
    +
    +
    +
    @InterfaceAudience.Public
+ @InterfaceStability.Unstable
+public class KuduScanToken
+extends Object
+implements Comparable<KuduScanToken>
    +
    A scan token describes a partial scan of a Kudu table limited to a single + contiguous physical location. Using the KuduScanToken.KuduScanTokenBuilder, clients can + describe the desired scan, including predicates, bounds, timestamps, and + caching, and receive back a collection of scan tokens. + + Each scan token may be separately turned into a scanner using + intoScanner(org.apache.kudu.client.KuduClient), with each scanner responsible for a disjoint section + of the table. + + Scan tokens may be serialized using the serialize() method and + deserialized back into a scanner using the deserializeIntoScanner(byte[], org.apache.kudu.client.KuduClient) + method. This allows use cases such as generating scan tokens in the planner + component of a query engine, then sending the tokens to execution nodes based + on locality, and then instantiating the scanners on those nodes. + + Scan token locality information can be inspected using the getTablet() + method.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getTablet

        +
        public LocatedTablet getTablet()
        +
        Returns the tablet which the scanner created from this token will access.
        +
        +
        Returns:
        +
        the located tablet
        +
        +
        • +
      + + + +
        +
      • +

        intoScanner

        +
        public KuduScanner intoScanner(KuduClient client)
+                        throws Exception
        +
        Creates a KuduScanner from this scan token.
        +
        +
        Parameters:
        +
        client - a Kudu client for the cluster
        +
        Returns:
        +
        a scanner for the scan token
        +
        Throws:
        +
        Exception
        +
        +
        • +
      + + + +
        +
      • +

        serialize

        +
        public byte[] serialize()
+                 throws IOException
        +
        Serializes this KuduScanToken into a byte array.
        +
        +
        Returns:
        +
        the serialized scan token
        +
        Throws:
        +
        IOException
        +
        +
        • +
      + + + +
        +
      • +

        deserializeIntoScanner

        +
        public static KuduScanner deserializeIntoScanner(byte[] buf,
+                                                 KuduClient client)
+                                          throws IOException
        +
        Deserializes a KuduScanToken into a KuduScanner.
        +
        +
        Parameters:
        +
        buf - a byte array containing the serialized scan token.
        +
        client - a Kudu client for the cluster
        +
        Returns:
        +
        a scanner for the serialized scan token
        +
        Throws:
        +
        IOException
        +
        +
        • +
      + + + +
        +
      • +

        stringifySerializedToken

        +
        public static String stringifySerializedToken(byte[] buf,
+                                              KuduClient client)
+                                       throws IOException
        +
        Formats the serialized token for debug printing.
        +
        +
        Parameters:
        +
        buf - the serialized token
        +
        client - a Kudu client for the cluster to which the token belongs
        +
        Returns:
        +
        a debug string
        +
        Throws:
        +
        IOException
        +
        +
        • +
      + + + + +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ +

Copyright © 2018 The Apache Software Foundation. All rights reserved.

+ + http://git-wip-us.apache.org/repos/asf/kudu/blob/1fefa84c/releases/1.8.0/apidocs/org/apache/kudu/client/KuduScanner.KuduScannerBuilder.html ---------------------------------------------------------------------- diff --git a/releases/1.8.0/apidocs/org/apache/kudu/client/KuduScanner.KuduScannerBuilder.html b/releases/1.8.0/apidocs/org/apache/kudu/client/KuduScanner.KuduScannerBuilder.html new file mode 100644 index 0000000..e682b3b --- /dev/null +++ b/releases/1.8.0/apidocs/org/apache/kudu/client/KuduScanner.KuduScannerBuilder.html @@ -0,0 +1,267 @@ + + + + + + +KuduScanner.KuduScannerBuilder (Kudu 1.8.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
org.apache.kudu.client
+

Class KuduScanner.KuduScannerBuilder

+
+
+ +
+ +
+
+ +
+
+ +
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ +

Copyright © 2018 The Apache Software Foundation. All rights reserved.

+ + http://git-wip-us.apache.org/repos/asf/kudu/blob/1fefa84c/releases/1.8.0/apidocs/org/apache/kudu/client/KuduScanner.html ---------------------------------------------------------------------- diff --git a/releases/1.8.0/apidocs/org/apache/kudu/client/KuduScanner.html b/releases/1.8.0/apidocs/org/apache/kudu/client/KuduScanner.html new file mode 100644 index 0000000..99104c2 --- /dev/null +++ b/releases/1.8.0/apidocs/org/apache/kudu/client/KuduScanner.html @@ -0,0 +1,494 @@ + + + + + + +KuduScanner (Kudu 1.8.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
org.apache.kudu.client
+

Class KuduScanner

+
+
+ +
+
    +
  • +
    +
    +
    @InterfaceAudience.Public
+ @InterfaceStability.Evolving
+public class KuduScanner
+extends Object
    +
    Synchronous version of AsyncKuduScanner. Offers the same API but with blocking methods.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        hasMoreRows

        +
        public boolean hasMoreRows()
        +
        Tells if the last rpc returned that there might be more rows to scan.
        +
        +
        Returns:
        +
        true if there might be more data to scan, else false
        +
        +
        • +
      + + + +
        +
      • +

        nextRows

        +
        public RowResultIterator nextRows()
+                           throws KuduException
        +
        Scans a number of rows. +

        + Once this method returns null once (which indicates that this + Scanner is done scanning), calling it again leads to an undefined + behavior.

        +
        +
        Returns:
        +
        a list of rows.
        +
        Throws:
        +
        KuduException - if anything went wrong.
        +
        +
        • +
      + + + +
        +
      • +

        keepAlive

        +
        public final void keepAlive()
+                     throws KuduException
        +
        Keep the current remote scanner alive. +

        + Keep the current remote scanner alive on the Tablet server for an + additional time-to-live. This is useful if the interval in between + nextRows() calls is big enough that the remote scanner might be garbage + collected. The scanner time-to-live can be configured on the tablet + server via the --scanner_ttl_ms configuration flag and has a default + of 60 seconds. +

        + This does not invalidate any previously fetched results. +

        + Note that an exception thrown by this method should not be taken as indication + that the scan has failed. Subsequent calls to nextRows() might still be successful, + particularly if the scanner is configured to be fault tolerant.

        +
        +
        Throws:
        +
        KuduException - if anything went wrong.
        +
        +
        • +
      + + + +
        +
      • +

        isClosed

        +
        public boolean isClosed()
        +
        +
        Returns:
        +
        true if the scanner has been closed.
        +
        +
        • +
      + + + +
        +
      • +

        close

        +
        public RowResultIterator close()
+                        throws KuduException
        +
        Closes this scanner (don't forget to call this when you're done with it!). +

        + Closing a scanner already closed has no effect.

        +
        +
        Returns:
        +
        a deferred object that indicates the completion of the request
        +
        Throws:
        +
        KuduException - if anything went wrong.
        +
        +
        • +
      + + + +
        +
      • +

        getLimit

        +
        public long getLimit()
        +
        Returns the maximum number of rows that this scanner was configured to return.
        +
        +
        Returns:
        +
        a long representing the maximum number of rows that can be returned
        +
        +
        • +
      + + + +
        +
      • +

        getCacheBlocks

        +
        public boolean getCacheBlocks()
        +
        Returns if this scanner was configured to cache data blocks or not.
        +
        +
        Returns:
        +
        true if this scanner will cache blocks, else else.
        +
        +
        • +
      + + + +
        +
      • +

        getBatchSizeBytes

        +
        public long getBatchSizeBytes()
        +
        Returns the maximum number of bytes returned by the scanner, on each batch.
        +
        +
        Returns:
        +
        a long representing the maximum number of bytes that a scanner can receive at once + from a tablet server
        +
        +
        • +
      + + + +
        +
      • +

        getReadMode

        +
        public AsyncKuduScanner.ReadMode getReadMode()
        +
        Returns the ReadMode for this scanner.
        +
        +
        Returns:
        +
        the configured read mode for this scanner
        +
        +
        • +
      + + + +
        +
      • +

        getProjectionSchema

        +
        public Schema getProjectionSchema()
        +
        Returns the projection schema of this scanner. If specific columns were + not specified during scanner creation, the table schema is returned.
        +
        +
        Returns:
        +
        the projection schema for this scanner
        +
        +
        • +
      + + + +
        +
      • +

        getScanRequestTimeout

        +
        public long getScanRequestTimeout()
        +
        Returns the current value of the scanner's scan request timeout.
        +
        +
        Returns:
        +
        the timeout value, in milliseconds
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ +

Copyright © 2018 The Apache Software Foundation. All rights reserved.

+ +