gravitino.dto.requests.table_update_request.TableUpdateRequest

class gravitino.dto.requests.table_update_request.TableUpdateRequest

Bases: object

Namespace for all table update request types.

__init__()

Methods

class AddTableColumnRequest(_field_name: list[str], _data_type: Type, _comment: str | None, _position: ColumnPosition | None, _default_value: Expression | None, _nullable: bool = True, _auto_increment: bool = False)

Bases: TableUpdateRequestBase

Represents a request to add a column to a table.

table_change() AddColumn

Convert to table change operation

validate() None

Validates the request.

Raises:

ValueError: If the request is invalid, this exception is thrown.

class AddTableIndexRequest(_index: Index)

Bases: TableUpdateRequestBase

Represents a request to add an index to a table.

table_change() AddIndex

Convert to table change operation

validate() None

Validate the request.

Raises:

ValueError: If the request is invalid, this exception is thrown.

class DeleteTableColumnRequest(_field_name: list[str], _if_exists: bool)

Bases: TableUpdateRequestBase

Represents a request to delete a column from a table.

table_change() DeleteColumn

Convert to table change operation

validate() None

Validate the request.

Raises:

ValueError: If the request is invalid, this exception is thrown.

class DeleteTableIndexRequest(_name: str, _if_exists: bool)

Bases: TableUpdateRequestBase

Represents a request to delete an index from a table.

table_change() DeleteIndex

Convert to table change operation

validate() None

Validate the request.

Raises:

ValueError: If the request is invalid, this exception is thrown.

class RemoveTablePropertyRequest(_property: str)

Bases: TableUpdateRequestBase

Update request to remove a table property

table_change() RemoveProperty

Convert to table change operation

validate() None

Validates the request.

Raises:

ValueError: If the request is invalid, this exception is thrown.

class RenameTableColumnRequest(_old_field_name: list[str], _new_field_name: str)

Bases: TableUpdateRequestBase

Represents a request to rename a column of a table.

table_change() RenameColumn

Convert to table change operation

validate() None

Validate the request.

Raises:

ValueError: If the request is invalid, this exception is thrown.

class RenameTableRequest(_new_name: str, _new_schema_name: str | None = None)

Bases: TableUpdateRequestBase

Update request to rename a table

table_change() RenameTable

Convert to table change operation

validate() None

Validate the request.

Raises:

ValueError: If the request is invalid, this exception is thrown.

class SetTablePropertyRequest(_prop: str, _prop_value: str)

Bases: TableUpdateRequestBase

Update request to set a table property

table_change() SetProperty

Convert to table change operation

validate() None

Validate the request.

Raises:

ValueError: If the request is invalid, this exception is thrown.

class UpdateColumnAutoIncrementRequest(_field_name: list[str], _auto_increment: bool)

Bases: TableUpdateRequestBase

Represents a request to update a column autoIncrement from a table.

table_change() UpdateColumnAutoIncrement

Convert to table change operation

validate() None

Validate the request.

Raises:

ValueError: If the request is invalid, this exception is thrown.

class UpdateTableColumnCommentRequest(_field_name: list[str], _new_comment: str)

Bases: TableUpdateRequestBase

Represents a request to update the comment of a column of a table.

table_change() UpdateColumnComment

Convert to table change operation

validate() None

Validate the request.

Raises:

ValueError: If the request is invalid, this exception is thrown.

class UpdateTableColumnDefaultValueRequest(_field_name: list[str], _new_default_value: Expression)

Bases: TableUpdateRequestBase

Represents a request to update the default value of a column of a table.

table_change() UpdateColumnDefaultValue

Convert to table change operation

validate() None

Validate the request.

Raises:

ValueError: If the request is invalid, this exception is thrown.

class UpdateTableColumnNullabilityRequest(_field_name: list[str], _nullable: bool)

Bases: TableUpdateRequestBase

Represents a request to update the nullability of a column of a table.

table_change() UpdateColumnNullability

Convert to table change operation

validate() None

Validate the request.

Raises:

ValueError: If the request is invalid, this exception is thrown.

class UpdateTableColumnPositionRequest(_field_name: list[str], _new_position: ColumnPosition)

Bases: TableUpdateRequestBase

Represents a request to update the position of a column of a table.

table_change() UpdateColumnPosition

Convert to table change operation

validate() None

Validate the request.

Raises:

ValueError: If the request is invalid, this exception is thrown.

class UpdateTableColumnTypeRequest(_field_name: list[str], _new_type: Type)

Bases: TableUpdateRequestBase

Represents a request to update the type of a column of a table.

table_change() UpdateColumnType

Convert to table change operation

validate() None

Validate the request.

Raises:

ValueError: If the request is invalid, this exception is thrown.

class UpdateTableCommentRequest(_new_comment: str)

Bases: TableUpdateRequestBase

Update request to change a table comment

table_change() UpdateComment

Convert to table change operation

validate() None

Validate the request.

Raises:

ValueError: If the request is invalid, this exception is thrown.