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 B7A4C200B8F for ; Tue, 23 Aug 2016 08:03:24 +0200 (CEST) Received: by cust-asf.ponee.io (Postfix) id B65AE160ABC; Tue, 23 Aug 2016 06:03:24 +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 0FF68160AC5 for ; Tue, 23 Aug 2016 08:03:20 +0200 (CEST) Received: (qmail 82450 invoked by uid 500); 23 Aug 2016 06:03:20 -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 81304 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 6F8A4EEE3E; 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:04:00 -0000 Message-Id: <0695f323e86d4296a0d6209768b678fa@git.apache.org> In-Reply-To: <41343a42a03148ae99b900df654e35ea@git.apache.org> References: <41343a42a03148ae99b900df654e35ea@git.apache.org> X-Mailer: ASF-Git Admin Mailer Subject: [46/52] [partial] kudu git commit: Update site for 0.10.0 release archived-at: Tue, 23 Aug 2016 06:03:25 -0000 http://git-wip-us.apache.org/repos/asf/kudu/blob/d4a51158/apidocs/org/apache/kudu/client/AbstractKuduScannerBuilder.html ---------------------------------------------------------------------- diff --git a/apidocs/org/apache/kudu/client/AbstractKuduScannerBuilder.html b/apidocs/org/apache/kudu/client/AbstractKuduScannerBuilder.html new file mode 100644 index 0000000..4cc8f5f --- /dev/null +++ b/apidocs/org/apache/kudu/client/AbstractKuduScannerBuilder.html @@ -0,0 +1,634 @@ + + + + + + +AbstractKuduScannerBuilder (Kudu 0.10.0 API) + + + + + + + + + + + +
+
org.apache.kudu.client
+

Class AbstractKuduScannerBuilder<S extends AbstractKuduScannerBuilder<? super S,T>,T>

+
+
+
    +
  • java.lang.Object
  • +
  • +
      +
    • org.apache.kudu.client.AbstractKuduScannerBuilder<S,T>
    • +
    +
  • +
