Package org.apache.gravitino.dto.requests

Class TableUpdateRequest.AddTableColumnRequest

java.lang.Object

org.apache.gravitino.dto.requests.TableUpdateRequest.AddTableColumnRequest

All Implemented Interfaces:

TableUpdateRequest, RESTMessage, RESTRequest

Enclosing interface:

TableUpdateRequest

public static class TableUpdateRequest.AddTableColumnRequest
extends Object
implements TableUpdateRequest

Represents a request to add a column to a table.

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.gravitino.dto.requests.TableUpdateRequest

TableUpdateRequest.AddTableColumnRequest, TableUpdateRequest.AddTableIndexRequest, TableUpdateRequest.DeleteTableColumnRequest, TableUpdateRequest.DeleteTableIndexRequest, TableUpdateRequest.RemoveTablePropertyRequest, TableUpdateRequest.RenameTableColumnRequest, TableUpdateRequest.RenameTableRequest, TableUpdateRequest.SetTablePropertyRequest, TableUpdateRequest.UpdateColumnAutoIncrementRequest, TableUpdateRequest.UpdateTableColumnCommentRequest, TableUpdateRequest.UpdateTableColumnDefaultValueRequest, TableUpdateRequest.UpdateTableColumnNullabilityRequest, TableUpdateRequest.UpdateTableColumnPositionRequest, TableUpdateRequest.UpdateTableColumnTypeRequest, TableUpdateRequest.UpdateTableCommentRequest

Constructor Summary

Constructors

Constructor	Description
AddTableColumnRequest()	Default constructor for Jackson deserialization.
AddTableColumnRequest(String[] fieldName, Type dataType, String comment)	Constructor for AddTableColumnRequest with default position and nullable value(true).
AddTableColumnRequest(String[] fieldName, Type dataType, String comment, TableChange.ColumnPosition position)	Constructor for AddTableColumnRequest with default nullable value(true).
AddTableColumnRequest(String[] fieldName, Type dataType, String comment, TableChange.ColumnPosition position, boolean nullable, boolean autoIncrement, Expression defaultValue)	Constructor for AddTableColumnRequest.

Method Summary

Modifier and Type	Method	Description
TableChange	tableChange()	The table change that is requested.
void	validate()	Validates the request.

Methods inherited from class java.lang.Object

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

Constructor Details

AddTableColumnRequest

public AddTableColumnRequest()

Default constructor for Jackson deserialization.

AddTableColumnRequest

public AddTableColumnRequest(String[] fieldName,
 Type dataType,
 String comment,
 TableChange.ColumnPosition position,
 boolean nullable,
 boolean autoIncrement,
 Expression defaultValue)

Constructor for AddTableColumnRequest.

Parameters:

fieldName - the field name to add

dataType - the data type of the field to add

comment - the comment of the field to add

position - the position of the field to add, null for default position

nullable - whether the field to add is nullable

autoIncrement - whether the field to add is auto increment

defaultValue - whether the field has default value

AddTableColumnRequest

public AddTableColumnRequest(String[] fieldName,
 Type dataType,
 String comment,
 TableChange.ColumnPosition position)

Constructor for AddTableColumnRequest with default nullable value(true).

Parameters:

fieldName - the field name to add

dataType - the data type of the field to add

comment - the comment of the field to add

position - the position of the field to add

AddTableColumnRequest

public AddTableColumnRequest(String[] fieldName,
 Type dataType,
 String comment)

Constructor for AddTableColumnRequest with default position and nullable value(true).

Parameters:

fieldName - the field name to add

dataType - the data type of the field to add

comment - the comment of the field to add

Method Details

validate

public void validate()
              throws IllegalArgumentException

Validates the request.

Specified by:

validate in interface RESTMessage

Throws:

IllegalArgumentException - If the request is invalid, this exception is thrown.

tableChange

public TableChange tableChange()

Description copied from interface: TableUpdateRequest

The table change that is requested.

Specified by:

tableChange in interface TableUpdateRequest

Returns:

An instance of TableChange.