Return-Path: X-Original-To: apmail-kudu-commits-archive@minotaur.apache.org Delivered-To: apmail-kudu-commits-archive@minotaur.apache.org Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by minotaur.apache.org (Postfix) with SMTP id B8D8719707 for ; Mon, 11 Apr 2016 16:28:47 +0000 (UTC) Received: (qmail 61672 invoked by uid 500); 11 Apr 2016 16:28:47 -0000 Delivered-To: apmail-kudu-commits-archive@kudu.apache.org Received: (qmail 61653 invoked by uid 500); 11 Apr 2016 16:28:47 -0000 Mailing-List: contact commits-help@kudu.incubator.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: dev@kudu.incubator.apache.org Delivered-To: mailing list commits@kudu.incubator.apache.org Received: (qmail 61644 invoked by uid 99); 11 Apr 2016 16:28:47 -0000 Received: from pnap-us-west-generic-nat.apache.org (HELO spamd4-us-west.apache.org) (209.188.14.142) by apache.org (qpsmtpd/0.29) with ESMTP; Mon, 11 Apr 2016 16:28:47 +0000 Received: from localhost (localhost [127.0.0.1]) by spamd4-us-west.apache.org (ASF Mail Server at spamd4-us-west.apache.org) with ESMTP id 043D3C0D34 for ; Mon, 11 Apr 2016 16:28:47 +0000 (UTC) X-Virus-Scanned: Debian amavisd-new at spamd4-us-west.apache.org X-Spam-Flag: NO X-Spam-Score: -2.021 X-Spam-Level: X-Spam-Status: No, score=-2.021 tagged_above=-999 required=6.31 tests=[KAM_ASCII_DIVIDERS=0.8, KAM_LAZY_DOMAIN_SECURITY=1, KAM_MANYCOMMENTS=1.2, RCVD_IN_DNSWL_HI=-5, RCVD_IN_MSPIKE_H3=-0.01, RCVD_IN_MSPIKE_WL=-0.01, RP_MATCHES_RCVD=-0.001] autolearn=disabled Received: from mx2-lw-eu.apache.org ([10.40.0.8]) by localhost (spamd4-us-west.apache.org [10.40.0.11]) (amavisd-new, port 10024) with ESMTP id 7aoQyPA-nD-c for ; Mon, 11 Apr 2016 16:28:15 +0000 (UTC) Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by mx2-lw-eu.apache.org (ASF Mail Server at mx2-lw-eu.apache.org) with SMTP id 0EF255F65A for ; Mon, 11 Apr 2016 16:28:07 +0000 (UTC) Received: (qmail 58167 invoked by uid 99); 11 Apr 2016 16:28:07 -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; Mon, 11 Apr 2016 16:28:07 +0000 Received: by git1-us-west.apache.org (ASF Mail Server at git1-us-west.apache.org, from userid 33) id 04991EAB46; Mon, 11 Apr 2016 16:28:07 +0000 (UTC) Content-Type: text/plain; charset="us-ascii" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit From: jdcryans@apache.org To: commits@kudu.incubator.apache.org Date: Mon, 11 Apr 2016 16:28:20 -0000 Message-Id: <710c5d175bcc4bafaef03f47c2490ff0@git.apache.org> In-Reply-To: <06beda7c146b4609825ea8c470edd03e@git.apache.org> References: <06beda7c146b4609825ea8c470edd03e@git.apache.org> X-Mailer: ASF-Git Admin Mailer Subject: [15/45] incubator-kudu git commit: Add 0.8.0 docs http://git-wip-us.apache.org/repos/asf/incubator-kudu/blob/c78a2f80/releases/0.8.0/apidocs/org/kududb/flume/sink/class-use/KuduSink.html ---------------------------------------------------------------------- diff --git a/releases/0.8.0/apidocs/org/kududb/flume/sink/class-use/KuduSink.html b/releases/0.8.0/apidocs/org/kududb/flume/sink/class-use/KuduSink.html new file mode 100644 index 0000000..b077d70 --- /dev/null +++ b/releases/0.8.0/apidocs/org/kududb/flume/sink/class-use/KuduSink.html @@ -0,0 +1,115 @@ + + + + + +Uses of Class org.kududb.flume.sink.KuduSink (Kudu 0.8.0 API) + + + + + + + + + +
+

Uses of Class
org.kududb.flume.sink.KuduSink

+
+
No usage of org.kududb.flume.sink.KuduSink
+ + + + +

Copyright © 2016. All rights reserved.