+
+ +
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        readMode

        +
        public S readMode(AsyncKuduScanner.ReadMode readMode)
        +
        Sets the read mode, the default is to read the latest values.
        +
        +
        Parameters:
        +
        readMode - a read mode for the scanner
        +
        Returns:
        +
        this instance
        +
        +
      • +
      + + + + + + + + + + + +
        +
      • +

        addPredicate

        +
        public S addPredicate(KuduPredicate predicate)
        +
        Adds a predicate to the scan.
        +
        +
        Parameters:
        +
        predicate - predicate to add
        +
        Returns:
        +
        this instance
        +
        +
      • +
      + + + +
        +
      • +

        setProjectedColumnNames

        +
        public S setProjectedColumnNames(List<String> columnNames)
        +
        Set which columns will be read by the Scanner. + Calling this method after setProjectedColumnIndexes(List) will reset the projected + columns to those specified in columnNames.
        +
        +
        Parameters:
        +
        columnNames - the names of columns to read, or 'null' to read all columns + (the default)
        +
        +
      • +
      + + + +
        +
      • +

        setProjectedColumnIndexes

        +
        public S setProjectedColumnIndexes(List<Integer> columnIndexes)
        +
        Set which columns will be read by the Scanner. + Calling this method after setProjectedColumnNames(List) will reset the projected + columns to those specified in columnIndexes.
        +
        +
        Parameters:
        +
        columnIndexes - the indexes of columns to read, or 'null' to read all columns + (the default)
        +
        +
      • +
      + + + +
        +
      • +

        batchSizeBytes

        +
        public S batchSizeBytes(int batchSizeBytes)
        +
        Sets the maximum number of bytes returned by the scanner, on each batch. The default is 1MB. +

        + Kudu may actually return more than this many bytes because it will not + truncate a rowResult in the middle.

        +
        +
        Parameters:
        +
        batchSizeBytes - a strictly positive number of bytes
        +
        Returns:
        +
        this instance
        +
        +
      • +
      + + + +
        +
      • +

        limit

        +
        public S limit(long limit)
        +
        Sets a limit on the number of rows that will be returned by the scanner. There's no limit + by default.
        +
        +
        Parameters:
        +
        limit - a positive long
        +
        Returns:
        +
        this instance
        +
        +
      • +
      + + + +
        +
      • +

        prefetching

        +
        public S prefetching(boolean prefetching)
        +
        Enables prefetching of rows for the scanner, i.e. whether to send a request for more data + to the server immediately after we receive a response (instead of waiting for the user + to call nextRows()). Disabled by default. + NOTE: This is risky until KUDU-1260 is resolved.
        +
        +
        Parameters:
        +
        prefetching - a boolean that indicates if the scanner should prefetch rows
        +
        Returns:
        +
        this instance
        +
        +
      • +
      + + + +
        +
      • +

        cacheBlocks

        +
        public S cacheBlocks(boolean cacheBlocks)
        +
        Sets the block caching policy for the scanner. If true, scanned data blocks will be cached + in memory and made available for future scans. Enabled by default.
        +
        +
        Parameters:
        +
        cacheBlocks - a boolean that indicates if data blocks should be cached or not
        +
        Returns:
        +
        this instance
        +
        +
      • +
      + + + +
        +
      • +

        snapshotTimestampMicros

        +
        public S snapshotTimestampMicros(long timestamp)
        +
        Sets the timestamp the scan must be executed at, in microseconds since the Unix epoch. None is + used by default. + Requires that the ReadMode is READ_AT_SNAPSHOT.
        +
        +
        Parameters:
        +
        timestamp - a long representing an instant in microseconds since the unix epoch.
        +
        Returns:
        +
        this instance
        +
        Throws:
        +
        IllegalArgumentException - on build(), if the timestamp is less than 0 or if the + read mode was not set to READ_AT_SNAPSHOT
        +
        +
      • +
      + + + +
        +
      • +

        scanRequestTimeout

        +
        public S scanRequestTimeout(long scanRequestTimeout)
        +
        Sets how long each scan request to a server can last. + Defaults to KuduClient.getDefaultOperationTimeoutMs().
        +
        +
        Parameters:
        +
        scanRequestTimeout - a long representing time in milliseconds
        +
        Returns:
        +
        this instance
        +
        +
      • +
      + + + +
        +
      • +

        lowerBound

        +
        public S lowerBound(PartialRow partialRow)
        +
        Add a lower bound (inclusive) primary key for the scan. + If any bound is already added, this bound is intersected with that one.
        +
        +
        Parameters:
        +
        partialRow - a partial row with specified key columns
        +
        Returns:
        +
        this instance
        +
        +
      • +
      + + + +
        +
      • +

        lowerBoundRaw

        +
        @Deprecated
        +public S lowerBoundRaw(byte[] startPrimaryKey)
        +
        Deprecated. use lowerBound(PartialRow)
        +
        Like lowerBoundPrimaryKey() but the encoded primary key is an opaque byte array obtained elsewhere.
        +
        +
        Parameters:
        +
        startPrimaryKey - bytes containing an encoded start key
        +
        Returns:
        +
        this instance
        +
        +
      • +
      + + + +
        +
      • +

        exclusiveUpperBound

        +
        public S exclusiveUpperBound(PartialRow partialRow)
        +
        Add an upper bound (exclusive) primary key for the scan. + If any bound is already added, this bound is intersected with that one.
        +
        +
        Parameters:
        +
        partialRow - a partial row with specified key columns
        +
        Returns:
        +
        this instance
        +
        +
      • +
      + + + +
        +
      • +

        exclusiveUpperBoundRaw

        +
        @Deprecated
        +public S exclusiveUpperBoundRaw(byte[] endPrimaryKey)
        + +
        Like exclusiveUpperBound() but the encoded primary key is an opaque byte array obtained elsewhere.
        +
        +
        Parameters:
        +
        endPrimaryKey - bytes containing an encoded end key
        +
        Returns:
        +
        this instance
        +
        +
      • +
      + + + +
        +
      • +

        build

        +
        public abstract T build()
        +
      • +
      +
    • +
    +
  • +
+
+
+ + + + + +

Copyright © 2016. All rights reserved.

