org.apache.kudu.client

Class AlterTableOptions

java.lang.Object

org.apache.kudu.client.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 Summary

Constructors

Constructor and Description
AlterTableOptions()

Method Summary

Modifier and Type	Method and Description
AlterTableOptions	addColumn(ColumnSchema colSchema) Add a new column.
AlterTableOptions	addColumn(String name, Type type, Object defaultVal) Add a new column that's not nullable.
AlterTableOptions	addNullableColumn(String name, Type type) Add a new column that's nullable and has no default value.
AlterTableOptions	addNullableColumn(String name, Type type, Object defaultVal) Add a new column that's nullable.
AlterTableOptions	addRangePartition(PartialRow lowerBound, PartialRow upperBound) Add a range partition to the table with an inclusive lower bound and an exclusive upper bound.
AlterTableOptions	addRangePartition(PartialRow lowerBound, PartialRow upperBound, RangePartitionBound lowerBoundType, RangePartitionBound upperBoundType) Add a range partition to the table with a lower bound and upper bound.
AlterTableOptions	addRangePartition(PartialRow lowerBound, PartialRow upperBound, String dimensionLabel, RangePartitionBound lowerBoundType, RangePartitionBound upperBoundType) Add a range partition to the table with dimension label.
AlterTableOptions	alterExtraConfigs(Map<String,String> extraConfig) Change the table's extra configuration properties.
AlterTableOptions	changeComment(String name, String comment) Change the comment for the column.
AlterTableOptions	changeCompressionAlgorithm(String name, ColumnSchema.CompressionAlgorithm ca) Change the compression used for a column.
AlterTableOptions	changeDefault(String name, Object newDefault) Change the default value for a column.
AlterTableOptions	changeDesiredBlockSize(String name, int blockSize) Change the block size of a column's storage.
AlterTableOptions	changeEncoding(String name, ColumnSchema.Encoding encoding) Change the encoding used for a column.
AlterTableOptions	dropColumn(String name) Drop a column.
AlterTableOptions	dropRangePartition(PartialRow lowerBound, PartialRow upperBound) Drop the range partition from the table with the specified inclusive lower bound and exclusive upper bound.
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.
AlterTableOptions	removeDefault(String name) Remove the default value for a column.
AlterTableOptions	renameColumn(String oldName, String newName) Change the name of a column.
AlterTableOptions	renameTable(String newName) Change a table's name.
AlterTableOptions	setOwner(String owner) Change a table's owner.
AlterTableOptions	setWait(boolean wait) Whether to wait for the table to be fully altered before this alter 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

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

setOwner

public AlterTableOptions setOwner(String owner)

Change a table's owner.

Parameters:

owner - the new table owner

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,
                                        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,
                                                    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

addRangePartition

public AlterTableOptions addRangePartition(PartialRow lowerBound,
                                           PartialRow upperBound,
                                           String dimensionLabel,
                                           RangePartitionBound lowerBoundType,
                                           RangePartitionBound upperBoundType)

Add a range partition to the table with dimension label. 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. 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:

lowerBound - lower bound, may be empty but not null

upperBound - upper bound, may be empty but not null

dimensionLabel - the dimension label for the tablet to be created

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

changeComment

public AlterTableOptions changeComment(String name,
                                       String comment)

Change the comment for the column.

Parameters:

name - name of the column

comment - the new comment for the column, an empty comment means deleting an existing comment.

Returns:

this instance

alterExtraConfigs

public AlterTableOptions alterExtraConfigs(Map<String,String> extraConfig)

Change the table's extra configuration properties. These configuration properties will be merged into existing configuration properties. If the value of the kv pair is empty, the property will be unset.

Parameters:

extraConfig - the table's extra configuration properties

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