From commits-return-5556-archive-asf-public=cust-asf.ponee.io@kudu.apache.org Thu Mar 22 17:12:02 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 1E39A1807EC for ; Thu, 22 Mar 2018 17:11:52 +0100 (CET) Received: (qmail 49362 invoked by uid 500); 22 Mar 2018 16:11:52 -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 48413 invoked by uid 99); 22 Mar 2018 16:11:51 -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; Thu, 22 Mar 2018 16:11:51 +0000 Received: by git1-us-west.apache.org (ASF Mail Server at git1-us-west.apache.org, from userid 33) id E96D2F6757; Thu, 22 Mar 2018 16:11:50 +0000 (UTC) Content-Type: text/plain; charset="us-ascii" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit From: mpercy@apache.org To: commits@kudu.apache.org Date: Thu, 22 Mar 2018 16:12:23 -0000 Message-Id: <2264950ad40040d1bb127129ca8ce757@git.apache.org> In-Reply-To: <46614943677e470080082a4a6af15149@git.apache.org> References: <46614943677e470080082a4a6af15149@git.apache.org> X-Mailer: ASF-Git Admin Mailer Subject: [34/51] [abbrv] [partial] kudu-site git commit: Publish commit(s) from site source repo: d78c4ca Update website for 1.7.0 release c9969cd Update download URLs 160e66c Fix broken doc guide link 8a2d8b9 Update the latest committers 188c57d site_t http://git-wip-us.apache.org/repos/asf/kudu-site/blob/e9ed1525/releases/1.7.0/apidocs/org/apache/kudu/client/AlterTableOptions.html ---------------------------------------------------------------------- diff --git a/releases/1.7.0/apidocs/org/apache/kudu/client/AlterTableOptions.html b/releases/1.7.0/apidocs/org/apache/kudu/client/AlterTableOptions.html new file mode 100644 index 0000000..e2fbf78 --- /dev/null +++ b/releases/1.7.0/apidocs/org/apache/kudu/client/AlterTableOptions.html @@ -0,0 +1,745 @@ + + + + + + +AlterTableOptions (Kudu 1.6.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(ColumnSchema colSchema)
        +
        Add a new column.
        +
        +
        Parameters:
        +
        colSchema - the schema of the new column
        +
        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 and has no default value.
        +
        +
        Parameters:
        +
        name - name of the new column
        +
        type - type of the new column
        +
        Returns:
        +
        this instance
        +
        +
      • +
      + + + +
        +
      • +

        addNullableColumn

        +
        public AlterTableOptions addNullableColumn(String name,
        +                                           Type type,
        +                                           Object defaultVal)
        +
        Add a new column that's nullable.
        +
        +
        Parameters:
        +
        name - name of the new column
        +
        type - type of the new column
        +
        defaultVal - the default value 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
        +
        +
      • +
      + + + +
        +
      • +

        removeDefault

        +
        public AlterTableOptions removeDefault(String name)
        +
        Remove the default value for a column.
        +
        +
        Parameters:
        +
        name - name of the column
        +
        Returns:
        +
        this instance
        +
        +
      • +
      + + + +
        +
      • +

        changeDefault

        +
        public AlterTableOptions changeDefault(String name,
        +                                       Object newDefault)
        +
        Change the default value for a column. `newDefault` must not be null or + else throws IllegalArgumentException.
        +
        +
        Parameters:
        +
        name - name of the column
        +
        newDefault - the new default value
        +
        Returns:
        +
        this instance
        +
        +
      • +
      + + + +
        +
      • +

        changeDesiredBlockSize

        +
        public AlterTableOptions changeDesiredBlockSize(String name,
        +                                                int blockSize)
        +
        Change the block size of a column's storage. A nonpositive value indicates + a server-side default.
        +
        +
        Parameters:
        +
        name - name of the column
        +
        blockSize - the new block size
        +
        Returns:
        +
        this instance
        +
        +
      • +
      + + + +
        +
      • +

        changeEncoding

        +
        public AlterTableOptions changeEncoding(String name,
        +                                        org.apache.kudu.ColumnSchema.Encoding encoding)
        +
        Change the encoding used for a column.
        +
        +
        Parameters:
        +
        name - name of the column
        +
        encoding - the new encoding
        +
        Returns:
        +
        this instance
        +
        +
      • +
      + + + +
        +
      • +

        changeCompressionAlgorithm

        +
        public AlterTableOptions changeCompressionAlgorithm(String name,
        +                                                    org.apache.kudu.ColumnSchema.CompressionAlgorithm ca)
        +
        Change the compression used for a column.
        +
        +
        Parameters:
        +
        name - the name of the column
        +
        ca - the new compression algorithm
        +
        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 5 minutes.
        +
        +
        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 5 minutes.
        +
        +
        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
        +
        +
      • +
      + + + +
        +
      • +

        setWait

        +
        public AlterTableOptions setWait(boolean wait)
        +
        Whether to wait for the table to be fully altered before this alter + operation is considered to be finished. +

        + If false, the alter will finish quickly, but a subsequent + KuduClient.openTable(String) may return a KuduTable with + an out-of-date schema. +

        + If true, the alter will take longer, but the very next schema is guaranteed + to be up-to-date. +

        + If not provided, defaults to true. +

        +
        +
        Parameters:
        +
        wait - whether to wait for the table to be fully altered
        +
        Returns:
        +
        this instance
        +
        +
      • +
      +
    • +
    +
  • +