+ + http://git-wip-us.apache.org/repos/asf/kudu/blob/d4a51158/apidocs/org/apache/kudu/client/AlterTableOptions.html ---------------------------------------------------------------------- diff --git a/apidocs/org/apache/kudu/client/AlterTableOptions.html b/apidocs/org/apache/kudu/client/AlterTableOptions.html new file mode 100644 index 0000000..a4889f0 --- /dev/null +++ b/apidocs/org/apache/kudu/client/AlterTableOptions.html @@ -0,0 +1,537 @@ + + + + + + +AlterTableOptions (Kudu 0.10.0 API) + + + + + + + + + + + +
+
org.apache.kudu.client
+

Class AlterTableOptions

+
+
+ +
+
    +
  • +
    +
    +
    @InterfaceAudience.Public
    + @InterfaceStability.Unstable
    +public class AlterTableOptions
    +extends Object
    +
    This builder must be used to alter a table. At least one change must be specified.
    +
  • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        AlterTableOptions

        +
        public AlterTableOptions()
        +
      • +
      +
    • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        renameTable

        +
        public AlterTableOptions renameTable(String newName)
        +
        Change a table's name.
        +
        +
        Parameters:
        +
        newName - new table's name, must be used to check progress
        +
        Returns:
        +
        this instance
        +
        +
      • +
      + + + +
        +
      • +

        addColumn

        +
        public AlterTableOptions addColumn(String name,
        +                                   Type type,
        +                                   Object defaultVal)
        +
        Add a new column that's not nullable.
        +
        +
        Parameters:
        +
        name - name of the new column
        +
        type - type of the new column
        +
        defaultVal - default value used for the currently existing rows
        +
        Returns:
        +
        this instance
        +
        +
      • +
      + + + +
        +
      • +

        addNullableColumn

        +
        public AlterTableOptions addNullableColumn(String name,
        +                                           Type type)
        +
        Add a new column that's nullable, thus has no default value.
        +
        +
        Parameters:
        +
        name - name of the new column
        +
        type - type of the new column
        +
        Returns:
        +
        this instance
        +
        +
      • +
      + + + +
        +
      • +

        dropColumn

        +
        public AlterTableOptions dropColumn(String name)
        +
        Drop a column.
        +
        +
        Parameters:
        +
        name - name of the column
        +
        Returns:
        +
        this instance
        +
        +
      • +
      + + + +
        +
      • +

        renameColumn

        +
        public AlterTableOptions renameColumn(String oldName,
        +                                      String newName)
        +
        Change the name of a column.
        +
        +
        Parameters:
        +
        oldName - old column's name, must exist
        +
        newName - new name to use
        +
        Returns:
        +
        this instance
        +
        +
      • +
      + + + +
        +
      • +

        addRangePartition

        +
        public AlterTableOptions addRangePartition(PartialRow lowerBound,
        +                                           PartialRow upperBound)
        +
        Add a range partition to the table with an inclusive lower bound and an exclusive upper bound. + + If either row is empty, then that end of the range will be unbounded. If a range column is + missing a value, the logical minimum value for that column type will be used as the default. + + Multiple range partitions may be added as part of a single alter table transaction by calling + this method multiple times. Added range partitions must not overlap with each + other or any existing range partitions (unless the existing range partitions are dropped as + part of the alter transaction first). The lower bound must be less than the upper bound. + + This client will immediately be able to write and scan the new tablets when the alter table + operation returns success, however other existing clients may have to wait for a timeout period + to elapse before the tablets become visible. This period is configured by the master's + 'table_locations_ttl_ms' flag, and defaults to one hour.
        +
        +
        Parameters:
        +
        lowerBound - inclusive lower bound, may be empty but not null
        +
        upperBound - exclusive upper bound, may be empty but not null
        +
        Returns:
        +
        this instance
        +
        +
      • +
      + + + +
        +
      • +

        addRangePartition

        +
        public AlterTableOptions addRangePartition(PartialRow lowerBound,
        +                                           PartialRow upperBound,
        +                                           RangePartitionBound lowerBoundType,
        +                                           RangePartitionBound upperBoundType)
        +
        Add a range partition to the table with a lower bound and upper bound. + + If either row is empty, then that end of the range will be unbounded. If a range column is + missing a value, the logical minimum value for that column type will be used as the default. + + Multiple range partitions may be added as part of a single alter table transaction by calling + this method multiple times. Added range partitions must not overlap with each + other or any existing range partitions (unless the existing range partitions are dropped as + part of the alter transaction first). The lower bound must be less than the upper bound. + + This client will immediately be able to write and scan the new tablets when the alter table + operation returns success, however other existing clients may have to wait for a timeout period + to elapse before the tablets become visible. This period is configured by the master's + 'table_locations_ttl_ms' flag, and defaults to one hour.
        +
        +
        Parameters:
        +
        lowerBound - lower bound, may be empty but not null
        +
        upperBound - upper bound, may be empty but not null
        +
        lowerBoundType - the type of the lower bound, either inclusive or exclusive
        +
        upperBoundType - the type of the upper bound, either inclusive or exclusive
        +
        Returns:
        +
        this instance
        +
        +
      • +
      + + + +
        +
      • +

        dropRangePartition

        +
        public AlterTableOptions dropRangePartition(PartialRow lowerBound,
        +                                            PartialRow upperBound)
        +
        Drop the range partition from the table with the specified inclusive lower bound and exclusive + upper bound. The bounds must match exactly, and may not span multiple range partitions. + + If either row is empty, then that end of the range will be unbounded. If a range column is + missing a value, the logical minimum value for that column type will be used as the default. + + Multiple range partitions may be dropped as part of a single alter table transaction by calling + this method multiple times.
        +
        +
        Parameters:
        +
        lowerBound - inclusive lower bound, can be empty but not null
        +
        upperBound - exclusive upper bound, can be empty but not null
        +
        Returns:
        +
        this instance
        +
        +
      • +
      + + + +
        +
      • +

        dropRangePartition

        +
        public AlterTableOptions dropRangePartition(PartialRow lowerBound,
        +                                            PartialRow upperBound,
        +                                            RangePartitionBound lowerBoundType,
        +                                            RangePartitionBound upperBoundType)
        +
        Drop the range partition from the table with the specified lower bound and upper bound. + The bounds must match exactly, and may not span multiple range partitions. + + If either row is empty, then that end of the range will be unbounded. If a range column is + missing a value, the logical minimum value for that column type will be used as the default. + + Multiple range partitions may be dropped as part of a single alter table transaction by calling + this method multiple times.
        +
        +
        Parameters:
        +
        lowerBound - inclusive lower bound, can be empty but not null
        +
        upperBound - exclusive upper bound, can be empty but not null
        +
        lowerBoundType - the type of the lower bound, either inclusive or exclusive
        +
        upperBoundType - the type of the upper bound, either inclusive or exclusive
        +
        Returns:
        +
        this instance
        +
        +
      • +
      +
    • +
    +
  • +
