org.apache.kudu.client

Class CreateTableOptions

java.lang.Object

org.apache.kudu.client.CreateTableOptions

@InterfaceAudience.Public
 @InterfaceStability.Evolving
public class CreateTableOptions
extends Object

This is a builder class for all the options that can be provided while creating a table.

Constructor Summary

Constructors

Constructor and Description
CreateTableOptions()

Method Summary

Modifier and Type	Method and Description
CreateTableOptions	addHashPartitions(List<String> columns, int buckets) Add a set of hash partitions to the table.
CreateTableOptions	addHashPartitions(List<String> columns, int buckets, int seed) Add a set of hash partitions to the table.
CreateTableOptions	addRangePartition(PartialRow lower, PartialRow upper) Add a range partition to the table with an inclusive lower bound and an exclusive upper bound.
CreateTableOptions	addRangePartition(PartialRow lower, PartialRow upper, RangePartitionBound lowerBoundType, RangePartitionBound upperBoundType) Add a range partition partition to the table with a lower bound and upper bound.
CreateTableOptions	addRangePartition(RangePartitionWithCustomHashSchema rangePartition) Add range partition with custom hash schema.
CreateTableOptions	addSplitRow(PartialRow row) Add a range partition split.
CreateTableOptions	setComment(String comment) Set the table comment.
CreateTableOptions	setDimensionLabel(String dimensionLabel) Sets the dimension label for all tablets created at table creation time.
CreateTableOptions	setExtraConfigs(Map<String,String> extraConfig) Sets the table's extra configuration properties.
CreateTableOptions	setNumReplicas(int numReplicas) Sets the number of replicas that each tablet will have.
CreateTableOptions	setOwner(String owner) Set the table owner as the provided username.
CreateTableOptions	setRangePartitionColumns(List<String> columns) Set the columns on which the table will be range-partitioned.
CreateTableOptions	setWait(boolean wait) Whether to wait for the table to be fully created before this create operation is considered to be finished.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CreateTableOptions

public CreateTableOptions()

Method Detail

addHashPartitions

public CreateTableOptions addHashPartitions(List<String> columns,
                                            int buckets)

Add a set of hash partitions to the table. Each column must be a part of the table's primary key, and an individual column may only appear in a single hash component. For each set of hash partitions added to the table, the total number of table partitions is multiplied by the number of buckets. For example, if a table is created with 3 split rows, and two hash partitions with 4 and 5 buckets respectively, the total number of table partitions will be 80 (4 range partitions * 4 hash buckets * 5 hash buckets).

Parameters:

columns - the columns to hash

buckets - the number of buckets to hash into

Returns:

this instance

addHashPartitions

public CreateTableOptions addHashPartitions(List<String> columns,
                                            int buckets,
                                            int seed)

Add a set of hash partitions to the table. This constructor takes a seed value, which can be used to randomize the mapping of rows to hash buckets. Setting the seed may provide some amount of protection against denial of service attacks when the hashed columns contain user provided values.

Parameters:

columns - the columns to hash

buckets - the number of buckets to hash into

seed - a hash seed

Returns:

this instance

setRangePartitionColumns

public CreateTableOptions setRangePartitionColumns(List<String> columns)

Set the columns on which the table will be range-partitioned. Every column must be a part of the table's primary key. If not set, the table is range partitioned by the primary key columns with a single unbounded partition. If called with an empty vector, the table will be created without range partitioning. Tables must be created with either range, hash, or range and hash partitioning. To force the use of a single tablet (not recommended), call this method with an empty list and set no split rows and no hash partitions.

Parameters:

columns - the range partitioned columns

Returns:

this instance

addRangePartition

public CreateTableOptions addRangePartition(PartialRow lower,
                                            PartialRow upper)

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 bounds may be added, but they must not overlap. All split rows must fall in one of the range bounds. The lower bound must be less than the upper bound. If not provided, the table's range will be unbounded.

Parameters:

lower - the inclusive lower bound

upper - the exclusive upper bound

Returns:

this instance

addRangePartition

public CreateTableOptions addRangePartition(PartialRow lower,
                                            PartialRow upper,
                                            RangePartitionBound lowerBoundType,
                                            RangePartitionBound upperBoundType)

Add a range partition 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 bounds may be added, but they must not overlap. All split rows must fall in one of the range bounds. The lower bound must be less than the upper bound. If not provided, the table's range will be unbounded.

Parameters:

lower - the lower bound

upper - the upper bound

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

addRangePartition

public CreateTableOptions addRangePartition(RangePartitionWithCustomHashSchema rangePartition)

Add range partition with custom hash schema.

Parameters:

rangePartition - range partition with custom hash schema

Returns:

this CreateTableOptions object modified accordingly

addSplitRow

public CreateTableOptions addSplitRow(PartialRow row)

Add a range partition split. The split row must fall in a range partition, and causes the range partition to split into two contiguous range partitions. The row may be reused or modified safely after this call without changing the split point.

Parameters:

row - a key row for the split point

Returns:

this instance

setNumReplicas

public CreateTableOptions setNumReplicas(int numReplicas)

Sets the number of replicas that each tablet will have. If not specified, it uses the server-side default which is usually 3 unless changed by an administrator.

Parameters:

numReplicas - the number of replicas to use

Returns:

this instance

setDimensionLabel

public CreateTableOptions setDimensionLabel(String dimensionLabel)

Sets the dimension label for all tablets created at table creation time. By default, the master will try to place newly created tablet replicas on tablet servers with a small number of tablet replicas. If the dimension label is provided, newly created replicas will be evenly distributed in the cluster based on the dimension label. In other words, the master will try to place newly created tablet replicas on tablet servers with a small number of tablet replicas belonging to this dimension label.

Parameters:

dimensionLabel - the dimension label for the tablet to be created.

Returns:

this instance

setExtraConfigs

public CreateTableOptions setExtraConfigs(Map<String,String> extraConfig)

Sets the table's extra configuration properties. If the value of the kv pair is empty, the property will be ignored.

Parameters:

extraConfig - the table's extra configuration properties

Returns:

this instance

setWait

public CreateTableOptions setWait(boolean wait)

Whether to wait for the table to be fully created before this create operation is considered to be finished.

If false, the create will finish quickly, but subsequent row operations may take longer as they may need to wait for portions of the table to be fully created.

If true, the create will take longer, but the speed of subsequent row operations will not be impacted.

If not provided, defaults to true.

Parameters:

wait - whether to wait for the table to be fully created

Returns:

this instance

setOwner

public CreateTableOptions setOwner(String owner)

Set the table owner as the provided username. Overrides the default of the currently logged-in username or Kerberos principal. This is an unstable method because it is not yet clear whether this should be supported directly in the long run, rather than requiring the table creator to re-assign ownership explicitly.

Parameters:

owner - the username to set as the table owner.

Returns:

this instance

setComment

public CreateTableOptions setComment(String comment)

Set the table comment.

Parameters:

comment - the table comment

Returns:

this instance