org.apache.paimon.schema

Interface SchemaChange

All Superinterfaces:

Serializable

All Known Implementing Classes:

SchemaChange.AddColumn, SchemaChange.DropColumn, SchemaChange.RemoveOption, SchemaChange.RenameColumn, SchemaChange.SetOption, SchemaChange.UpdateColumnComment, SchemaChange.UpdateColumnNullability, SchemaChange.UpdateColumnPosition, SchemaChange.UpdateColumnType, SchemaChange.UpdateComment

@Public
public interface SchemaChange
extends Serializable

Schema change to table.

Since:

0.4.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	SchemaChange.AddColumn A SchemaChange to add a field.
static class	SchemaChange.DropColumn A SchemaChange to drop a field.
static class	SchemaChange.Move Represents a requested column move in a struct.
static class	SchemaChange.RemoveOption A SchemaChange to remove a table option.
static class	SchemaChange.RenameColumn A SchemaChange to rename a field.
static class	SchemaChange.SetOption A SchemaChange to set a table option.
static class	SchemaChange.UpdateColumnComment A SchemaChange to update the (nested) field comment.
static class	SchemaChange.UpdateColumnNullability A SchemaChange to update the (nested) field nullability.
static class	SchemaChange.UpdateColumnPosition A SchemaChange to update the field position.
static class	SchemaChange.UpdateColumnType A SchemaChange to update the field type.
static class	SchemaChange.UpdateComment A SchemaChange to Update table comment.

Method Summary

Modifier and Type	Method and Description
static SchemaChange	addColumn(String fieldName, DataType dataType)
static SchemaChange	addColumn(String fieldName, DataType dataType, String comment)
static SchemaChange	addColumn(String fieldName, DataType dataType, String comment, SchemaChange.Move move)
static SchemaChange	dropColumn(String fieldName)
static SchemaChange	removeOption(String key)
static SchemaChange	renameColumn(String fieldName, String newName)
static SchemaChange	setOption(String key, String value)
static SchemaChange	updateColumnComment(String[] fieldNames, String comment)
static SchemaChange	updateColumnComment(String fieldName, String comment)
static SchemaChange	updateColumnNullability(String[] fieldNames, boolean newNullability)
static SchemaChange	updateColumnNullability(String fieldName, boolean newNullability)
static SchemaChange	updateColumnPosition(SchemaChange.Move move)
static SchemaChange	updateColumnType(String fieldName, DataType newDataType)
static SchemaChange	updateColumnType(String fieldName, DataType newDataType, boolean keepNullability)
static SchemaChange	updateComment(String comment)

Method Detail

setOption

static SchemaChange setOption(String key,
                              String value)

removeOption

static SchemaChange removeOption(String key)

updateComment

static SchemaChange updateComment(@Nullable
                                  String comment)

addColumn

static SchemaChange addColumn(String fieldName,
                              DataType dataType)

addColumn

static SchemaChange addColumn(String fieldName,
                              DataType dataType,
                              String comment)

addColumn

static SchemaChange addColumn(String fieldName,
                              DataType dataType,
                              String comment,
                              SchemaChange.Move move)

renameColumn

static SchemaChange renameColumn(String fieldName,
                                 String newName)

dropColumn

static SchemaChange dropColumn(String fieldName)

updateColumnType

static SchemaChange updateColumnType(String fieldName,
                                     DataType newDataType)

updateColumnType

static SchemaChange updateColumnType(String fieldName,
                                     DataType newDataType,
                                     boolean keepNullability)

updateColumnNullability

static SchemaChange updateColumnNullability(String fieldName,
                                            boolean newNullability)

updateColumnNullability

static SchemaChange updateColumnNullability(String[] fieldNames,
                                            boolean newNullability)

updateColumnComment

static SchemaChange updateColumnComment(String fieldName,
                                        String comment)

updateColumnComment

static SchemaChange updateColumnComment(String[] fieldNames,
                                        String comment)

updateColumnPosition

static SchemaChange updateColumnPosition(SchemaChange.Move move)