+ + http://git-wip-us.apache.org/repos/asf/incubator-kudu/blob/c78a2f80/releases/0.8.0/apidocs/org/kududb/flume/sink/class-use/KuduSinkConfigurationConstants.html ---------------------------------------------------------------------- diff --git a/releases/0.8.0/apidocs/org/kududb/flume/sink/class-use/KuduSinkConfigurationConstants.html b/releases/0.8.0/apidocs/org/kududb/flume/sink/class-use/KuduSinkConfigurationConstants.html new file mode 100644 index 0000000..c04112c --- /dev/null +++ b/releases/0.8.0/apidocs/org/kududb/flume/sink/class-use/KuduSinkConfigurationConstants.html @@ -0,0 +1,115 @@ + + + + + +Uses of Class org.kududb.flume.sink.KuduSinkConfigurationConstants (Kudu 0.8.0 API) + + + + + + + + + +
+

Uses of Class
org.kududb.flume.sink.KuduSinkConfigurationConstants

+
+
No usage of org.kududb.flume.sink.KuduSinkConfigurationConstants
+ + + + +

Copyright © 2016. All rights reserved.

+ + http://git-wip-us.apache.org/repos/asf/incubator-kudu/blob/c78a2f80/releases/0.8.0/apidocs/org/kududb/flume/sink/package-frame.html ---------------------------------------------------------------------- diff --git a/releases/0.8.0/apidocs/org/kududb/flume/sink/package-frame.html b/releases/0.8.0/apidocs/org/kududb/flume/sink/package-frame.html new file mode 100644 index 0000000..1f9d0ba --- /dev/null +++ b/releases/0.8.0/apidocs/org/kududb/flume/sink/package-frame.html @@ -0,0 +1,23 @@ + + + + + +org.kududb.flume.sink (Kudu 0.8.0 API) + + + +

org.kududb.flume.sink

+
+

Interfaces

+ +

Classes

+ +
+ + http://git-wip-us.apache.org/repos/asf/incubator-kudu/blob/c78a2f80/releases/0.8.0/apidocs/org/kududb/flume/sink/package-summary.html ---------------------------------------------------------------------- diff --git a/releases/0.8.0/apidocs/org/kududb/flume/sink/package-summary.html b/releases/0.8.0/apidocs/org/kududb/flume/sink/package-summary.html new file mode 100644 index 0000000..78a5983 --- /dev/null +++ b/releases/0.8.0/apidocs/org/kududb/flume/sink/package-summary.html @@ -0,0 +1,159 @@ + + + + + +org.kududb.flume.sink (Kudu 0.8.0 API) + + + + + + +
+ + + + + +
+ + +
+

Package org.kududb.flume.sink

+
+
+
    +
  • + + + + + + + + + + + + +
    Interface Summary 
    InterfaceDescription
    KuduEventProducer +
    Interface for an event producer which produces Kudu Operations to write + the headers and body of an event in a Kudu table.
    +
    +
  • +
  • + + + + + + + + + + + + + + + + +
    Class Summary 
    ClassDescription
    KuduSink +
    A Flume sink that reads events from a channel and writes them to a Kudu table.
    +
    KuduSinkConfigurationConstants +
    Constants used for configuration of KuduSink
    +
    +
  • +
+
+ +
+ + + + + +
+ + +

Copyright © 2016. All rights reserved.

+ + http://git-wip-us.apache.org/repos/asf/incubator-kudu/blob/c78a2f80/releases/0.8.0/apidocs/org/kududb/flume/sink/package-tree.html ---------------------------------------------------------------------- diff --git a/releases/0.8.0/apidocs/org/kududb/flume/sink/package-tree.html b/releases/0.8.0/apidocs/org/kududb/flume/sink/package-tree.html new file mode 100644 index 0000000..6667c4b --- /dev/null +++ b/releases/0.8.0/apidocs/org/kududb/flume/sink/package-tree.html @@ -0,0 +1,146 @@ + + + + + +org.kududb.flume.sink Class Hierarchy (Kudu 0.8.0 API) + + + + + + +
+ + + + + +
+ + +
+

Hierarchy For Package org.kududb.flume.sink

+Package Hierarchies: + +
+
+

Class Hierarchy

+
    +
  • java.lang.Object +
      +
    • org.apache.flume.sink.AbstractSink (implements org.apache.flume.lifecycle.LifecycleAware, org.apache.flume.Sink) +
        +
      • org.kududb.flume.sink.KuduSink (implements org.apache.flume.conf.Configurable)
      • +
      +
    • +
    • org.kududb.flume.sink.KuduSinkConfigurationConstants
    • +
    +
  • +
