Struct ColumnAlterationSpec 

pub struct ColumnAlterationSpec {
    pub path: String,
    pub rename: Option<String>,
    pub nullable: Option<bool>,
    pub cast_to: Option<FieldType>,
}

Describes a single column alteration.

Examples

let alteration = storage_kit::database::catalog::ColumnAlterationSpec {
    path: "title".into(),
    rename: Some("heading".into()),
    nullable: Some(false),
    cast_to: Some(storage_kit::database::catalog::FieldType::String),
};
assert_eq!(alteration.rename.as_deref(), Some("heading"));

Fields

path: String

Existing column path.

rename: Option<String>

New column name to apply when the alteration renames the field.

nullable: Option<bool>

Nullability setting to apply when the alteration changes null support.

The supplied SurrealDB implementation rejects nullable-only changes and requires an explicit value alongside cast_to. The supplied Lance implementation rejects a batch combining any cast with changing a currently nullable column to non-nullable. It returns UnsupportedCapability before mutation. Already non-nullable columns remain supported. Cast first, then tighten nullability in a separate request; each request completes independently.

cast_to: Option<FieldType>

Target type to cast into when the alteration changes the field type.

Trait Implementations

impl Clone for ColumnAlterationSpec

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ColumnAlterationSpec

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ColumnAlterationSpec

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for ColumnAlterationSpec

impl PartialEq for ColumnAlterationSpec

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for ColumnAlterationSpec

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ColumnAlterationSpec