Struct ColumnDef 

#[non_exhaustive]
pub struct ColumnDef {
    pub name: String,
    pub column_type: ColumnType,
    pub nullable: bool,
    pub default: Option<String>,
    pub primary_key: bool,
    pub modifiers: Vec<ColumnModifier>,
    pub generated_expr: Option<String>,
    pub generated_deps: Vec<String>,
    pub added_at_version: u32,
}

A single column definition in a strict document or columnar schema.

#[non_exhaustive] — new fields may be added (e.g. column-level compression hints, foreign-key metadata).

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

name: String

column_type: ColumnType

nullable: bool

default: Option<String>

primary_key: bool

modifiers: Vec<ColumnModifier>

Column-level modifiers (TIME_KEY, SPATIAL_INDEX, etc.).

generated_expr: Option<String>

GENERATED ALWAYS AS expression (serialized SqlExpr JSON). When set, this column is computed at write time, not supplied by the user.

generated_deps: Vec<String>

Column names this generated column depends on.

added_at_version: u32

Schema version at which this column was added. Original columns have version 1 (the default). Columns added via ALTER ADD COLUMN record the schema version after the bump so the reader can build a physical sub-schema for tuples written under older versions.

Implementations

impl ColumnDef

pub fn required(name: impl Into<String>, column_type: ColumnType) -> Self

pub fn nullable(name: impl Into<String>, column_type: ColumnType) -> Self

pub fn with_primary_key(self) -> Self

pub fn is_time_key(&self) -> bool

Check if this column has the TIME_KEY modifier.

pub fn is_spatial_index(&self) -> bool

Check if this column has the SPATIAL_INDEX modifier.

pub fn with_default(self, expr: impl Into<String>) -> Self

Trait Implementations

impl Clone for ColumnDef

fn clone(&self) -> ColumnDef

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ColumnDef

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ColumnDef

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for ColumnDef

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

Formats the value using the given formatter.

impl<'__msgpack_de> FromMessagePack<'__msgpack_de> for ColumnDef

fn read<R: Read<'__msgpack_de>>(reader: &mut R) -> Result<Self, Error>

where Self: Sized,

Reads the MessagePack representation of this value from the provided reader.

impl PartialEq for ColumnDef

fn eq(&self, other: &ColumnDef) -> 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 Serialize for ColumnDef

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl ToMessagePack for ColumnDef

fn write<W: Write>(&self, writer: &mut W) -> Result<(), Error>

Writes the MessagePack representation of this value into the provided writer.

impl Eq for ColumnDef

impl StructuralPartialEq for ColumnDef