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 F1A29200B27 for ; Wed, 22 Jun 2016 22:53:20 +0200 (CEST) Received: by cust-asf.ponee.io (Postfix) id F0580160A69; Wed, 22 Jun 2016 20:53:20 +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 C5CE9160A36 for ; Wed, 22 Jun 2016 22:53:18 +0200 (CEST) Received: (qmail 37029 invoked by uid 500); 22 Jun 2016 20:53:18 -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 37020 invoked by uid 99); 22 Jun 2016 20:53:17 -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; Wed, 22 Jun 2016 20:53:17 +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 5B501C0DF4 for ; Wed, 22 Jun 2016 20:53:17 +0000 (UTC) X-Virus-Scanned: Debian amavisd-new at spamd4-us-west.apache.org X-Spam-Flag: NO X-Spam-Score: -3.446 X-Spam-Level: X-Spam-Status: No, score=-3.446 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=-1.426] 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 O35gIfDTZu_m for ; Wed, 22 Jun 2016 20:52:36 +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 258A660D0C for ; Wed, 22 Jun 2016 20:52:25 +0000 (UTC) Received: (qmail 34949 invoked by uid 99); 22 Jun 2016 20:52:25 -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; Wed, 22 Jun 2016 20:52:25 +0000 Received: by git1-us-west.apache.org (ASF Mail Server at git1-us-west.apache.org, from userid 33) id 3AA30E08BD; Wed, 22 Jun 2016 20:52:25 +0000 (UTC) Content-Type: text/plain; charset="us-ascii" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit From: todd@apache.org To: commits@kudu.incubator.apache.org Date: Wed, 22 Jun 2016 20:53:08 -0000 Message-Id: <0e86d3fa42cb4e2ba939190e0d6d9510@git.apache.org> In-Reply-To: <3e4f6537e28d49719eb2df7853d4b784@git.apache.org> References: <3e4f6537e28d49719eb2df7853d4b784@git.apache.org> X-Mailer: ASF-Git Admin Mailer Subject: [45/51] [partial] incubator-kudu-site git commit: Initial import from site repo archived-at: Wed, 22 Jun 2016 20:53:21 -0000 http://git-wip-us.apache.org/repos/asf/incubator-kudu-site/blob/a3d04f9b/apidocs/index.html ---------------------------------------------------------------------- diff --git a/apidocs/index.html b/apidocs/index.html new file mode 100644 index 0000000..4bf75fa --- /dev/null +++ b/apidocs/index.html @@ -0,0 +1,75 @@ + + + + + + +Kudu 0.9.0 API + + + + + + + + + +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<h2>Frame Alert</h2> +<p>This document is designed to be viewed using the frames feature. If you see this message, you are using a non-frame-capable web client. Link to <a href="overview-summary.html">Non-frame version</a>.</p> + + + http://git-wip-us.apache.org/repos/asf/incubator-kudu-site/blob/a3d04f9b/apidocs/org/kududb/ColumnSchema.html ---------------------------------------------------------------------- diff --git a/apidocs/org/kududb/ColumnSchema.html b/apidocs/org/kududb/ColumnSchema.html new file mode 100644 index 0000000..e3e3ae0 --- /dev/null +++ b/apidocs/org/kududb/ColumnSchema.html @@ -0,0 +1,434 @@ + + + + + + +ColumnSchema (Kudu 0.9.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
org.kududb
+

Class ColumnSchema

+
+
+ +
+
    +
  • +
    +
    +
    @InterfaceAudience.Public
