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 DB837200B7E for ; Tue, 23 Aug 2016 08:03:21 +0200 (CEST) Received: by cust-asf.ponee.io (Postfix) id D8201160AD2; Tue, 23 Aug 2016 06:03:21 +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 0EE81160ADC for ; Tue, 23 Aug 2016 08:03:18 +0200 (CEST) Received: (qmail 82027 invoked by uid 500); 23 Aug 2016 06:03:18 -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 81075 invoked by uid 99); 23 Aug 2016 06:03:16 -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; Tue, 23 Aug 2016 06:03:16 +0000 Received: by git1-us-west.apache.org (ASF Mail Server at git1-us-west.apache.org, from userid 33) id 3485AE08AE; Tue, 23 Aug 2016 06:03:16 +0000 (UTC) Content-Type: text/plain; charset="us-ascii" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit From: todd@apache.org To: commits@kudu.apache.org Date: Tue, 23 Aug 2016 06:03:48 -0000 Message-Id: In-Reply-To: <41343a42a03148ae99b900df654e35ea@git.apache.org> References: <41343a42a03148ae99b900df654e35ea@git.apache.org> X-Mailer: ASF-Git Admin Mailer Subject: [34/52] [partial] kudu git commit: Update site for 0.10.0 release archived-at: Tue, 23 Aug 2016 06:03:22 -0000 http://git-wip-us.apache.org/repos/asf/kudu/blob/d4a51158/apidocs/org/apache/kudu/client/SessionConfiguration.html ---------------------------------------------------------------------- diff --git a/apidocs/org/apache/kudu/client/SessionConfiguration.html b/apidocs/org/apache/kudu/client/SessionConfiguration.html new file mode 100644 index 0000000..819ad66 --- /dev/null +++ b/apidocs/org/apache/kudu/client/SessionConfiguration.html @@ -0,0 +1,536 @@ + + + + + + +SessionConfiguration (Kudu 0.10.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
org.apache.kudu.client
+

Interface SessionConfiguration

+
+
+
+
    +
  • +
    +
    All Known Implementing Classes:
    +
    AsyncKuduSession, KuduSession
    +
    +
    +
    +
    @InterfaceAudience.Public