+
+
+ + + + + +

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

+ + http://git-wip-us.apache.org/repos/asf/kudu-site/blob/e9ed1525/releases/1.7.0/apidocs/org/apache/kudu/client/AlterTableResponse.html ---------------------------------------------------------------------- diff --git a/releases/1.7.0/apidocs/org/apache/kudu/client/AlterTableResponse.html b/releases/1.7.0/apidocs/org/apache/kudu/client/AlterTableResponse.html new file mode 100644 index 0000000..823d179 --- /dev/null +++ b/releases/1.7.0/apidocs/org/apache/kudu/client/AlterTableResponse.html @@ -0,0 +1,287 @@ + + + + + + +AlterTableResponse (Kudu 1.6.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
        +
        +
      • +
      + + + +
        +
      • +

        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 © 2017 The Apache Software Foundation. All rights reserved.

+ + http://git-wip-us.apache.org/repos/asf/kudu-site/blob/e9ed1525/releases/1.7.0/apidocs/org/apache/kudu/client/AsyncKuduClient.AsyncKuduClientBuilder.html ---------------------------------------------------------------------- diff --git a/releases/1.7.0/apidocs/org/apache/kudu/client/AsyncKuduClient.AsyncKuduClientBuilder.html b/releases/1.7.0/apidocs/org/apache/kudu/client/AsyncKuduClient.AsyncKuduClientBuilder.html new file mode 100644 index 0000000..32aa35d --- /dev/null +++ b/releases/1.7.0/apidocs/org/apache/kudu/client/AsyncKuduClient.AsyncKuduClientBuilder.html @@ -0,0 +1,482 @@ + + + + + + +AsyncKuduClient.AsyncKuduClientBuilder (Kudu 1.6.0 API) + + + + + + + + + + + +
+
org.apache.kudu.client
+

Class AsyncKuduClient.AsyncKuduClientBuilder

+
+
+
    +
  • java.lang.Object
  • +
  • +
      +
    • org.apache.kudu.client.AsyncKuduClient.AsyncKuduClientBuilder
    • +
    +
  • +
