org.apache.kudu

Class ColumnSchema.ColumnSchemaBuilder

java.lang.Object

org.apache.kudu.ColumnSchema.ColumnSchemaBuilder

Enclosing class:

ColumnSchema

@InterfaceAudience.Public
 @InterfaceStability.Evolving
public static class ColumnSchema.ColumnSchemaBuilder
extends Object

Builder for ColumnSchema.

Constructor Summary

Constructors

Constructor and Description
ColumnSchemaBuilder(ColumnSchema that) Constructor to copy an existing columnSchema
ColumnSchemaBuilder(String name, Type type) Constructor for the required parameters.

Method Summary

Modifier and Type	Method and Description
ColumnSchema	build() Builds a ColumnSchema using the passed parameters.
ColumnSchema.ColumnSchemaBuilder	comment(String comment) Set the comment for this column.
ColumnSchema.ColumnSchemaBuilder	compressionAlgorithm(ColumnSchema.CompressionAlgorithm compressionAlgorithm) Set the compression algorithm for this column.
ColumnSchema.ColumnSchemaBuilder	defaultValue(Object defaultValue) Sets the default value that will be read from the column.
ColumnSchema.ColumnSchemaBuilder	desiredBlockSize(int desiredBlockSize) Set the desired block size for this column.
ColumnSchema.ColumnSchemaBuilder	encoding(ColumnSchema.Encoding encoding) Set the block encoding for this column.
ColumnSchema.ColumnSchemaBuilder	immutable(boolean immutable) Marks the column as immutable or not.
ColumnSchema.ColumnSchemaBuilder	key(boolean key) Sets if the column is part of the row key.
ColumnSchema.ColumnSchemaBuilder	nonUniqueKey(boolean key) Sets if the column is part of the row non unique key.
ColumnSchema.ColumnSchemaBuilder	nullable(boolean nullable) Marks the column as allowing null values.
ColumnSchema.ColumnSchemaBuilder	typeAttributes(ColumnTypeAttributes typeAttributes) Set the column type attributes for this column.

Methods inherited from class java.lang.Object

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

Constructor Detail

ColumnSchemaBuilder

public ColumnSchemaBuilder(String name,
                           Type type)

Constructor for the required parameters.

Parameters:

name - column's name

type - column's type

Throws:

IllegalArgumentException - if the column's name equals the reserved auto-incrementing column name

ColumnSchemaBuilder

public ColumnSchemaBuilder(ColumnSchema that)

Constructor to copy an existing columnSchema

Parameters:

that - the columnSchema to copy

Method Detail

key

public ColumnSchema.ColumnSchemaBuilder key(boolean key)

Sets if the column is part of the row key. False by default. This function call overrides any previous key() and nonUniqueKey() call.

Parameters:

key - a boolean that indicates if the column is part of the key

Returns:

this instance

nonUniqueKey

public ColumnSchema.ColumnSchemaBuilder nonUniqueKey(boolean key)

Sets if the column is part of the row non unique key. False by default. This function call overrides any previous key() and nonUniqueKey() call.

Parameters:

key - a boolean that indicates if the column is a part of the non unique key

Returns:

this instance

nullable

public ColumnSchema.ColumnSchemaBuilder nullable(boolean nullable)

Marks the column as allowing null values. False by default.

NOTE: the "not-nullable-by-default" behavior here differs from the equivalent API in the Python and C++ clients. It also differs from the standard behavior of SQL CREATE TABLE statements. It is recommended to always specify nullability explicitly using this API in order to avoid confusion.

Parameters:

nullable - a boolean that indicates if the column allows null values

Returns:

this instance

immutable

public ColumnSchema.ColumnSchemaBuilder immutable(boolean immutable)

Marks the column as immutable or not. False by default.

Parameters:

immutable - a boolean that indicates if the column is immutable

Returns:

this instance

defaultValue

public ColumnSchema.ColumnSchemaBuilder defaultValue(Object defaultValue)

Sets the default value that will be read from the column. Null by default.

Parameters:

defaultValue - a Java object representation of the default value that's read

Returns:

this instance

desiredBlockSize

public ColumnSchema.ColumnSchemaBuilder desiredBlockSize(int desiredBlockSize)

Set the desired block size for this column. This is the number of bytes of user data packed per block on disk, and represents the unit of IO when reading this column. Larger values may improve scan performance, particularly on spinning media. Smaller values may improve random access performance, particularly for workloads that have high cache hit rates or operate on fast storage such as SSD. Note that the block size specified here corresponds to uncompressed data. The actual size of the unit read from disk may be smaller if compression is enabled. It's recommended that this not be set any lower than 4096 (4KB) or higher than 1048576 (1MB).

Parameters:

desiredBlockSize - the desired block size, in bytes

Returns:

this instance

encoding

public ColumnSchema.ColumnSchemaBuilder encoding(ColumnSchema.Encoding encoding)

Set the block encoding for this column. See the documentation for the list of valid options.

compressionAlgorithm

public ColumnSchema.ColumnSchemaBuilder compressionAlgorithm(ColumnSchema.CompressionAlgorithm compressionAlgorithm)

Set the compression algorithm for this column. See the documentation for the list of valid options.

typeAttributes

public ColumnSchema.ColumnSchemaBuilder typeAttributes(ColumnTypeAttributes typeAttributes)

Set the column type attributes for this column.

comment

public ColumnSchema.ColumnSchemaBuilder comment(String comment)

Set the comment for this column.

build

public ColumnSchema build()

Builds a ColumnSchema using the passed parameters.

Returns:

a new ColumnSchema