org.apache.kudu

Class ColumnSchema

java.lang.Object

org.apache.kudu.ColumnSchema

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

Represents a Kudu Table column. Use ColumnSchema.ColumnSchemaBuilder in order to create columns.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ColumnSchema.AutoIncrementingColumnSchemaBuilder Builder for ColumnSchema of the auto-incrementing column.
static class	ColumnSchema.ColumnSchemaBuilder Builder for ColumnSchema.
static class	ColumnSchema.CompressionAlgorithm Specifies the compression algorithm of data for a column on disk.
static class	ColumnSchema.Encoding Specifies the encoding of data for a column on disk.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
String	getComment() Return the comment for the column.
ColumnSchema.CompressionAlgorithm	getCompressionAlgorithm() Return the compression algorithm of this column, or null if it is not known.
Object	getDefaultValue() The Java object representation of the default value that's read
int	getDesiredBlockSize() Gets the desired block size for this column.
ColumnSchema.Encoding	getEncoding() Return the encoding of this column, or null if it is not known.
String	getName() Get the column's name
Type	getType() Get the column's Type
ColumnTypeAttributes	getTypeAttributes() Return the column type attributes for the column, or null if it is not known.
int	getTypeSize() The size of this type in bytes on the wire.
int	hashCode()
boolean	isAutoIncrementing() Answers if the column is auto-incrementing column
boolean	isImmutable() Answers if the column is immutable
boolean	isKey() Answers if the column part of the key
boolean	isKeyUnique() Answers if the key is unique
boolean	isNullable() Answers if the column can be set to null
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

getType

public Type getType()

Get the column's Type

Returns:

the type

getName

public String getName()

Get the column's name

Returns:

A string representation of the name

isKey

public boolean isKey()

Answers if the column part of the key

Returns:

true if the column is part of the key, else false

isKeyUnique

public boolean isKeyUnique()

Answers if the key is unique

Returns:

true if the key is unique

isNullable

public boolean isNullable()

Answers if the column can be set to null

Returns:

true if it can be set to null, else false

isImmutable

public boolean isImmutable()

Answers if the column is immutable

Returns:

true if it is immutable, else false

isAutoIncrementing

public boolean isAutoIncrementing()

Answers if the column is auto-incrementing column

Returns:

true if the column value is automatically assigned with incrementing value

getDefaultValue

public Object getDefaultValue()

The Java object representation of the default value that's read

Returns:

the default read value

getDesiredBlockSize

public int getDesiredBlockSize()

Gets the desired block size for this column. If no block size has been explicitly specified for this column, returns 0 to indicate that the server-side default will be used.

Returns:

the block size, in bytes, or 0 if none has been configured.

getEncoding

public ColumnSchema.Encoding getEncoding()

Return the encoding of this column, or null if it is not known.

getCompressionAlgorithm

public ColumnSchema.CompressionAlgorithm getCompressionAlgorithm()

Return the compression algorithm of this column, or null if it is not known.

getTypeAttributes

public ColumnTypeAttributes getTypeAttributes()

Return the column type attributes for the column, or null if it is not known.

getTypeSize

public int getTypeSize()

The size of this type in bytes on the wire.

Returns:

A size

getComment

public String getComment()

Return the comment for the column. An empty string means there is no comment.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object