+ @InterfaceStability.Evolving
+public interface SessionConfiguration
    +
    Interface that defines the methods used to configure a session. It also exposes ways to + query its state.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getFlushMode

        +
        SessionConfiguration.FlushMode getFlushMode()
        +
        Get the current flush mode.
        +
        +
        Returns:
        +
        flush mode, AUTO_FLUSH_SYNC by default
        +
        +
        • +
      + + + +
        +
      • +

        setFlushMode

        +
        void setFlushMode(SessionConfiguration.FlushMode flushMode)
        +
        Set the new flush mode for this session.
        +
        +
        Parameters:
        +
        flushMode - new flush mode, can be the same as the previous one.
        +
        Throws:
        +
        IllegalArgumentException - if the buffer isn't empty.
        +
        +
        • +
      + + + +
        +
      • +

        setMutationBufferSpace

        +
        void setMutationBufferSpace(int size)
        +
        Set the number of operations that can be buffered.
        +
        +
        Parameters:
        +
        size - number of ops.
        +
        Throws:
        +
        IllegalArgumentException - if the buffer isn't empty.
        +
        +
        • +
      + + + +
        +
      • +

        setMutationBufferLowWatermark

        +
        void setMutationBufferLowWatermark(float mutationBufferLowWatermarkPercentage)
        +
        Set the low watermark for this session. The default is set to half the mutation buffer space. + For example, a buffer space of 1000 with a low watermark set to 50% (0.5) will start randomly + sending PleaseRetryExceptions once there's an outstanding flush and the buffer is over 500. + As the buffer gets fuller, it becomes likelier to hit the exception.
        +
        +
        Parameters:
        +
        mutationBufferLowWatermarkPercentage - a new low watermark as a percentage, + has to be between 0 and 1 (inclusive). A value of 1 disables + the low watermark since it's the same as the high one
        +
        Throws:
        +
        IllegalArgumentException - if the buffer isn't empty or if the watermark isn't between + 0 and 1
        +
        +
        • +
      + + + +
        +
      • +

        setFlushInterval

        +
        void setFlushInterval(int interval)
        +
        Set the flush interval, which will be used for the next scheduling decision.
        +
        +
        Parameters:
        +
        interval - interval in milliseconds.
        +
        +
        • +
      + + + +
        +
      • +

        getTimeoutMillis

        +
        long getTimeoutMillis()
        +
        Get the current timeout.
        +
        +
        Returns:
        +
        operation timeout in milliseconds, 0 if none was configured.
        +
        +
        • +
      + + + +
        +
      • +

        setTimeoutMillis

        +
        void setTimeoutMillis(long timeout)
        +
        Sets the timeout for the next applied operations. + The default timeout is 0, which disables the timeout functionality.
        +
        +
        Parameters:
        +
        timeout - Timeout in milliseconds.
        +
        +
        • +
      + + + +
        +
      • +

        isClosed

        +
        boolean isClosed()
        +
        Returns true if this session has already been closed.
        +
        • +
      + + + +
        +
      • +

        hasPendingOperations

        +
        boolean hasPendingOperations()
        +
        Check if there are operations that haven't been completely applied.
        +
        +
        Returns:
        +
        true if operations are pending, else false.
        +
        +
        • +
      + + + +
        +
      • +

        setExternalConsistencyMode

        +
        void setExternalConsistencyMode(ExternalConsistencyMode consistencyMode)
        +
        Set the new external consistency mode for this session.
        +
        +
        Parameters:
        +
        consistencyMode - new external consistency mode, can the same as the previous one.
        +
        Throws:
        +
        IllegalArgumentException - if the buffer isn't empty.
        +
        +
        • +
      + + + +
        +
      • +

        isIgnoreAllDuplicateRows

        +
        boolean isIgnoreAllDuplicateRows()
        +
        Tells if the session is currently ignoring row errors when the whole list returned by a tablet + server is of the AlreadyPresent type.
        +
        +
        Returns:
        +
        true if the session is enforcing this, else false
        +
        +
        • +
      + + + +
        +
      • +

        setIgnoreAllDuplicateRows

        +
        void setIgnoreAllDuplicateRows(boolean ignoreAllDuplicateRows)
        +
        Configures the option to ignore all the row errors if they are all of the AlreadyPresent type. + This can be needed when facing KUDU-568. The effect of enabling this is that operation + responses that match this pattern will be cleared of their row errors, meaning that we consider + them successful. + This is disabled by default.
        +
        +
        Parameters:
        +
        ignoreAllDuplicateRows - true if this session should enforce this, else false
        +
        +
        • +
      + + + +
        +
      • +

        countPendingErrors

        +
        int countPendingErrors()
        +
        Return the number of errors which are pending. Errors may accumulate when + using the AUTO_FLUSH_BACKGROUND mode.
        +
        +
        Returns:
        +
        a count of errors
        +
        +
        • +
      + + + +
        +
      • +

        getPendingErrors

        +
        RowErrorsAndOverflowStatus getPendingErrors()
        +
        Return any errors from previous calls. If there were more errors + than could be held in the session's error storage, the overflow state is set to true. + Resets the pending errors.
        +
        +
        Returns:
        +
        an object that contains the errors and the overflow status
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ +

Copyright © 2016. All rights reserved.

+ + http://git-wip-us.apache.org/repos/asf/kudu/blob/d4a51158/apidocs/org/apache/kudu/client/Statistics.Statistic.html ---------------------------------------------------------------------- diff --git a/apidocs/org/apache/kudu/client/Statistics.Statistic.html b/apidocs/org/apache/kudu/client/Statistics.Statistic.html new file mode 100644 index 0000000..f376294 --- /dev/null +++ b/apidocs/org/apache/kudu/client/Statistics.Statistic.html @@ -0,0 +1,402 @@ + + + + + + +Statistics.Statistic (Kudu 0.10.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
org.apache.kudu.client
+

Enum Statistics.Statistic

+
+
+ +
+ +
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Enum Constant Detail

      + + + +
        +
      • +

        BYTES_WRITTEN

        +
        public static final Statistics.Statistic BYTES_WRITTEN
        +
        How many bytes have been written by this client. If one rpc fails, this + statistic won't be updated.
        +
        • +
      + + + +
        +
      • +

        WRITE_OPS

        +
        public static final Statistics.Statistic WRITE_OPS
        +
        How many operations have been sent to server and succeeded.
        +
        • +
      + + + +
        +
      • +

        WRITE_RPCS

        +
        public static final Statistics.Statistic WRITE_RPCS
        +
        How many rpcs have been sent to server and succeeded. One rpc may contain + multiple operations.
        +
        • +
      + + + +
        +
      • +

        OPS_ERRORS

        +
        public static final Statistics.Statistic OPS_ERRORS
        +
        How many operations have been sent to server but failed.
        +
        • +
      + + + +
        +
      • +

        RPC_ERRORS

        +
        public static final Statistics.Statistic RPC_ERRORS
        +
        How many rpcs have been sent to server but failed.
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        values

        +
        public static Statistics.Statistic[] values()
        +
        Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
        +for (Statistics.Statistic c : Statistics.Statistic.values())
