org.kududb.client

Class AlterTableOptions

java.lang.Object

org.kududb.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(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, thus has no default value.
AlterTableOptions	dropColumn(String name) Drop a column.
AlterTableOptions	renameColumn(String oldName, String newName) Change the name of a column.
AlterTableOptions	renameTable(String newName) Change a table's name.

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

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, thus has no default value.

Parameters:

name - name of the new column

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