+ @InterfaceStability.Evolving
+public class ColumnSchema
+extends Object
    +
    Represents a Kudu Table column. Use ColumnSchema.ColumnSchemaBuilder in order to + create columns.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getType

        +
        public Type getType()
        +
        Get the column's Type
        +
        +
        Returns:
        +
        the type
        +
        +
        • +
      + + + +
        +
      • +

        getName

        +
        public String getName()
        +
        Get the column's name
        +
        +
        Returns:
        +
        A string representation of the name
        +
        +
        • +
      + + + +
        +
      • +

        isKey

        +
        public boolean isKey()
        +
        Answers if the column part of the key
        +
        +
        Returns:
        +
        true if the column is part of the key, else false
        +
        +
        • +
      + + + +
        +
      • +

        isNullable

        +
        public boolean isNullable()
        +
        Answers if the column can be set to null
        +
        +
        Returns:
        +
        true if it can be set to null, else false
        +
        +
        • +
      + + + +
        +
      • +

        getDefaultValue

        +
        public Object getDefaultValue()
        +
        The Java object representation of the default value that's read
        +
        +
        Returns:
        +
        the default read value
        +
        +
        • +
      + + + +
        +
      • +

        getDesiredBlockSize

        +
        public int getDesiredBlockSize()
        +
        Gets the desired block size for this column. + If no block size has been explicitly specified for this column, + returns 0 to indicate that the server-side default will be used.
        +
        +
        Returns:
        +
        the block size, in bytes, or 0 if none has been configured.
        +
        +
        • +
      + + + +
        +
      • +

        getEncoding

        +
        public org.kududb.ColumnSchema.Encoding getEncoding()
        +
        Return the encoding of this column, or null if it is not known.
        +
        • +
      + + + +
        +
      • +

        getCompressionAlgorithm

        +
        public org.kududb.ColumnSchema.CompressionAlgorithm getCompressionAlgorithm()
        +
        Return the compression algorithm of this column, or null if it is not known.
        +
        • +
      + + + +
        +
      • +

        equals

        +
        public boolean equals(Object o)
        +
        +
        Overrides:
        +
        equals in class Object
        +
        +
        • +
      + + + +
        +
      • +

        hashCode

        +
        public int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class Object
        +
        +
        • +
      + + + + +
      • +
    +
    • +