+

Interface Hierarchy

+
    +
  • org.apache.flume.conf.Configurable +
      +
    • org.kududb.flume.sink.KuduEventProducer (also extends org.apache.flume.conf.ConfigurableComponent)
    • +
    +
  • +
  • org.apache.flume.conf.ConfigurableComponent +
      +
    • org.kududb.flume.sink.KuduEventProducer (also extends org.apache.flume.conf.Configurable)
    • +
    +
  • +
+
+ +
+ + + + + +
+ + +

Copyright © 2016. All rights reserved.

+ + http://git-wip-us.apache.org/repos/asf/incubator-kudu/blob/c78a2f80/releases/0.8.0/apidocs/org/kududb/flume/sink/package-use.html ---------------------------------------------------------------------- diff --git a/releases/0.8.0/apidocs/org/kududb/flume/sink/package-use.html b/releases/0.8.0/apidocs/org/kududb/flume/sink/package-use.html new file mode 100644 index 0000000..d46b17f --- /dev/null +++ b/releases/0.8.0/apidocs/org/kududb/flume/sink/package-use.html @@ -0,0 +1,115 @@ + + + + + +Uses of Package org.kududb.flume.sink (Kudu 0.8.0 API) + + + + + + + + + +
+

Uses of Package
org.kududb.flume.sink

+
+
No usage of org.kududb.flume.sink
+ + + + +

Copyright © 2016. All rights reserved.

+ + http://git-wip-us.apache.org/repos/asf/incubator-kudu/blob/c78a2f80/releases/0.8.0/apidocs/org/kududb/mapreduce/CommandLineParser.html ---------------------------------------------------------------------- diff --git a/releases/0.8.0/apidocs/org/kududb/mapreduce/CommandLineParser.html b/releases/0.8.0/apidocs/org/kududb/mapreduce/CommandLineParser.html new file mode 100644 index 0000000..f61a4ee --- /dev/null +++ b/releases/0.8.0/apidocs/org/kududb/mapreduce/CommandLineParser.html @@ -0,0 +1,548 @@ + + + + + +CommandLineParser (Kudu 0.8.0 API) + + + + + + + + + + +
+
org.kududb.mapreduce
+

Class CommandLineParser

