Enum AlterKind 

pub enum AlterKind {
    AddColumns {
        columns: Vec<AddColumn>,
    },
    DropColumns {
        names: Vec<String>,
    },
    ModifyColumnTypes {
        columns: Vec<ModifyColumnType>,
    },
    SetRegionOptions {
        options: Vec<SetRegionOption>,
    },
    UnsetRegionOptions {
        keys: Vec<UnsetRegionOption>,
    },
    SetIndexes {
        options: Vec<SetIndexOption>,
    },
    UnsetIndexes {
        options: Vec<UnsetIndexOption>,
    },
    DropDefaults {
        names: Vec<String>,
    },
    SetDefaults {
        columns: Vec<SetDefault>,
    },
    SyncColumns {
        column_metadatas: Vec<ColumnMetadata>,
    },
}

Kind of the alteration.

Variants

AddColumns

Add columns to the region.

Fields

columns: Vec<AddColumn>

Columns to add.

DropColumns

Drop columns from the region, only fields are allowed to drop.

Fields

names: Vec<String>

Name of columns to drop.

ModifyColumnTypes

Change columns datatype of the region. Field columns can change to any Arrow-castable type; the time index column only supports widening its timestamp unit (e.g. TimestampMillisecond -> TimestampMicrosecond), which is lossless for values that fit the target unit’s i64 range.

Fields

columns: Vec<ModifyColumnType>

Columns to change.

SetRegionOptions

Set region options.

Fields

options: Vec<SetRegionOption>

UnsetRegionOptions

Unset region options.

Fields

keys: Vec<UnsetRegionOption>

SetIndexes

Set index options.

Fields

options: Vec<SetIndexOption>

UnsetIndexes

Unset index options.

Fields

options: Vec<UnsetIndexOption>

DropDefaults

Drop column default value.

Fields

names: Vec<String>

Name of columns to drop.

SetDefaults

Set column default value.

Fields

columns: Vec<SetDefault>

Columns to change.

SyncColumns

Sync column metadatas.

Fields

column_metadatas: Vec<ColumnMetadata>

Implementations

impl AlterKind

pub fn validate(&self, metadata: &RegionMetadata) -> Result<()>

Returns an error if the alter kind is invalid.

It allows adding column if not exists and dropping column if exists.

pub fn need_alter(&self, metadata: &RegionMetadata) -> bool

Returns true if we need to apply the alteration to the region.

fn validate_column_to_drop(name: &str, metadata: &RegionMetadata) -> Result<()>

Returns an error if the column to drop is invalid.

fn validate_column_alter_index_option( column_name: &String, metadata: &RegionMetadata, is_fulltext: bool, ) -> Result<()>

Returns an error if the column’s alter index option is invalid.

fn validate_column_existence( column_name: &String, metadata: &RegionMetadata, ) -> Result<()>

Returns an error if the column isn’t exist.

Trait Implementations

impl AsRef<str> for AlterKind

fn as_ref(&self) -> &str

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for AlterKind

fn clone(&self) -> AlterKind

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for AlterKind

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for AlterKind

fn eq(&self, other: &AlterKind) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl TryFrom<Kind> for AlterKind

type Error = MetadataError

The type returned in the event of a conversion error.

fn try_from(kind: Kind) -> Result<Self>

Performs the conversion.

impl Eq for AlterKind

impl StructuralPartialEq for AlterKind