+
+
+ + +
+ + +
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/incubator-kudu-site/blob/a3d04f9b/apidocs/org/kududb/Schema.html ---------------------------------------------------------------------- diff --git a/apidocs/org/kududb/Schema.html b/apidocs/org/kududb/Schema.html new file mode 100644 index 0000000..d89a2b7 --- /dev/null +++ b/apidocs/org/kududb/Schema.html @@ -0,0 +1,618 @@ + + + + + + +Schema (Kudu 0.9.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
org.kududb
+

Class Schema

+
+
+ +
+
    +
  • +
    +
    +
    @InterfaceAudience.Public
+ @InterfaceStability.Evolving
+public class Schema
+extends Object
    +
    Represents table's schema which is essentially a list of columns. + This class offers a few utility methods for querying it.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        Schema

        +
        public Schema(List<ColumnSchema> columns)
        +
        Constructs a schema using the specified columns and does some internal accounting
        +
        +
        Parameters:
        +
        columns - the columns in index order
        +
        Throws:
        +
        IllegalArgumentException - If the key columns aren't specified first + + See ColumnPBsToSchema() in src/kudu/common/wire_protocol.cc
        +
        +
        • +
      + + + +
        +
      • +

        Schema

        +
        public Schema(List<ColumnSchema> columns,
+              List<Integer> columnIds)
        +
        Constructs a schema using the specified columns and IDs. + + This is not a stable API, prefer using Schema(List) to create a new schema.
        +
        +
        Parameters:
        +
        columns - the columns in index order
        +
        columnIds - the column ids of the provided columns, or null
        +
        Throws:
        +
        IllegalArgumentException - If the primary key columns aren't specified first
        +
        IllegalArgumentException - If the column ids length does not match the columns length + + See ColumnPBsToSchema() in src/kudu/common/wire_protocol.cc
        +
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getColumns

        +
        public List<ColumnSchema> getColumns()
        +
        Get the list of columns used to create this schema
        +
        +
        Returns:
        +
        list of columns
        +
        +
        • +
      + + + +
        +
      • +

        getVarLengthColumnCount

        +
        public int getVarLengthColumnCount()
        +
        Get the count of columns with variable length (BINARY/STRING) in + this schema.
        +
        +
        Returns:
        +
        strings count
        +
        +
        • +
      + + + +
        +
      • +

        getRowSize

        +
        public int getRowSize()
        +
        Get the size a row built using this schema would be
        +
        +
        Returns:
        +
        size in bytes
        +
        +
        • +
      + + + +
        +
      • +

        getColumnOffset

        +
        public int getColumnOffset(int idx)
        +
        Get the index at which this column can be found in the backing byte array
        +
        +
        Parameters:
        +
        idx - column's index
        +
        Returns:
        +
        column's offset
        +
        +
        • +
      + + + +
        +
      • +

        getColumnIndex

        +
        public int getColumnIndex(String columnName)
        +
        Get the index for the provided column name.
        +
        +
        Parameters:
        +
        columnName - column to search for
        +
        Returns:
        +
        an index in the schema
        +
        +
        • +
      + + + +
        +
      • +

        getColumnByIndex

        +
        public ColumnSchema getColumnByIndex(int idx)
        +
        Get the column at the specified index in the original list
        +
        +
        Parameters:
        +
        idx - column's index
        +
        Returns:
        +
        the column
        +
        +
        • +
      + + + +
        +
      • +

        getColumnIndex

        +
        public int getColumnIndex(int columnId)
        +
        Get the column index of the column with the provided ID. + This method is not part of the stable API.
        +
        +
        Parameters:
        +
        columnId - the column id of the column
        +
        Returns:
        +
        the column index of the column.
        +
        +
        • +
      + + + +
        +
      • +

        getColumn

        +
        public ColumnSchema getColumn(String columnName)
        +
        Get the column associated with the specified name
        +
        +
        Parameters:
        +
        columnName - column's name
        +
        Returns:
        +
        the column
        +
        +
        • +
      + + + +
        +
      • +

        getColumnCount

        +
        public int getColumnCount()
        +
        Get the count of columns in this schema
        +
        +
        Returns:
        +
        count of columns
        +
        +
        • +
      + + + +
        +
      • +

        getPrimaryKeyColumnCount

        +
        public int getPrimaryKeyColumnCount()
        +
        Get the count of columns that are part of the primary key.
        +
        +
        Returns:
        +
        count of primary key columns.
        +
        +
        • +
      + + + +
        +
      • +

        getPrimaryKeyColumns

        +
        public List<ColumnSchema> getPrimaryKeyColumns()
        +
        Get the primary key columns.
        +
        +
        Returns:
        +
        the primary key columns.
        +
        +
        • +
      + + + +
        +
      • +

        getRowKeyProjection

        +
        public Schema getRowKeyProjection()
        +
        Get a schema that only contains the columns which are part of the key
        +
        +
        Returns:
        +
        new schema with only the keys
        +
        +
        • +
      + + + +
        +
      • +

        hasNullableColumns

        +
        public boolean hasNullableColumns()
        +
        Tells if there's at least one nullable column
        +
        +
        Returns:
        +
        true if at least one column is nullable, else false.
        +
        +
        • +
      + + + +
        +
      • +

        hasColumnIds

        +
        public boolean hasColumnIds()
        +
        Tells whether this schema includes IDs for columns. A schema created by a client as part of + table creation will not include IDs, but schemas for open tables will include IDs. + This method is not part of the stable API.
        +
        +
        Returns:
        +
        whether this schema includes column IDs.
        +
        +
        • +
      + + + +
        +
      • +

        newPartialRow

        +
        public PartialRow newPartialRow()
        +
        Creates a new partial row for the schema.
        +
        +
        Returns:
        +
        a new partial row
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

Copyright © 2016. All rights reserved.

+ + http://git-wip-us.apache.org/repos/asf/incubator-kudu-site/blob/a3d04f9b/apidocs/org/kududb/Type.html ---------------------------------------------------------------------- diff --git a/apidocs/org/kududb/Type.html b/apidocs/org/kududb/Type.html new file mode 100644 index 0000000..f316d46 --- /dev/null +++ b/apidocs/org/kududb/Type.html @@ -0,0 +1,540 @@ + + + + + + +Type (Kudu 0.9.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
org.kududb
+

Enum Type

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    Serializable, Comparable<Type>
    +
    +
    +
    +
    @InterfaceAudience.Public
+ @InterfaceStability.Evolving
+public enum Type
+extends Enum<Type>
    +
    Describes all the types available to build table schemas.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Enum Constant Detail

      + + + +
        +
      • +

        INT8

        +
        public static final Type INT8
        +
        • +
      + + + +
        +
      • +

        INT16

        +
        public static final Type INT16
        +
        • +
      + + + +
        +
      • +

        INT32

        +
        public static final Type INT32
        +
        • +
      + + + +
        +
      • +

        INT64

        +
        public static final Type INT64
        +
        • +
      + + + +
        +
      • +

        BINARY

        +
        public static final Type BINARY
        +
        • +
      + + + +
        +
      • +

        STRING

        +
        public static final Type STRING
        +
        • +
      + + + +
        +
      • +

        BOOL

        +
        public static final Type BOOL
        +
        • +
      + + + +
        +
      • +

        FLOAT

        +
        public static final Type FLOAT
        +
        • +
      + + + +
        +
      • +

        DOUBLE

        +
        public static final Type DOUBLE
        +
        • +
      + + + +
        +
      • +

        TIMESTAMP

        +
        public static final Type TIMESTAMP
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        values

        +
        public static Type[] 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 (Type c : Type.values())
+    System.out.println(c);
+
        +
        +
        Returns:
        +
        an array containing the constants of this enum type, in the order they are declared
        +
        +
        • +
      + + + +
        +
      • +

        valueOf

        +
        public static Type 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
        +
        +
        • +
      + + + +
        +
      • +

        getDataType

        +
        public org.kududb.Common.DataType getDataType()
        +
        Get the data type from the common's pb
        +
        +
        Returns:
        +
        A DataType
        +
        +
        • +
      + + + +
        +
      • +

        getName

        +
        public String getName()
        +
        Get the string representation of this type
        +
        +
        Returns:
        +
        The type's name
        +
        +
        • +
      + + + +
        +
      • +

        getSize

        +
        public int getSize()
        +
        The size of this type on the wire
        +
        +
        Returns:
        +
        A size
        +
        +
        • +
      + + + + + + + +
        +
      • +

        getTypeForDataType

        +
        public static Type getTypeForDataType(org.kududb.Common.DataType type)
        +
        Convert the pb DataType to a Type
        +
        +
        Parameters:
        +
        type - DataType to convert
        +
        Returns:
        +
        a matching Type
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ +

Copyright © 2016. All rights reserved.

+ + http://git-wip-us.apache.org/repos/asf/incubator-kudu-site/blob/a3d04f9b/apidocs/org/kududb/annotations/InterfaceAudience.html ---------------------------------------------------------------------- diff --git a/apidocs/org/kududb/annotations/InterfaceAudience.html b/apidocs/org/kududb/annotations/InterfaceAudience.html new file mode 100644 index 0000000..a831eaf --- /dev/null +++ b/apidocs/org/kududb/annotations/InterfaceAudience.html @@ -0,0 +1,219 @@ + + + + + + +InterfaceAudience (Kudu 0.9.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
org.kududb.annotations
+

Class InterfaceAudience

+
+
+ +
+
    +
  • +
    +
    +
    @InterfaceAudience.Public
+ @InterfaceStability.Evolving
+public class InterfaceAudience
+extends Object
    +
    Annotation to inform users of a package, class or method's intended audience. + Currently the audience can be InterfaceAudience.Public, InterfaceAudience.LimitedPrivate or + InterfaceAudience.Private.
    + All public classes must have InterfaceAudience annotation.
    +
      +
    • Public classes that are not marked with this annotation must be + considered by default as InterfaceAudience.Private.
      • + +
    • External applications must only use classes that are marked + InterfaceAudience.Public. Avoid using non public classes as these classes + could be removed or change in incompatible ways.
      • + +
    • Hadoop projects must only use classes that are marked + InterfaceAudience.LimitedPrivate or InterfaceAudience.Public
      • + +
    • Methods may have a different annotation that it is more restrictive + compared to the audience classification of the class. Example: A class + might be InterfaceAudience.Public, but a method may be InterfaceAudience.LimitedPrivate +
    +
    • +
+
+
+ +
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ +

Copyright © 2016. All rights reserved.

+ +