+
+
+ +
+
    +
  • +
    +
    +
    @InterfaceAudience.Public
    +@InterfaceStability.Unstable
    +public class CommandLineParser
    +extends Object
    +
    Utility class that manages common configurations to all MR jobs. For example, + any job that uses {#KuduTableMapReduceUtil} to setup an input or output format + and that has parsed the command line arguments with + GenericOptionsParser can simply be passed: + + -Dmaster.address=ADDRESS + + in order to specify where the master is. + Use getHelpSnippet() to provide usage text for the configurations + managed by this class.
    +
  • +
+
+
+ +
+
+
    +
  • + + + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        CommandLineParser

        +
        public CommandLineParser(org.apache.hadoop.conf.Configuration conf)
        +
        Constructor that uses a Configuration that has already been through + GenericOptionsParser's command line parsing.
        +
        Parameters:
        conf - the configuration from which job configurations will be extracted
        +
      • +
      +
    • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getMasterAddresses

        +
        public String getMasterAddresses()
        +
        Get the configured master's config.
        +
        Returns:
        a string that contains the passed config, or the default value
        +
      • +
      + + + +
        +
      • +

        getOperationTimeoutMs

        +
        public long getOperationTimeoutMs()
        +
        Get the configured timeout for operations on sessions and scanners.
        +
        Returns:
        a long that represents the passed timeout, or the default value
        +
      • +
      + + + +
        +
      • +

        getAdminOperationTimeoutMs

        +
        public long getAdminOperationTimeoutMs()
        +
        Get the configured timeout for admin operations.
        +
        Returns:
        a long that represents the passed timeout, or the default value
        +
      • +
      + + + +
        +
      • +

        getSocketReadTimeoutMs

        +
        public long getSocketReadTimeoutMs()
        +
        Get the configured timeout for socket reads.
        +
        Returns:
        a long that represents the passed timeout, or the default value
        +
      • +
      + + + +
        +
      • +

        getNumReplicas

        +
        public int getNumReplicas()
        +
        Get the number of replicas to use when configuring a new table.
        +
        Returns:
        an int that represents the passed number of replicas to use, or the default value.
        +
      • +
      + + + +
        +
      • +

        getAsyncClient

        +
        public AsyncKuduClient getAsyncClient()
        +
        Get an async client connected to the configured Master(s).
        +
        Returns:
        an async kudu client
        +
      • +
      + + + +
        +
      • +

        getClient

        +
        public KuduClient getClient()
        +
        Get a client connected to the configured Master(s).
        +
        Returns:
        a kudu client
        +
      • +
      + + + +
        +
      • +

        getHelpSnippet

        +
        public static String getHelpSnippet()
        +
        This method returns a single multi-line string that contains the help snippet to append to + the tail of a usage() or help() type of method.
        +
        Returns:
        a string with all the available configurations and their defaults
        +
      • +
      +
    • +
    +
  • +
+
+
+ + + + + +

Copyright © 2016. All rights reserved.

+ + http://git-wip-us.apache.org/repos/asf/incubator-kudu/blob/c78a2f80/releases/0.8.0/apidocs/org/kududb/mapreduce/KuduTableInputFormat.html ---------------------------------------------------------------------- diff --git a/releases/0.8.0/apidocs/org/kududb/mapreduce/KuduTableInputFormat.html b/releases/0.8.0/apidocs/org/kududb/mapreduce/KuduTableInputFormat.html new file mode 100644 index 0000000..dd11752 --- /dev/null +++ b/releases/0.8.0/apidocs/org/kududb/mapreduce/KuduTableInputFormat.html @@ -0,0 +1,344 @@ + + + + + +KuduTableInputFormat (Kudu 0.8.0 API) + + + + + + + + + + +
+
org.kududb.mapreduce
+

Class KuduTableInputFormat

+
+
+
    +
  • java.lang.Object
  • +
  • +
      +
    • org.apache.hadoop.mapreduce.InputFormat<org.apache.hadoop.io.NullWritable,RowResult>
    • +
    • +
        +
      • org.kududb.mapreduce.KuduTableInputFormat
      • +
      +
    • +
    +
  • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    org.apache.hadoop.conf.Configurable
    +
    +
    +
    +
    @InterfaceAudience.Public
    +@InterfaceStability.Evolving
    +public class KuduTableInputFormat
    +extends org.apache.hadoop.mapreduce.InputFormat<org.apache.hadoop.io.NullWritable,RowResult>
    +implements org.apache.hadoop.conf.Configurable
    +

    + This input format generates one split per tablet and the only location for each split is that + tablet's leader. +

    + +

    + Hadoop doesn't have the concept of "closing" the input format so in order to release the + resources we assume that once either getSplits(org.apache.hadoop.mapreduce.JobContext) + or KuduTableInputFormat.TableRecordReader.close() have been called that + the object won't be used again and the AsyncKuduClient is shut down. +

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

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      org.apache.hadoop.mapreduce.RecordReader<org.apache.hadoop.io.NullWritable,RowResult>createRecordReader(org.apache.hadoop.mapreduce.InputSplit inputSplit, + org.apache.hadoop.mapreduce.TaskAttemptContext taskAttemptContext) 
      org.apache.hadoop.conf.ConfigurationgetConf() 
      List<org.apache.hadoop.mapreduce.InputSplit>getSplits(org.apache.hadoop.mapreduce.JobContext jobContext) 
      voidsetConf(org.apache.hadoop.conf.Configuration entries) 
      + +
    • +
    +
  • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        KuduTableInputFormat

        +
        public KuduTableInputFormat()
        +
      • +
      +
    • +
    + +
      +
    • + + +

      Method Detail

      + + + + + + + +
        +
      • +

        createRecordReader

        +
        public org.apache.hadoop.mapreduce.RecordReader<org.apache.hadoop.io.NullWritable,RowResult> createRecordReader(org.apache.hadoop.mapreduce.InputSplit inputSplit,
        +                                                                                                       org.apache.hadoop.mapreduce.TaskAttemptContext taskAttemptContext)
        +                                                                                                         throws IOException,
        +                                                                                                                InterruptedException
        +
        +
        Specified by:
        +
        createRecordReader in class org.apache.hadoop.mapreduce.InputFormat<org.apache.hadoop.io.NullWritable,RowResult>
        +
        Throws:
        +
        IOException
        +
        InterruptedException
        +
      • +
      + + + +
        +
      • +

        setConf

        +
        public void setConf(org.apache.hadoop.conf.Configuration entries)
        +
        +
        Specified by:
        +
        setConf in interface org.apache.hadoop.conf.Configurable
        +
        +
      • +
      + + + +
        +
      • +

        getConf

        +
        public org.apache.hadoop.conf.Configuration getConf()
        +
        +
        Specified by:
        +
        getConf in interface org.apache.hadoop.conf.Configurable
        +
        +
      • +
      +
    • +
    +
  • +
+
+
+ + + + + +

Copyright © 2016. All rights reserved.

+ + http://git-wip-us.apache.org/repos/asf/incubator-kudu/blob/c78a2f80/releases/0.8.0/apidocs/org/kududb/mapreduce/KuduTableMapReduceUtil.html ---------------------------------------------------------------------- diff --git a/releases/0.8.0/apidocs/org/kududb/mapreduce/KuduTableMapReduceUtil.html b/releases/0.8.0/apidocs/org/kududb/mapreduce/KuduTableMapReduceUtil.html new file mode 100644 index 0000000..515a494 --- /dev/null +++ b/releases/0.8.0/apidocs/org/kududb/mapreduce/KuduTableMapReduceUtil.html @@ -0,0 +1,307 @@ + + + + + +KuduTableMapReduceUtil (Kudu 0.8.0 API) + + + + + + + + + + +
+
org.kududb.mapreduce
+

Class KuduTableMapReduceUtil

+
+
+ +
+
    +
  • +
    +
    +
    @InterfaceAudience.Public
    +@InterfaceStability.Evolving
    +public class KuduTableMapReduceUtil
    +extends Object
    +
    Utility class to setup MR jobs that use Kudu as an input and/or output.
    +
  • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      static voidaddDependencyJars(org.apache.hadoop.conf.Configuration conf, + Class<?>... classes) +
      Add the jars containing the given classes to the job's configuration + such that JobClient will ship them to the cluster and add them to + the DistributedCache.
      +
      static voidaddDependencyJars(org.apache.hadoop.mapreduce.Job job) +
      Add the Kudu dependency jars as well as jars for any of the configured + job classes to the job configuration, so that JobClient will ship them + to the cluster and add them to the DistributedCache.
      +
      static voidaddKuduDependencyJars(org.apache.hadoop.conf.Configuration conf) +
      Add Kudu and its dependencies (only) to the job configuration.
      +
      static KuduTablegetTableFromContext(org.apache.hadoop.mapreduce.TaskInputOutputContext context) +
      Use this method when setting up a task to get access to the KuduTable in order to create + Inserts, Updates, and Deletes.
      +
      + +
    • +
    +
  • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getTableFromContext

        +
        public static KuduTable getTableFromContext(org.apache.hadoop.mapreduce.TaskInputOutputContext context)
        +
        Use this method when setting up a task to get access to the KuduTable in order to create + Inserts, Updates, and Deletes.
        +
        Parameters:
        context - Map context
        +
        Returns:
        The kudu table object as setup by the output format
        +
      • +
      + + + +
        +
      • +

        addDependencyJars

        +
        public static void addDependencyJars(org.apache.hadoop.mapreduce.Job job)
        +                              throws IOException
        +
        Add the Kudu dependency jars as well as jars for any of the configured + job classes to the job configuration, so that JobClient will ship them + to the cluster and add them to the DistributedCache.
        +
        Throws:
        +
        IOException
        +
      • +
      + + + +
        +
      • +

        addDependencyJars

        +
        public static void addDependencyJars(org.apache.hadoop.conf.Configuration conf,
        +                     Class<?>... classes)
        +                              throws IOException
        +
        Add the jars containing the given classes to the job's configuration + such that JobClient will ship them to the cluster and add them to + the DistributedCache.
        +
        Throws:
        +
        IOException
        +
      • +
      + + + +
        +
      • +

        addKuduDependencyJars

        +
        public static void addKuduDependencyJars(org.apache.hadoop.conf.Configuration conf)
        +                                  throws IOException
        +
        Add Kudu and its dependencies (only) to the job configuration. +

        + This is intended as a low-level API, facilitating code reuse between this + class and its mapred counterpart. It also of use to external tools that + need to build a MapReduce job that interacts with Kudu but want + fine-grained control over the jars shipped to the cluster. +

        +
        Parameters:
        conf - The Configuration object to extend with dependencies.
        +
        Throws:
        +
        IOException
        See Also:
        KuduTableMapReduceUtil, +PIG-3285
        +
      • +
      +
    • +
    +
  • +
+
+
+ + + + + +

Copyright © 2016. All rights reserved.

+ +