+    System.out.println(c);
+
        +
        +
        Returns:
        +
        an array containing the constants of this enum type, in the order they are declared
        +
        +
        • +
      + + + +
        +
      • +

        valueOf

        +
        public static Statistics.Statistic valueOf(String name)
        +
        Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
        +
        +
        Parameters:
        +
        name - the name of the enum constant to be returned.
        +
        Returns:
        +
        the enum constant with the specified name
        +
        Throws:
        +
        IllegalArgumentException - if this enum type has no constant with the specified name
        +
        NullPointerException - if the argument is null
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ +

Copyright © 2016. All rights reserved.

+ + http://git-wip-us.apache.org/repos/asf/kudu/blob/d4a51158/apidocs/org/apache/kudu/client/Statistics.html ---------------------------------------------------------------------- diff --git a/apidocs/org/apache/kudu/client/Statistics.html b/apidocs/org/apache/kudu/client/Statistics.html new file mode 100644 index 0000000..9a4f690 --- /dev/null +++ b/apidocs/org/apache/kudu/client/Statistics.html @@ -0,0 +1,450 @@ + + + + + + +Statistics (Kudu 0.10.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
org.apache.kudu.client
+

Class Statistics

+
+
+ +
+
    +
  • +
    +
    +
    @InterfaceAudience.Public
+ @InterfaceStability.Evolving
+public class Statistics
+extends Object
    +
    A Statistics belongs to a specific AsyncKuduClient. It stores client-level + statistics including number of operations, number of bytes written, number of + rpcs. It is created along with the client's creation, and can be obtained through + AsyncKuduClient or KuduClient's getStatistics method. Once obtained, an instance + of this class can be used directly. +

    + This class is thread-safe. The user can use it anywhere to get statistics of this + client. +

    + The method toString() can be useful to get a dump of all the metrics aggregated + for all the tablets.

    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        Statistics

        +
        public Statistics()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getTabletStatistic

        +
        public long getTabletStatistic(String tabletId,
+                               Statistics.Statistic statistic)
        +
        Get the statistic count of this tablet. + If the specified tablet doesn't have statistics, 0 will be returned.
        +
        +
        Parameters:
        +
        tabletId - the tablet's id
        +
        statistic - the statistic type to get
        +
        Returns:
        +
        the value of the statistic
        +
        +
        • +
      + + + +
        +
      • +

        getTableStatistic

        +
        public long getTableStatistic(String tableName,
+                              Statistics.Statistic statistic)
        +
        Get the statistic count of this table.
        +
        +
        Parameters:
        +
        tableName - the table's name
        +
        statistic - the statistic type to get
        +
        Returns:
        +
        the value of the statistic
        +
        +
        • +
      + + + +
        +
      • +

        getClientStatistic

        +
        public long getClientStatistic(Statistics.Statistic statistic)
        +
        Get the statistic count of the whole client.
        +
        +
        Parameters:
        +
        statistic - the statistic type to get
        +
        Returns:
        +
        the value of the statistic
        +
        +
        • +
      + + + +
        +
      • +

        getTabletSet

        +
        public Set<String> getTabletSet()
        +
        Get the set of tablets which have been written into by this client, + which have statistics information.
        +
        +
        Returns:
        +
        set of tablet ids
        +
        +
        • +
      + + + +
        +
      • +

        getTableSet

        +
        public Set<String> getTableSet()
        +
        Get the set of tables which have been written into by this client, + which have statistics information.
        +
        +
        Returns:
        +
        set of table names
        +
        +
        • +
      + + + +
        +
      • +

        getTableName

        +
        public String getTableName(String tabletId)
        +
        Get table name of the given tablet id. + If the tablet has no statistics, null will be returned.
        +
        +
        Parameters:
        +
        tabletId - the tablet's id
        +
        Returns:
        +
        table name
        +
        +
        • +
      + + + + +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ +

Copyright © 2016. All rights reserved.

+ +