+
+
+ + + + + +

Copyright © 2016. All rights reserved.

+ + http://git-wip-us.apache.org/repos/asf/kudu/blob/d4a51158/apidocs/org/apache/kudu/client/AlterTableResponse.html ---------------------------------------------------------------------- diff --git a/apidocs/org/apache/kudu/client/AlterTableResponse.html b/apidocs/org/apache/kudu/client/AlterTableResponse.html new file mode 100644 index 0000000..d396d86 --- /dev/null +++ b/apidocs/org/apache/kudu/client/AlterTableResponse.html @@ -0,0 +1,287 @@ + + + + + + +AlterTableResponse (Kudu 0.10.0 API) + + + + + + + + + + + +
+
org.apache.kudu.client
+

Class AlterTableResponse

+
+
+ +
+
    +
  • +
    +
    +
    @InterfaceAudience.Public
    + @InterfaceStability.Evolving
    +public class AlterTableResponse
    +extends Object
    +
  • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getTableId

        +
        public String getTableId()
        +
        +
        Returns:
        +
        the ID of the altered table, or null if the master version is too old
        +
        +
      • +
      + + + +
        +
      • +

        getElapsedMillis

        +
        public long getElapsedMillis()
        +
        Get the number of milliseconds elapsed since the RPC was created up to the moment when this + response was created.
        +
        +
        Returns:
        +
        elapsed time in milliseconds
        +
        +
      • +
      + + + +
        +
      • +

        getTsUUID

        +
        public String getTsUUID()
        +
        Get the identifier of the tablet server that sent the response. May be + null if the RPC failed before tablet location lookup succeeded.
        +
        +
        Returns:
        +
        a string containing a UUID
        +
        +
      • +
      +
    • +
    +
  • +
+
+
+ + + + + +

Copyright © 2016. All rights reserved.

+ +