+
+
    +
  • +
    +
    Enclosing class:
    +
    AsyncKuduClient
    +
    +
    +
    +
    @InterfaceAudience.Public
    + @InterfaceStability.Evolving
    +public static final class AsyncKuduClient.AsyncKuduClientBuilder
    +extends Object
    +
    Builder class to use in order to connect to Kudu. + All the parameters beyond those in the constructors are optional.
    +
  • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        AsyncKuduClientBuilder

        +
        public AsyncKuduClientBuilder(String masterAddresses)
        +
        Creates a new builder for a client that will connect to the specified masters.
        +
        +
        Parameters:
        +
        masterAddresses - comma-separated list of "host:port" pairs of the masters
        +
        +
      • +
      + + + +
        +
      • +

        AsyncKuduClientBuilder

        +
        public AsyncKuduClientBuilder(List<String> masterAddresses)
        +
        Creates a new builder for a client that will connect to the specified masters. + +

        Here are some examples of recognized formats: +

          +
        • example.com +
        • example.com:80 +
        • 192.0.2.1 +
        • 192.0.2.1:80 +
        • [2001:db8::1] +
        • [2001:db8::1]:80 +
        • 2001:db8::1 +
        +
        +
        Parameters:
        +
        masterAddresses - list of master addresses
        +
        +
      • +
      +
    • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        defaultAdminOperationTimeoutMs

        +
        public AsyncKuduClient.AsyncKuduClientBuilder defaultAdminOperationTimeoutMs(long timeoutMs)
        +
        Sets the default timeout used for administrative operations (e.g. createTable, deleteTable, + etc). + Optional. + If not provided, defaults to 30s. + A value of 0 disables the timeout.
        +
        +
        Parameters:
        +
        timeoutMs - a timeout in milliseconds
        +
        Returns:
        +
        this builder
        +
        +
      • +
      + + + +
        +
      • +

        defaultOperationTimeoutMs

        +
        public AsyncKuduClient.AsyncKuduClientBuilder defaultOperationTimeoutMs(long timeoutMs)
        +
        Sets the default timeout used for user operations (using sessions and scanners). + Optional. + If not provided, defaults to 30s. + A value of 0 disables the timeout.
        +
        +
        Parameters:
        +
        timeoutMs - a timeout in milliseconds
        +
        Returns:
        +
        this builder
        +
        +
      • +
      + + + +
        +
      • +

        defaultSocketReadTimeoutMs

        +
        public AsyncKuduClient.AsyncKuduClientBuilder defaultSocketReadTimeoutMs(long timeoutMs)
        +
        Sets the default timeout to use when waiting on data from a socket. + Optional. + If not provided, defaults to 10s. + A value of 0 disables the timeout.
        +
        +
        Parameters:
        +
        timeoutMs - a timeout in milliseconds
        +
        Returns:
        +
        this builder
        +
        +
      • +
      + + + +
        +
      • +

        nioExecutors

        +
        public AsyncKuduClient.AsyncKuduClientBuilder nioExecutors(Executor bossExecutor,
        +                                                           Executor workerExecutor)
        +
        Set the executors which will be used for the embedded Netty boss and workers. + Optional. + If not provided, uses a simple cached threadpool. If either argument is null, + then such a thread pool will be used in place of that argument. + Note: executor's max thread number must be greater or equal to corresponding + worker count, or netty cannot start enough threads, and client will get stuck. + If not sure, please just use CachedThreadPool.
        +
      • +
      + + + + + + + +
        +
      • +

        workerCount

        +
        public AsyncKuduClient.AsyncKuduClientBuilder workerCount(int workerCount)
        +
        Set the maximum number of worker threads. + Optional. + If not provided, (2 * the number of available processors) is used.
        +
      • +
      + + + +
        +
      • +

        disableStatistics

        +
        public AsyncKuduClient.AsyncKuduClientBuilder disableStatistics()
        +
        Disable this client's collection of statistics. + Statistics are enabled by default.
        +
        +
        Returns:
        +
        this builder
        +
        +
      • +
      + + + +
        +
      • +

        build

        +
        public AsyncKuduClient build()
        +
        Creates a new client that connects to the masters. + Doesn't block and won't throw an exception if the masters don't exist.
        +
        +
        Returns:
        +
        a new asynchronous Kudu client
        +
        +
      • +
      +
    • +
    +
  • +
+
+
+ + + + + +

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

+ +